Get Available Shipping Methods

Retrieves available shipping methods for groupings. Typically used to display available shipping method options on the checkout page.

GET /commerce/checkouts/{checkoutId}/shippingMethods

Error

A valid request URL is required to generate request examples

200

[
  {
    "groupingId": "<string>",
    "shippingRates": [
      {
        "currencyCode": "<string>",
        "price": 123,
        "data": {},
        "fulfillmentMethod": "<string>",
        "isValid": true,
        "messages": [
          "<string>"
        ],
        "shippingItemRates": [
          {
            "amount": 123,
            "itemId": "<string>",
            "quantity": 123
          }
        ],
        "shippingMethodCode": "<string>",
        "shippingMethodName": "<string>",
        "shippingZoneCode": "<string>"
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

checkoutId · string · required

Unique identifier of the checkout whose shipping methods you want to get.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

groupingId · string | null

shippingRates · object[] | null

Show child attributes