A valid request URL is required to generate request examples{
"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>"
]
}Get Rate Responses for a Rate Request
A valid request URL is required to generate request examples{
"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>"
]
}JWT Authorization header using the Bearer scheme.
limits which fields are returned in the response body
Order Attributes. Made available for Arc.js to use
Show child attributes
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.
Show child attributes
Show child attributes
Estimate Date/Time when the shipment for this will be sent. Primarily utilize to estimate delivery date.
The order Handling total after discounts to be used in rate calculation
Is the destination address a commercial address?
Show child attributes
The Order SubTotal After Discounts to be used in rate calculation
The OrderTotal to be used in rate calculation
Show child attributes
Optional for STH rates. The location code of the origin location. Used for calculation of Delivery rates.
The Order ID to be used in rate calculation Informational only
The Order Number to be used in rate calculation Informational only
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.
Success
Show child attributes
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)