Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
shipping
/
transit-times
Error
A valid request URL is required to generate request examples
{
  "originLocationCode": "<string>",
  "destinationAddress": {
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "address4": "<string>",
    "cityOrTown": "<string>",
    "stateOrProvince": "<string>",
    "postalOrZipCode": "<string>",
    "countryCode": "<string>",
    "addressType": "<string>",
    "isValidated": true
  },
  "shipDate": "2023-11-07T05:31:56Z",
  "items": [
    {
      "itemId": "<string>",
      "unitMeasurements": {
        "height": {
          "unit": "<string>",
          "value": 123
        },
        "width": {
          "unit": "<string>",
          "value": 123
        },
        "length": {
          "unit": "<string>",
          "value": 123
        },
        "weight": {
          "unit": "<string>",
          "value": 123
        },
        "girth": 123
      },
      "quantity": 123,
      "data": {},
      "productCode": "<string>"
    }
  ],
  "transitTimes": [
    {
      "carrierId": "<string>",
      "estimatedDeliveryDates": [
        {
          "fulfillmentMethod": "<string>",
          "serviceType": "<string>",
          "deliveryDate": "<string>",
          "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"
              }
            }
          ],
          "messages": [
            {
              "severity": "<string>",
              "message": "<string>",
              "helpLink": "<string>"
            }
          ],
          "data": {}
        }
      ],
      "itemIds": [
        "<string>"
      ]
    }
  ],
  "data": {}
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json
originLocationCode
string | null
originAddress
object
destinationAddress
object
fulfillmentMethod
string | null
shippingServiceTypes
string[] | null
shipDate
string<date-time>
items
object[] | null
data
object

Custom data for the request

Response

Success

originLocationCode
string | null
destinationAddress
object
shipDate
string<date-time>
items
object[] | null
transitTimes
object[] | null
data
object