For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • Overview
  • Learning Plans
    • Developer Foundations
    • Composable Developer
    • Stencil Developer
    • B2B Developer
  • Courses
        • Orders API
        • Orders
        • Order Status
        • Order Shipping Address
        • Order Products
      • Conclusion
    • Learning Changelog
Dev Portal
LogoLogo
On this page
  • Update an order’s shipping address
  • GET a List of Order Shipping Addresses
  • GET a Shipping Address
  • Resources:
CoursesCheckout and Orders APIModule 4: Orders API

Order Shipping Address

Was this page helpful?
Previous

Order Status

Next

Order Products

Built with
Lesson 13 of 26 · 30 min

Retrieve or update a shipping address associated with an order.

  • If a shipping address is not provided, it defaults to the billing address.
  • The shipping address is input as an array object since more than one shipping address can be added at a time. Adding multiple shipping addresses allows for an order to ship to multiple locations.
  • When adding shipping addresses during an order PUT or POST request, the API will allow you to add more than is necessary.

Update an order’s shipping address

Update or add a shipping address to an existing order with a PUT request to: /orders/{order_id}

PUT https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{order_id}

Image

Image

GET a List of Order Shipping Addresses

GET all shipping addresses on an order using the order_id by sending a request to: /orders/{order_id}/shipping_addresses

GET https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{order_id}/shipping_addresses

GET a Shipping Address

GET a single shipping addresses associated with an order with the id of the shipping address: /orders/{order_id}/shipping_addresses/{id}

GET https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{order_id}/shipping_addresses/{id}

Returned in the response is shipping_quotes object. Please use the Get Shipping Quotes Endpoint. Using the response will return a 204 for the shipping quote.

Resources:

  • Order Shipping Address