Get Multi Rates

Get List of Rate Responses for a List of Rate Requests

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

Error

A valid request URL is required to generate request examples

200

[
  {
    "componentRates": [
      {
        "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>"
        ]
      }
    ],
    "id": "<string>",
    "ratesResponse": {
      "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

id · string | null

rateRequests · object[] | null

Show child attributes

Response

200

application/json

Success

componentRates · object[] | null

Show child attributes

id · string | null

ratesResponse · object

Show child attributes