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
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Carts
        • Carts
        • Channels
        • Checkouts
        • Currencies
        • Customer Segmentation
        • Geography
        • Infrastructure Hosting
        • Inventory
        • Orders
            • GETGet Order
            • PUTUpdate Order
            • DELArchive Order
            • GETGet Count of Orders
            • GETList Orders
            • POSTCreate Order
            • DELDelete All Orders
              • GETList Order Shipping Addresses
              • GETGet Shipping Address
              • PUTUpdate Shipping Address
        • Order Operations
        • Pickup
        • Pickup Methods
        • Pickup Options
        • Pricing
        • Price Lists
        • Promotions
        • Promotion Settings
        • Redirects
        • Scripts
        • Settings
        • Shipping
        • Sites
        • Subscribers
        • System Logs
        • Tax
        • Wishlists
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminManagementOrdersOrder Shipping Addresses

Get Shipping Address

GET
https://api.bigcommerce.com/stores/:store_hash/v2/orders/:order_id/shipping_addresses/:id
GET
/stores/:store_hash/v2/orders/:order_id/shipping_addresses/:id
$curl https://api.bigcommerce.com/stores/store_hash/v2/orders/1/shipping_addresses/id \
>     -H "Accept: application/json" \
>     -H "X-Auth-Token: <apiKey>"
200response
1{
2  "base_cost": "5.0000",
3  "base_handling_cost": "0.0000",
4  "city": "Austin",
5  "company": "",
6  "cost_ex_tax": "4.0000",
7  "cost_inc_tax": "4.3200",
8  "cost_tax": "0.3200",
9  "cost_tax_class_id": 2,
10  "country": "United States",
11  "country_iso2": "US",
12  "email": "jane@example.com",
13  "first_name": "Jane",
14  "form_fields": [
15    {
16      "name": "Wholesale ID",
17      "value": "12345566"
18    }
19  ],
20  "handling_cost_ex_tax": "0.0000",
21  "handling_cost_inc_tax": "0.0000",
22  "handling_cost_tax": "0.0000",
23  "handling_cost_tax_class_id": 2,
24  "id": 42,
25  "items_shipped": 0,
26  "items_total": 2,
27  "last_name": "Doe",
28  "order_id": 140,
29  "phone": "1234567890",
30  "shipping_method": "Fixed Shipping",
31  "shipping_quotes": {
32    "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/orders/140/shippingaddresses/42/shippingquotes",
33    "resource": "/orders/140/shippingaddresses/42/shippingquotes"
34  },
35  "shipping_zone_id": 1,
36  "shipping_zone_name": "United States",
37  "state": "Texas",
38  "street_1": "123 MainStreet",
39  "street_2": "",
40  "zip": "78751"
41}

Gets a shipping address associated with an order.

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.

Was this page helpful?
Previous

List Order Shipping Addresses

Next

Update Shipping Address

Built with

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Orders | modify | `store_v2_orders` | | Orders | read-only | `store_v2_orders_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

order_idintegerRequired
ID of the order.
idstringRequired
Shipping address ID.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json
The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Response

base_coststring

The base value of the order’s items. (Float, Float-As-String, Integer)

base_handling_coststring

The base handling charge. The value can’t be negative. (Float, Float-As-String, Integer)

citystring
companystring
cost_ex_taxstring

The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)

cost_inc_taxstring

The value of the order’s items, including tax. (Float, Float-As-String, Integer)

cost_taxstring

The tax amount on the order. (Float, Float-As-String, Integer)

cost_tax_class_idinteger

The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)

countrystring
country_iso2string

2-letter ISO Alpha-2 code for the country.

emailstring

Recipient’s email address.

first_namestring
form_fieldslist of objects
handling_cost_ex_taxstring

The handling charge, excluding tax. The value can’t be negative. (Float, Float-As-String, Integer)

handling_cost_inc_taxstring

The handling charge, including tax. The value can’t be negative. (Float, Float-As-String, Integer)

handling_cost_taxstring
handling_cost_tax_class_idinteger

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.)

idinteger
ID of this shipping address.
items_shippeddouble
The number of items that have been shipped.
items_totaldouble
The total number of items in the order.
last_namestring
order_idinteger
ID of the order.
phonestring

Recipient’s telephone number.

shipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.
shipping_quotesobjectRead-only
shipping_zone_iddouble
Numeric ID of the shipping zone.
shipping_zone_namestring
Name of the shipping zone.
statestring
street_1string

Street address (first line).

street_2string

Street address (second line).

zipstring
Zip or postal code, as a string.

OAuth scopes

UI NamePermissionParameter
Ordersmodifystore_v2_orders
Ordersread-onlystore_v2_orders_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

The MIME type of the response body.