Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
shipping
/
request-multi-rates
Error
A valid request URL is required to generate request examples
[
  {
    "id": "<string>",
    "ratesResponse": {
      "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>"
            }
          ]
        }
      ]
    },
    "componentRates": [
      {
        "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
rateRequests
object[] | null
id
string | null

Response

Success

id
string | null
ratesResponse
object
componentRates
object[] | null