Shipping Methods Resource
URL Endpoints
| Endpoint | Supported Methods |
|---|---|
| /[store-handle]/api/v2/sales/shippingmethods.json | GET |
| /[store-handle]/api/v2/sales/shippingmethods/[paymentmethod-uuid].[format] | GET, PUT, DELETE |
Data Structure
GET
/[store-handle]/api/v2/sales/shippingmethods.json
/static/support/documentation/examples/shippingmethods.json
| Name | Path | Type | Description | Example |
|---|---|---|---|---|
| type | type | string (readonly) | Resource type. Must match the resource type used in the endpoint. | "orders", "products", "customers" |
| uuid | uuid | uuid | Resource identifier. Must be a valid hex representation. | "06429e75a8ea11de80c09314b8ee4e52" |
| revision | revision | timestamp (readonly) | Resource version. Uses the timestamp format, precision up to seconds. | 1253783394 |
| name | name | string | Shipping method name. | "USPS Ground Shipping" |
| carrierCode | carrierCode | enum | Shipping carrier code. Values can be "fedex", "ups", "usps", "weight" or "price". | "fedex", "ups", "usps", "weight" |
| carrierName | carrierName | string | Optional shipping carrier name. | "FedEx", "USPS", "UPS" |
| serviceCode | serviceCode | string | Shipping service code. | "GROUND", "EXPRESS" |
| serviceName | serviceName | string | Shipping service name | "Express Saver", "Weight Based" |
| login | login | string | Login name for processing service. | "mystore" |
| password | password | string (masked) | Password for processing service. Is masked using * characters. | "*****" |
| signature | signature | string | Optional signature for processing service. | "Sjd78HSd7" |
| originCountryCode | originCountryCode | enum | Origin country code for this shipping method. Takes two character iso country codes. | "US", "NL", "DE" |
| destinationCountryCodes | destinationCountryCodes | list with strings | Destination country codes this shipping method is valid for. Takes two character iso country codes. | "US", "NL", "DE" |
| isTaxable | isTaxable | bool | Wether this shipping method is taxable or not. | true, false |
| priceRanges | priceRanges | dictionary with dictionaries | Prices for shipping method. Also see price ranges explanation below. | |
| amount | amount | decimal | Amount of weight or price from which the according price applies. Also see price ranges explanation below. | |
| price | price | decimal | Price for amount level. |
Price Ranges
Custom shipping methods can be weight-based or price-based, determined by the carrierCodes "weight" or "price". If it's set to either one of these, Enstore will look up the shipping price for a product line by either the weight or price.
