API Documentation
Cart - Shipping Options
The POST shippingprices
endpoint can be used to retrive available shipping options for a cart.
The POST data should be JSON object with following properties set:
ShipToPostalCode
- required - postal codeShipToCountry
- required - 2-letter country codeShipToState
- optional - state code if existsCurrencyCode
- required - currency codeLanguageCode
- required - 2-letter language codeItems
- required - list of SKU & quantity pairs. Each item must have the following properties defined:SKU
- required - SKU of product variantQuantity
- required - quantity of items with this SKU
Important! The value from the result one passes into the order submission Item.ShipCarrierMethodId
field is Id
– not MethodId
.
This request yields following response:
{
"Result": [
{
"SKUs": [
"PhoneCase-GalaxyNote2-Matte"
],
"ShipOptions": [
{
"CarrierName": "Expedited",
"MethodType": "Expedited",
"Name": "Expedited",
"Price": {
"Price": 24.2,
"CurrencyCode": "USD",
"FormattedPrice": "$24.20",
"CurrencyFormat": "${1}",
"CurrencyDigits": 2
},
"Id": 2,
"EstBusinessDaysTilDelivery": 4,
"MethodId": 5
},
{
"CarrierName": "Standard",
"MethodType": "Standard",
"Name": "Standard",
"Price": {
"Price": 4.79,
"CurrencyCode": "USD",
"FormattedPrice": "$4.79",
"CurrencyFormat": "${1}",
"CurrencyDigits": 2
},
"Id": 1,
"EstBusinessDaysTilDelivery": 12,
"MethodId": 3
}
]
},
{
"SKUs": [
"PhoneCase-Glossy-GalaxyNote3"
],
"ShipOptions": [
{
"CarrierName": "Standard",
"MethodType": "Standard",
"Name": "Standard",
"Price": {
"Price": 4.5,
"CurrencyCode": "USD",
"FormattedPrice": "$4.50",
"CurrencyFormat": "${1}",
"CurrencyDigits": 2
},
"Id": 1,
"EstBusinessDaysTilDelivery": 12,
"MethodId": 3
}
]
}
]
}