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 code
  • ShipToCountry - required - 2-letter country code
  • ShipToState - optional - state code if exists
  • CurrencyCode - required - currency code
  • LanguageCode - required - 2-letter language code
  • Items - required - list of SKU & quantity pairs. Each item must have the following properties defined:
    • SKU - required - SKU of product variant
    • Quantity - required - quantity of items with this SKU

Important! The value from the result one passes into the order submission Item.ShipCarrierMethodId field is Idnot MethodId.

The following parameters would look something like this:

{
  "ShipToPostalCode": "string",
  "ShipToCountry": "string",
  "ShipToState": "string",
  "CurrencyCode": "string",
  "LanguageCode": "string",
  "Items": [
    {
      "SKU": "string",
      "Quantity": "integer"
    }
  ]
}

This request yields the following response:

{
  "Result": [
    {
      "SKUs": [
        "string"
      ],
      "ShipOptions": [
        {
          "Id": "integer",
          "MethodType": "string",
          "MethodId": "integer",
          "Name": "string",
          "CarrierName": "string",
          "CarrierLogoUrl": "string",
          "Price": {
            "Price": "decimal",
            "CurrencyCode": "string",
            "FormattedPrice": "string"
          },
          "PartnerPrice": {
            "Price": "decimal",
            "CurrencyCode": "string",
            "FormattedPrice": "string"
          },
          "EstBusinessDaysTilDelivery": "integer"
        }
      ]
    }
  ]
}