Get Rates

Get Rate Responses for a Rate Request

POST /commerce/catalog/storefront/shipping/request-rates

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "rates": [
    {
      "carrierId": "<string>",
      "customAttributes": [
        {
          "childAttributes": "<array>",
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "fulfillmentMethod": "<string>",
      "shippingRates": [
        {
          "amount": 123,
          "code": "<string>",
          "content": {
            "localeCode": "<string>",
            "name": "<string>"
          },
          "customAttributes": [
            {
              "childAttributes": "<array>",
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "data": {},
          "daysInTransit": 123,
          "messages": [
            {
              "helpLink": "<string>",
              "message": "<string>",
              "severity": "<string>"
            }
          ],
          "shippingItemRates": [
            {
              "amount": 123,
              "itemId": "<string>",
              "quantity": 123
            }
          ],
          "windows": [
            {
              "dropoffTime": {
                "endsAt": "2023-11-07T05:31:56Z",
                "startsAt": "2023-11-07T05:31:56Z"
              },
              "pickupTime": {
                "endsAt": "2023-11-07T05:31:56Z",
                "startsAt": "2023-11-07T05:31:56Z"
              }
            }
          ]
        }
      ]
    }
  ],
  "resolvedShippingZoneCode": "<string>",
  "shippingZoneCodes": [
    "<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

attributes · object[] | null

Order Attributes. Made available for Arc.js to use

Show child attributes

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.

customAttributes · object[] | null · deprecated

Show child attributes

data · object

destinationAddress · object

Show child attributes

estimatedShipmentDate · string<date-time> | null

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

handlingTotal · number<double> | null

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

id · string | null

isDestinationAddressCommercial · boolean | null

Is the destination address a commercial address?

isoCurrencyCode · string | null

items · object[] | null

Show child attributes

orderDiscountedSubTotal · number<double> | null

The Order SubTotal After Discounts to be used in rate calculation

orderTotal · number<double> | null

The OrderTotal to be used in rate calculation

originAddress · object

Show child attributes

originLocationCode · string | null

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

relatedOrderId · string | null

The Order ID to be used in rate calculation Informational only

relatedOrderNumber · integer<int32> | null

The Order Number to be used in rate calculation Informational only

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.

Response

200

application/json

Success

id · string | null

rates · object[] | null

Show child attributes

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