get

/orders/{order_id}/shipping_addresses/{shipping_address_id}/shipping_quotes

Gets any shipping quotes assocated to an order.

This is a read only enpoint and the output can vary based on the shipping quote. A shipping quote can only be generated using the storefront at this time. Orders that are created in the control panel or via api return a 204 for this endpoint since a shipping quote is not generated during that process.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Path Parameters
2 Headers

Responses

4 Examples
Schema
object
id
string

Id of the shipping quote

1 validation
uuid
string

uuid of the shipping quote

1 validation
timestamp
string

Time the order was created in RFC 2822 format.

1 validation
shipping_provider_id
string

Id of the shipping provider

1 validation
shipping_provider_quote
array

This can vary based on the shipping provider. Manual shipping methods such as fixed will return an empty array. Shipping providers such as UPS will return an object with the shipping information. Since the shipping quote is tied to a shipping address only one quote will return in the response.

provider_code
string

Code of the shipping provider

1 validation
carrier_code
string

Code of the shipping carrier

rate_code
string

Type of delivery. This can vary based on shipping quote.

rate_id
string

This can vary based on shipping quote

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
3 path params not set
store_hash
order_id
shipping_address_id
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client