Get Rates

post https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/catalog/storefront/shipping/request-rates

Get Rate Responses for a Rate Request

Query Params

includeRawResponse

boolean

Defaults to false

responseFields

string

limits which fields are returned in the response body

Body Params

string | null

isoCurrencyCode

string | null

originAddress

object

destinationAddress

object

carrierIds

array of strings | null

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.

carrierIds

shippingServiceTypes

array of strings | null

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.

shippingServiceTypes

orderTotal

double | null

The OrderTotal to be used in rate calculation

orderDiscountedSubTotal

double | null

The Order SubTotal After Discounts to be used in rate calculation

handlingTotal

double | null

The order Handling total after discounts to be used in rate calculation

relatedOrderId

string | null

The Order ID to be used in rate calculation
Informational only

relatedOrderNumber

int32 | null

The Order Number to be used in rate calculation
Informational only

isDestinationAddressCommercial

boolean | null

Is the destination address a commercial address?

items

array | null

items

estimatedShipmentDate

date-time | null

Estimate Date/Time when the shipment for this will be sent. Primarily utilize to estimate delivery date.

attributes

array of objects | null

Order Attributes. Made available for Arc.js to use

attributes

customAttributes

array | null

deprecated

customAttributes

data

object | null

originLocationCode

string | null

Optional for STH rates. The location code of the origin location. Used for calculation of Delivery rates.

Response

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://t0-s0.sandbox.mozu.com/api/commerce/catalog/storefront/shipping/request-rates?includeRawResponse=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here!

200Success