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

{
  "base_cost": "5.0000",
  "base_handling_cost": "0.0000",
  "city": "Austin",
  "company": "",
  "cost_ex_tax": "4.0000",
  "cost_inc_tax": "4.3200",
  "cost_tax": "0.3200",
  "cost_tax_class_id": 2,
  "country": "United States",
  "country_iso2": "US",
  "email": "jane@example.com",
  "first_name": "Jane",
  "form_fields": [
    {
      "name": "Wholesale ID",
      "value": "12345566"
    }
  ],
  "handling_cost_ex_tax": "0.0000",
  "handling_cost_inc_tax": "0.0000",
  "handling_cost_tax": "0.0000",
  "handling_cost_tax_class_id": 2,
  "id": 42,
  "items_shipped": 0,
  "items_total": 2,
  "last_name": "Doe",
  "order_id": 140,
  "phone": "1234567890",
  "shipping_method": "Fixed Shipping",
  "shipping_quotes": {
    "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/orders/140/shippingaddresses/42/shippingquotes",
    "resource": "/orders/140/shippingaddresses/42/shippingquotes"
  },
  "shipping_zone_id": 1,
  "shipping_zone_name": "United States",
  "state": "Texas",
  "street_1": "123 MainStreet",
  "street_2": "",
  "zip": "78751"
}

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.

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.

Path parameters

order_idintegerRequired

ID of the order.

idstringRequired

Shipping address ID.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

The requested order shipping address.

base_coststringOptional

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

base_handling_coststringOptional

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

citystringOptional

companystringOptional

cost_ex_taxstringOptional

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

cost_inc_taxstringOptional

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

cost_taxstringOptional

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

cost_tax_class_idintegerOptional

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

countrystringOptional

country_iso2stringOptional

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

emailstringOptional

Recipient’s email address.

first_namestringOptional

form_fieldslist of objectsOptional

handling_cost_ex_taxstringOptional

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

handling_cost_inc_taxstringOptional

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

handling_cost_taxstringOptional

handling_cost_tax_class_idintegerOptional

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

idintegerOptional

ID of this shipping address.

items_shippeddoubleOptional

The number of items that have been shipped.

items_totaldoubleOptional

The total number of items in the order.

last_namestringOptional

order_idintegerOptional

ID of the order.

phonestringOptional

Recipient’s telephone number.

shipping_methodstringOptional

Text code identifying the BigCommerce shipping module selected by the customer.

shipping_quotesobjectOptionalRead-only

shipping_zone_iddoubleOptional

Numeric ID of the shipping zone.

shipping_zone_namestringOptional

Name of the shipping zone.

statestringOptional

street_1stringOptional

Street address (first line).

street_2stringOptional

Street address (second line).

zipstringOptional

Zip or postal code, as a string.