Order Shipping Addresses Quotes
Get Order Shipping Quotes
GET https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}/shipping_addresses/{shipping_address_id}/shipping_quotesRequest
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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- order_id in path - integerrequiredID of the order.
- shipping_address_id in path - integerrequiredShipping address ID.
example
Response
This response can vary depending on the shipping provider.
Body
object | application/json
idstring
ID of the shipping quote.Example: 24uuidstring
UUID of the shipping quote.Example: a72acc8d-504b-4a40-8534-7c54d997ed59shipping_provider_idstring
ID of the shipping provider.Example: bcstaticshipping_provider_quotearray[object]
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_byweightcarrier_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
example
Did you find what you were looking for?