API Documentation

Cart - Order Price Estimates

The POST priceestimate endpoint is used to estimate cost of the order, including any coupon discounts.

The POST data should be JSON object with following properties set:

  • ShipToAddress object, with following properties:
    • FirstName - required - first name of the user
    • LastName - required - last name of the user
    • Line1 - required - shipping address line 1
    • Line2 - optional - shipping address line 2
    • City - required - shipping city
    • State - optional - shipping state (if applicable)
    • PostalCode - required - shipping postal code
    • CountryCode - required - shipping 2-letter country code
    • Email - required - user’s email
    • Phone - required - user’s phone
  • Items array of objects containing the following properties:
    • SKU - required - SKU of product variant
    • ShipCarrierMethodId - required - ID of shipping carrier method
    • Quantity - required - quantity of items with this SKU
    • Images - required - list of images, each containing Index of image and ManipCommand
  • Payment object, with following properties:
    • CurrencyCode - required - currency code
  • CouponCode - optional - a JSON Array of Strings (example: [“coupon_code_1”, “coupon_code_2”])
{
  "ShipToAddress": {
    "FirstName": "string",
    "LastName": "string",
    "Line1": "string",
    "Line2": "string",
    "City": "string",
    "State": "string",
    "CountryCode": "string",
    "PostalCode": "string",
    "IsBusinessAddress": "boolean",
    "Phone": "string",
    "Email": "string"
  },
  "Items": [
    {
      "Quantity": "integer",
      "SKU": "string",
      "ShipCarrierMethodId": "integer",
      "Images": [
        {
          "Url": "string",
          "Index": "integer",
          "ThumbnailUrl": "string",
          "ManipCommand": "string",
          "SpaceId": "string"
        }
      ]
    }
  ],
  "Payment": {
    "CurrencyCode": "string"
  },
  "CouponCode": "string"
}

Example:

This yields the response:

{
  "Items": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "Shipping": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "Tax": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "CouponCode": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "CouponType": "string",
  "CouponUsed": "string",
  "HadCouponApply": "boolean",
  "DollarsOff": "decimal",
  "PercentOff": "decimal",
  "HadError": "boolean"
}