Order Shipping Addresses
Get Order Shipping Addresses
GET https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}/shipping_addressesRequest
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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- order_id in path - integerrequiredID of the order.
- page in query - numberThe page to return in the response.
- limit in query - numberNumber of results to return.
example
Response
Body
array | application/json
idinteger
ID of this shipping address.Example: 1order_idinteger
ID of the order.Example: 100items_totalnumber
The total number of items in the order.Example: 1items_shippednumber
The number of items that have been shipped.base_coststring
The base value of the order’s items. (Float, Float-As-String, Integer)Example: 5.0000cost_ex_taxstring
The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)Example: 0.0000cost_inc_taxstring
The value of the order’s items, including tax. (Float, Float-As-String, Integer)Example: 0.0000cost_taxstring
The tax amount on the order. (Float, Float-As-String, Integer)Example: 0.0000cost_tax_class_idinteger
The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)Example: 2base_handling_coststring
The base handling charge. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_ex_taxstring
The handling charge, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_inc_taxstring
The handling charge, including tax. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_taxstring
Example: 0.0000handling_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: 2shipping_zone_idnumber
Numeric ID of the shipping zone.Example: 1shipping_zone_namestring
Name of the shipping zone.Example: United Statesform_fieldsarray[object]
shipping_quotesobject
read-onlyfirst_namestring
Example: Janelast_namestring
Example: Doecompanystring
street_1string
Street address (first line).Example: 123 Main Streetstreet_2string
Street address (second line).citystring
Example: Austinstatestring
Example: Texaszipstring
Zip or postal code, as a string.Example: 12345countrystring
Example: United Statescountry_iso2string
2-letter ISO Alpha-2 code for the country.Example: USphonestring
Recipient’s telephone number.emailstring
Recipient’s email address.Example: janedoe@example.comshipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.Example: Free Shipping
response
Get a Shipping Address
GET https://api.bigcommerce.com/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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- order_id in path - integerrequiredID of the order.
- id in path - stringrequiredShipping address ID.
example
Response
Body
object | application/json
Shipping Address properties common to all requests and responses.
idinteger
ID of this shipping address.Example: 1order_idinteger
ID of the order.Example: 100items_totalnumber
The total number of items in the order.Example: 1items_shippednumber
The number of items that have been shipped.base_coststring
The base value of the order’s items. (Float, Float-As-String, Integer)Example: 5.0000cost_ex_taxstring
The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)Example: 0.0000cost_inc_taxstring
The value of the order’s items, including tax. (Float, Float-As-String, Integer)Example: 0.0000cost_taxstring
The tax amount on the order. (Float, Float-As-String, Integer)Example: 0.0000cost_tax_class_idinteger
The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)Example: 2base_handling_coststring
The base handling charge. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_ex_taxstring
The handling charge, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_inc_taxstring
The handling charge, including tax. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_taxstring
Example: 0.0000handling_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: 2shipping_zone_idnumber
Numeric ID of the shipping zone.Example: 1shipping_zone_namestring
Name of the shipping zone.Example: United Statesform_fieldsarray[object]
shipping_quotesobject
read-onlyfirst_namestring
Example: Janelast_namestring
Example: Doecompanystring
street_1string
Street address (first line).Example: 123 Main Streetstreet_2string
Street address (second line).citystring
Example: Austinstatestring
Example: Texaszipstring
Zip or postal code, as a string.Example: 12345countrystring
Example: United Statescountry_iso2string
2-letter ISO Alpha-2 code for the country.Example: USphonestring
Recipient’s telephone number.emailstring
Recipient’s email address.Example: janedoe@example.comshipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.Example: Free Shipping
response
Update a Shipping Address
PUT https://api.bigcommerce.com/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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- order_id in path - integerrequiredID of the order.
- id in path - stringrequiredShipping address ID.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
Shipping Address properties common to all requests and responses.
first_namestring
Example: Janelast_namestring
Example: Doecompanystring
street_1string
Street address (first line).Example: 123 Main Streetstreet_2string
Street address (second line).citystring
Example: Austinstatestring
Example: Texaszipstring
Zip or postal code, as a string.Example: 12345countrystring
Example: United Statescountry_iso2string
2-letter ISO Alpha-2 code for the country.Example: USphonestring
Recipient’s telephone number.emailstring
Recipient’s email address.Example: janedoe@example.comshipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.Example: Free Shippingform_fieldsarray[object]
application/json
Response
OK
Body
object | application/json
Shipping Address properties common to all requests and responses.
idinteger
ID of this shipping address.Example: 1order_idinteger
ID of the order.Example: 100items_totalnumber
The total number of items in the order.Example: 1items_shippednumber
The number of items that have been shipped.base_coststring
The base value of the order’s items. (Float, Float-As-String, Integer)Example: 5.0000cost_ex_taxstring
The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)Example: 0.0000cost_inc_taxstring
The value of the order’s items, including tax. (Float, Float-As-String, Integer)Example: 0.0000cost_taxstring
The tax amount on the order. (Float, Float-As-String, Integer)Example: 0.0000cost_tax_class_idinteger
The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)Example: 2base_handling_coststring
The base handling charge. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_ex_taxstring
The handling charge, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_inc_taxstring
The handling charge, including tax. The value can't be negative. (Float, Float-As-String, Integer)Example: 0.0000handling_cost_taxstring
Example: 0.0000handling_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: 2shipping_zone_idnumber
Numeric ID of the shipping zone.Example: 1shipping_zone_namestring
Name of the shipping zone.Example: United Statesform_fieldsarray[object]
shipping_quotesobject
read-onlyfirst_namestring
Example: Janelast_namestring
Example: Doecompanystring
street_1string
Street address (first line).Example: 123 Main Streetstreet_2string
Street address (second line).citystring
Example: Austinstatestring
Example: Texaszipstring
Zip or postal code, as a string.Example: 12345countrystring
Example: United Statescountry_iso2string
2-letter ISO Alpha-2 code for the country.Example: USphonestring
Recipient’s telephone number.emailstring
Recipient’s email address.Example: janedoe@example.comshipping_methodstring
Text code identifying the BigCommerce shipping module selected by the customer.Example: Free Shipping
response
Did you find what you were looking for?