get

/orders/{order_id}/shipping_addresses

Get all shipping address on an order using the order_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.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

1 Path Parameter
2 Query Parameters
2 Headers

Responses

2 Examples
Schema
array[object]
id
integer

ID of this shipping address.

1 validation
order_id
integer

ID of the order.

1 validation
first_name
string

Addressee first name.

1 validation
last_name
string

Addressee last name.

1 validation
company
string

Addressee company.

1 validation
street_1
string

Street address (first line).

1 validation
street_2
string

Street address (second line).

city
string

Addressee city.

1 validation
zip
string

ZIP or postal code, as a string.

1 validation
country
string

Addressee’s country.

1 validation
country_iso2
string

2-letter ISO Alpha-2 code for the country. (Looking Up Country Codes)

1 validation
state
string

The name of the state or province. Should be spelled out in full, e.g.: California.

1 validation
email
string

Recipient’s email address.

1 validation
phone
string

Recipient’s telephone number

1 validation
items_total
number

The total number of items in the order.

1 validation
items_shipped
number

The number of items that have been shipped.

1 validation
shipping_method
string

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

1 validation
base_cost
string

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

1 validation
cost_ex_tax
string

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

1 validation
cost_inc_tax
string

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

1 validation
cost_tax
string

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

1 validation
cost_tax_class_id
integer

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

1 validation
base_handling_cost
string

The base handling charge. (Float, Float-As-String, Integer)

1 validation
handling_cost_ex_tax
string

The handling charge, excluding tax. (Float, Float-As-String, Integer)

1 validation
handling_cost_inc_tax
string

The handling charge, including tax. (Float, Float-As-String, Integer)

1 validation
handling_cost_tax
string
1 validation
handling_cost_tax_class_id
integer

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

1 validation
shipping_zone_id
integer

Numeric ID of the shipping zone.

1 validation
shipping_zone_name
string

Name of the shipping zone.

1 validation
form_fields
array[object]

Empty array

shipping_quotes
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
store_hash
order_id
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client