Thanks for being patient while we implement your feedback to improve the developer experience.

Get Order Shipping Quotes

GET /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 header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • order_id in path - integer - required

    ID of the order.

  • shipping_address_id in path - integer - required

    Shipping address ID.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/orders/[order_id]/shipping_addresses/[shipping_address_id]/shipping_quotes' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

This response can vary depending on the shipping provider.

Body

object | application/json

  • id    string

    ID of the shipping quote.

    Example: 24

  • uuid    string

    UUID of the shipping quote.

    Example: a72acc8d-504b-4a40-8534-7c54d997ed59

  • timestamp    string

    Time the order was created in RFC 2822 format.

  • shipping_provider_id    string

    ID of the shipping provider.

    Example: bcstatic

  • 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.

    Example: shipping_byweight

  • 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.

  • method_id    integer

    Shipping method ID

example

{
  "id": "24",
  "uuid": "a72acc8d-504b-4a40-8534-7c54d997ed59",
  "timestamp": "2019-08-24T14:15:22Z",
  "shipping_provider_id": "bcstatic",
  "shipping_provider_quote": [
    null
  ],
  "provider_code": "shipping_byweight",
  "carrier_code": "string",
  "rate_code": "string",
  "rate_id": "string",
  "method_id": 0
}