Orders V2
Get Order Shipping Quotes
GET /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses/{shipping_address_id}/shipping_quotes
Request
Gets all shipping quotes persisted on an order.
This is a read-only endpoint 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 using the API return a 204 for this endpoint since a shipping quote is not generated during that process.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- order_id in path - integerrequired
ID of the order.
- shipping_address_id in path - integerrequired
Shipping address ID.
example
Response
This response can vary depending on the shipping provider.
Body
idstring
ID of the shipping quote.
Example: 24
uuidstring
UUID of the shipping quote.
Example: a72acc8d-504b-4a40-8534-7c54d997ed59
timestampstring
Time the order was created in RFC 2822 format.
shipping_provider_idstring
ID of the shipping provider.
Example: bcstatic
shipping_provider_quotearray[]
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_codestring
Code of the shipping provider.
Example: shipping_byweight
carrier_codestring
Code of the shipping carrier.
rate_codestring
Type of delivery. This can vary based on shipping quote.
rate_idstring
This can vary based on shipping quote.
method_idinteger
Shipping method ID