Orders V2
Get Order Shipping Addresses
GET /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses
Request
Get all shipping addresses 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.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- page in query - number
The page to return in the response.
- limit in query - number
Number of results to return.
example
Response
Body
response
Get a Shipping Address
GET /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses/{id}
Request
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-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- order_id in path - integerrequired
ID of the order.
- id in path - stringrequired
Shipping address ID.
example
Response
Body
idinteger
ID of this shipping address.
Example: 1
order_idinteger
ID of the order.
Example: 100
items_totalnumber
The total number of items in the order.
Example: 1
items_shippednumber
The number of items that have been shipped.
Example: 0
base_coststring
The base value of the order’s items. (Float, Float-As-String, Integer)
Example: 5.0000
cost_ex_taxstring
The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
cost_inc_taxstring
The value of the order’s items, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
cost_taxstring
The tax amount on the order. (Float, Float-As-String, Integer)
Example: 0.0000
cost_tax_class_idinteger
The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
Example: 2
base_handling_coststring
The base handling charge. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_ex_taxstring
The handling charge, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The handling charge, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_taxstring
Example: 0.0000
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.)
Example: 2
shipping_zone_idnumber
Numeric ID of the shipping zone.
Example: 1
shipping_zone_namestring
Name of the shipping zone.
Example: United States
form_fieldsarray[object]
shipping_quotesobject
read-only
first_namestring
Example: Jane
last_namestring
Example: Doe
companystring
street_1string
Street address (first line).
Example: 123 Main Street
street_2string
Street address (second line).
citystring
Example: Austin
statestring
Example: Texas
zipstring
Zip or postal code, as a string.
Example: 12345
countrystring
Example: United States
country_iso2string
2-letter ISO Alpha-2 code for the country.
Example: US
phonestring
Recipient’s telephone number.
emailstring
Recipient’s email address.
Example: janedoe@example.com
shipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.
Example: Free Shipping
response
Update a Shipping Address
PUT /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses/{id}
Request
Update a shipping address associated with an order.
Note: Updating a shipping address will NOT trigger the recalculation of shipping cost and tax
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - stringrequired
Shipping address ID.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
first_namestring
Example: Jane
last_namestring
Example: Doe
companystring
street_1string
Street address (first line).
Example: 123 Main Street
street_2string
Street address (second line).
citystring
Example: Austin
statestring
Example: Texas
zipstring
Zip or postal code, as a string.
Example: 12345
countrystring
Example: United States
country_iso2string
2-letter ISO Alpha-2 code for the country.
Example: US
phonestring
Recipient’s telephone number.
emailstring
Recipient’s email address.
Example: janedoe@example.com
shipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.
Example: Free Shipping
form_fieldsarray[object]
application/json
Response
OK
Body
idinteger
ID of this shipping address.
Example: 1
order_idinteger
ID of the order.
Example: 100
items_totalnumber
The total number of items in the order.
Example: 1
items_shippednumber
The number of items that have been shipped.
Example: 0
base_coststring
The base value of the order’s items. (Float, Float-As-String, Integer)
Example: 5.0000
cost_ex_taxstring
The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
cost_inc_taxstring
The value of the order’s items, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
cost_taxstring
The tax amount on the order. (Float, Float-As-String, Integer)
Example: 0.0000
cost_tax_class_idinteger
The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
Example: 2
base_handling_coststring
The base handling charge. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_ex_taxstring
The handling charge, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The handling charge, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_taxstring
Example: 0.0000
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.)
Example: 2
shipping_zone_idnumber
Numeric ID of the shipping zone.
Example: 1
shipping_zone_namestring
Name of the shipping zone.
Example: United States
form_fieldsarray[object]
shipping_quotesobject
read-only
first_namestring
Example: Jane
last_namestring
Example: Doe
companystring
street_1string
Street address (first line).
Example: 123 Main Street
street_2string
Street address (second line).
citystring
Example: Austin
statestring
Example: Texas
zipstring
Zip or postal code, as a string.
Example: 12345
countrystring
Example: United States
country_iso2string
2-letter ISO Alpha-2 code for the country.
Example: US
phonestring
Recipient’s telephone number.
emailstring
Recipient’s email address.
Example: janedoe@example.com
shipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.
Example: Free Shipping