Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
shipping
/
request-rates
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "resolvedShippingZoneCode": "<string>",
  "shippingZoneCodes": [
    "<string>"
  ],
  "rates": [
    {
      "carrierId": "<string>",
      "shippingRates": [
        {
          "code": "<string>",
          "content": {
            "localeCode": "<string>",
            "name": "<string>"
          },
          "amount": 123,
          "daysInTransit": 123,
          "shippingItemRates": [
            {
              "itemId": "<string>",
              "quantity": 123,
              "amount": 123
            }
          ],
          "customAttributes": [
            {
              "childAttributes": "<array>",
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "messages": [
            {
              "severity": "<string>",
              "message": "<string>",
              "helpLink": "<string>"
            }
          ],
          "data": {},
          "windows": [
            {
              "pickupTime": {
                "startsAt": "2023-11-07T05:31:56Z",
                "endsAt": "2023-11-07T05:31:56Z"
              },
              "dropoffTime": {
                "startsAt": "2023-11-07T05:31:56Z",
                "endsAt": "2023-11-07T05:31:56Z"
              }
            }
          ]
        }
      ],
      "fulfillmentMethod": "<string>",
      "customAttributes": [
        {
          "childAttributes": "<array>",
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

includeRawResponse
boolean
default:false
responseFields
string

limits which fields are returned in the response body

Body

application/json
id
string | null
isoCurrencyCode
string | null
originAddress
object
destinationAddress
object
carrierIds
string[] | null

Optional. If one or more Carrier Ids are specified then only the rates for the specified carrier('s/s') configured service types or shipping methods will be calculated resulting in better performance.

shippingServiceTypes
string[] | null

Optional. If one or more Shipping Service Type Codes are specified then only the specified rates for the specified carrier('s/s') configured service types or shipping methods will be calculated resulting in better performance.

orderTotal
number<double> | null

The OrderTotal to be used in rate calculation

orderDiscountedSubTotal
number<double> | null

The Order SubTotal After Discounts to be used in rate calculation

handlingTotal
number<double> | null

The order Handling total after discounts to be used in rate calculation

The Order ID to be used in rate calculation Informational only

The Order Number to be used in rate calculation Informational only

isDestinationAddressCommercial
boolean | null

Is the destination address a commercial address?

items
object[] | null
estimatedShipmentDate
string<date-time> | null

Estimate Date/Time when the shipment for this will be sent. Primarily utilize to estimate delivery date.

attributes
object[] | null

Order Attributes. Made available for Arc.js to use

customAttributes
object[] | null
deprecated
data
object
originLocationCode
string | null

Optional for STH rates. The location code of the origin location. Used for calculation of Delivery rates.

Response

Success

id
string | null
resolvedShippingZoneCode
string | null

Resolved Shipping Zone Code. This value can be null if the tenant/site does not have shipping zones defined or there are no matching shipping zones for the request (e.g. the only zone defined is "UNITED-STATES" and the destination address of the rate request is in Canada)

shippingZoneCodes
string[] | null
rates
object[] | null