Manage order coupons, messages, products, shipping addresses, statuses, taxes, shipments, and shipping address quotes.
Order
The Order object contains a record of the purchase agreement between a shopper and a merchant. To learn more about creating orders, see Orders API Guide.
Currency Fields
The default currency refers to the transactional currency which is the currency the shopper pays in.
The display currency refers to the presentational currency used to present prices to the shopper on the storefront.
currency_id - the display currency ID. Depending on the currency selected, the value may be different from the transactional currency.
currency_code - the currency code of the display currency used to present prices to the shopper on the storefront. Depending on the currency selected, the value may be different from the transactional currency.
currency_exchange_rate - the exchange rate between the store’s default currency and the display currency. For orders created using the V2 endpoints, this value is always 1 (only in the storefront this value can be different to 1).
default_currency_id - the transactional currency ID.
default_currency_code - the currency code of the transactional currency the shopper pays in.
The following additional fields are returned on orders when Multi-Currency is enabled on the store:
store_default_currency_code - the currency code of the store’s default currency.
store_default_to_transactional_exchange_rate - the exchange rate between the store’s default currency and the transactional currency used in the order.
Gets an Order. To learn more about creating or updating orders, see Orders Overview.
Authentication
X-Auth-Token in header - required
Parameters
store_hash in path - string
include in query - string
consignments - include the response returned from the request to the /orders/{order_id}/consignments endpoint.
consignments.line_items - include the response returned from the request to the /orders/{order_id}/products endpoint in consignments. This implies include=consignments.
A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
date_shippedstring
A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
cart_idstring
The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a read-only field; do not set or modify its value in a POST or PUT request.
Example: a8458391-ef68-4fe5-9ec1-442e6a767364
statusstring
The status will include one of the (string, options) - values defined under Order Statuses. This value is read-only. Do not attempt to modify or set this value in a POST or PUT operation.
Example: Awaiting Fulfillment
subtotal_taxstring
A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_tax_class_idinteger
Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (NOTE: Value ignored if automatic tax is enabled on the store.)
Example: 2
handling_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
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 request.
(NOTE: Value ignored if automatic tax is enabled on the store.)
Example: 2
wrapping_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_tax_class_idinteger
A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
NOTE: Value ignored if automatic tax is enabled on the store.
Example: 3
payment_statusstring
A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
Represents the store credit that the shopper has redeemed on this individual order. This is a read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
gift_certificate_amountstring
A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
currency_idinteger
The display currency ID. Depending on the currency selected, the value can be different from the transactional currency. A read-only value. Do not pass in a POST or PUT request. In v2 display currency is set to the transactional currency, ''default_currency_id''.
Example: 1
currency_codestring
The currency code of the display currency used to present prices to the shopper on the storefront. Depending on the currency selected, the value can be different from the transactional currency. A read-only value. Do not pass in a POST or PUT request.
Example: USD
currency_exchange_ratestring
The exchange rate between the store’s default currency and the display currency. A read-only value. Do not pass in a POST or PUT request. For orders created using the V2 endpoints, this value is always 1 (only in the storefront this value can be different to 1). (Float, Float-As-String, Integer)
Example: 1.0000000000
default_currency_idinteger
The transactional currency ID. A read-only value. Do not pass in a POST or PUT request.
Example: 1
default_currency_codestring
The currency code of the transactional currency the shopper pays in.
Example: EUR
store_default_currency_codestring
The currency code of the storeʼs default currency.
The exchange rate between the storeʼs default currency and the transactional currency used in the order.
Example: 100.0000000000
coupon_discountstring
A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 5.0000
shipping_address_countnumber
The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT.
is_email_opt_inboolean
Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.
Example: false
order_sourcestring
Orders submitted from the storeʼs website will include a www value. Orders submitted with the Checkout API will be set to checkout_api.
Example: www, iPhone, Android, mobile, manual
consignmentsobject
productsobject
shipping_addressesobject
couponsobject
status_idinteger
The status ID of the order.
Example: 7
billing_addressobject
base_handling_coststring
The value of the base handling cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_shipping_coststring
The value of the base shipping cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_wrapping_coststring
The value of the base wrapping cost expressed as a floating point number to four decimal places in string format.
Example: 0.0000
billing_addressobject
channel_idinteger
Shows where the order originated. The channel_id will default to 1.
Example: 1
customer_idnumber
customer_messagestring
Message that the customer entered (number, options) -o the Order Comments box during checkout.
Example: Thank you
date_createdstring
The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., Tue, 20 Nov 2012 00:00:00 +0000.
default_currency_codestring
The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled.
discount_amountstring
Amount of discount for this transaction. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_order_idstring
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
Example: 0
external_idstring
(Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
Example: null
external_merchant_idstring
The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the external_merchant_id. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
Example: null
external_sourcestring
This value identifies an external system that generated the order and submitted it to BigCommerce with the Orders API.
When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or POS (Square).
If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing.
If you do not provide a value, then it will default to null.
Example: null
geoip_countrystring
The full name of the country where the customer made the purchase, based on the IP.
Example: United States
geoip_country_iso2string
The country where the customer made the purchase, in ISO2 format, based on the IP.
Example: US
handling_cost_ex_taxstring
The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The value of the handling cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
ip_addressstring
IPv4 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address value will reset the ip_address_v6 value and vice versa.
<= 30 characters
Example: 12.345.678.910
ip_address_v6string
IPv6 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address_v6 value will reset the ip_address value and vice versa.
<= 39 characters
Example: 2001:db8:3333:4444:5555:6666:7777:8888
is_deletedboolean
Indicates whether the order was deleted (archived). Set to to true, to archive an order.
Example: false
items_shippednumber
The number of items that have been shipped.
Example: 0
items_totalnumber
The total number of items in the order.
Example: 1
order_is_digitalboolean
Whether this is an order for digital products.
Example: false
payment_methodstring
The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.
The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
One of:number
Type: string
Example:
refunded_amountstring
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_ex_taxstring
The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_inc_taxstring
The value of shipping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
staff_notesstring
Any additional notes for staff.
<= 65535 characters
Example: Send Saturday
status_idinteger
The status ID of the order.
subtotal_ex_taxstring
Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
subtotal_inc_taxstring
Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
tax_provider_idstring
BasicTaxProvider - Tax is set to manual and order is created in the store.
AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.
"" (empty string) - The order is created with the API, or the tax provider is unknown.
Allowed: BasicTaxProvider | AvaTaxProvider |
customer_localestring
The customer’s locale.
Example: en
external_order_idstring
The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request.
Example: external-order-id
total_ex_taxstring
Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
total_inc_taxstring
Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
To add a product to an existing order, don't include id in the body. Include product_options if adding a product with variants.
To update a product in an order, include id in the body. The body should only contain the fields that need to be updated. Those fields that are omitted will not be changed.
To remove a product from an order, set that product’s quantity to 0.
To learn more about creating or updating orders, see Orders Overview.
Authentication
X-Auth-Token in header - requiredShow details
Parameters
store_hash in path - string
Content-Type in header with default of application/json - string - required
The value of the base handling cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_shipping_coststring
The value of the base shipping cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_wrapping_coststring
The value of the base wrapping cost expressed as a floating point number to four decimal places in string format.
Example: 0.0000
billing_address
channel_idinteger
Shows where the order originated. The channel_id will default to 1.
Example: 1
consignmentsobject
customer_idnumber
customer_messagestring
Message that the customer entered (number, options) -o the Order Comments box during checkout.
Example: Thank you
date_createdstring
The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., Tue, 20 Nov 2012 00:00:00 +0000.
default_currency_codestring
A read-only field displays the currency code of the transactional currency the shopper uses.
discount_amountstring
Amount of discount for this transaction. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_order_idstring
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
Example: 0
external_idstring
(Read-only) The order ID in another system, such as the Amazon Order ID if this is an Amazon order.
Example: null
external_merchant_idstring
The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the external_merchant_id. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
Example: null
external_sourcestring
This value identifies an external system that generated the order and submitted it to BigCommerce with the Orders API.
When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or POS (Square).
If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing.
If you do not provide a value, then it will default to null.
Example: null
geoip_countrystring
The full name of the country where the customer made the purchase, based on the IP.
Example: United States
geoip_country_iso2string
The country where the customer made the purchase, in ISO2 format, based on the IP.
Example: US
handling_cost_ex_taxstring
The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The value of the handling cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
ip_addressstring
IPv4 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address value will reset the ip_address_v6 value and vice versa.
<= 30 characters
Example: 12.345.678.910
ip_address_v6string
IPv6 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address_v6 value will reset the ip_address value and vice versa.
<= 39 characters
Example: 2001:db8:3333:4444:5555:6666:7777:8888
is_deletedboolean
Indicates whether the order was deleted (archived). Set to to true, to archive an order.
Example: false
items_shippednumber
The number of items that have been shipped.
Example: 0
items_totalnumber
The total number of items in the order.
Example: 1
order_is_digitalboolean
Whether this is an order for digital products.
Example: false
payment_methodstring
The payment method for this order. Can be one of the following: Manual, Credit Card, Cash,Test Payment Gateway, etc.
payment_provider_id
The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
One of:stringnumber
Type: string
productsarray[]
refunded_amountstring
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_ex_taxstring
The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_inc_taxstring
The value of shipping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
staff_notesstring
Any additional notes for staff.
<= 65535 characters
Example: Send Saturday
shipping_addressesarray[object]
status_idinteger
The status ID of the order.
subtotal_ex_taxstring
Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
subtotal_inc_taxstring
Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
tax_provider_idstring
BasicTaxProvider - Tax is set to manual and order is created in the store.
AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.
"" (empty string) - The order is created with the API, or the tax provider is unknown.
Allowed: BasicTaxProvider | AvaTaxProvider |
customer_localestring
The customer’s locale.
Example: en
external_order_idstring
The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request.
Example: external-order-id
total_ex_taxstring
Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
total_inc_taxstring
Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
application/json
JSONcURLNode.jsPHPRubyJava
Adding an existing product to order
JSONcURLNode.jsPHPRubyJava
Adding a new product to order
JSONcURLNode.jsPHPRubyJava
Removing a product from an order
JSONcURLNode.jsPHPRubyJava
Response
200
Order Response.
Body
application/json
Order object returned in responses.
idinteger
Read-only. The ID of the order.
Example: 118
date_modifiedstring
A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
date_shippedstring
A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
cart_idstring
The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a read-only field; do not set or modify its value in a POST or PUT request.
Example: a8458391-ef68-4fe5-9ec1-442e6a767364
statusstring
The status will include one of the (string, options) - values defined under Order Statuses. This value is read-only. Do not attempt to modify or set this value in a POST or PUT operation.
Example: Awaiting Fulfillment
subtotal_taxstring
A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_tax_class_idinteger
Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (NOTE: Value ignored if automatic tax is enabled on the store.)
Example: 2
handling_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
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 request.
(NOTE: Value ignored if automatic tax is enabled on the store.)
Example: 2
wrapping_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_tax_class_idinteger
A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
NOTE: Value ignored if automatic tax is enabled on the store.
Example: 3
payment_statusstring
A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
Represents the store credit that the shopper has redeemed on this individual order. This is a read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
gift_certificate_amountstring
A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
currency_idinteger
The display currency ID. Depending on the currency selected, the value can be different from the transactional currency. A read-only value. Do not pass in a POST or PUT request. In v2 display currency is set to the transactional currency, ''default_currency_id''.
Example: 1
currency_codestring
The currency code of the display currency used to present prices to the shopper on the storefront. Depending on the currency selected, the value can be different from the transactional currency. A read-only value. Do not pass in a POST or PUT request.
Example: USD
currency_exchange_ratestring
The exchange rate between the store’s default currency and the display currency. A read-only value. Do not pass in a POST or PUT request. For orders created using the V2 endpoints, this value is always 1 (only in the storefront this value can be different to 1). (Float, Float-As-String, Integer)
Example: 1.0000000000
default_currency_idinteger
The transactional currency ID. A read-only value. Do not pass in a POST or PUT request.
Example: 1
default_currency_codestring
The currency code of the transactional currency the shopper pays in.
Example: EUR
store_default_currency_codestring
The currency code of the storeʼs default currency.
The exchange rate between the storeʼs default currency and the transactional currency used in the order.
Example: 100.0000000000
coupon_discountstring
A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 5.0000
shipping_address_countnumber
The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT.
is_email_opt_inboolean
Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.
Example: false
order_sourcestring
Orders submitted from the storeʼs website will include a www value. Orders submitted with the Checkout API will be set to checkout_api.
Example: www, iPhone, Android, mobile, manual
consignmentsobject
productsobject
shipping_addressesobject
couponsobject
status_idinteger
The status ID of the order.
Example: 7
billing_addressobject
base_handling_coststring
The value of the base handling cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_shipping_coststring
The value of the base shipping cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_wrapping_coststring
The value of the base wrapping cost expressed as a floating point number to four decimal places in string format.
Example: 0.0000
billing_addressobject
channel_idinteger
Shows where the order originated. The channel_id will default to 1.
Example: 1
customer_idnumber
customer_messagestring
Message that the customer entered (number, options) -o the Order Comments box during checkout.
Example: Thank you
date_createdstring
The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., Tue, 20 Nov 2012 00:00:00 +0000.
default_currency_codestring
The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled.
discount_amountstring
Amount of discount for this transaction. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_order_idstring
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
Example: 0
external_idstring
(Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
Example: null
external_merchant_idstring
The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the external_merchant_id. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
Example: null
external_sourcestring
This value identifies an external system that generated the order and submitted it to BigCommerce with the Orders API.
When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or POS (Square).
If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing.
If you do not provide a value, then it will default to null.
Example: null
geoip_countrystring
The full name of the country where the customer made the purchase, based on the IP.
Example: United States
geoip_country_iso2string
The country where the customer made the purchase, in ISO2 format, based on the IP.
Example: US
handling_cost_ex_taxstring
The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The value of the handling cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
ip_addressstring
IPv4 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address value will reset the ip_address_v6 value and vice versa.
<= 30 characters
Example: 12.345.678.910
ip_address_v6string
IPv6 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address_v6 value will reset the ip_address value and vice versa.
<= 39 characters
Example: 2001:db8:3333:4444:5555:6666:7777:8888
is_deletedboolean
Indicates whether the order was deleted (archived). Set to to true, to archive an order.
Example: false
items_shippednumber
The number of items that have been shipped.
Example: 0
items_totalnumber
The total number of items in the order.
Example: 1
order_is_digitalboolean
Whether this is an order for digital products.
Example: false
payment_methodstring
The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.
The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
One of:stringnumber
Type: string
Example:
refunded_amountstring
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_ex_taxstring
The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_inc_taxstring
The value of shipping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
staff_notesstring
Any additional notes for staff.
<= 65535 characters
Example: Send Saturday
status_idinteger
The status ID of the order.
subtotal_ex_taxstring
Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
subtotal_inc_taxstring
Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
tax_provider_idstring
BasicTaxProvider - Tax is set to manual and order is created in the store.
AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.
"" (empty string) - The order is created with the API, or the tax provider is unknown.
Allowed: BasicTaxProvider | AvaTaxProvider |
customer_localestring
The customer’s locale.
Example: en
external_order_idstring
The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request.
Example: external-order-id
total_ex_taxstring
Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
total_inc_taxstring
Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
consignments - include the response returned from the request to the /orders/{order_id}/consignments endpoint.
consignments.line_items - include the response returned from the request to the /orders/{order_id}/products endpoint in consignments. This implies include=consignments.
consignments - include the response returned from the request to the /orders/{order_id}/consignments endpoint.
consignments.line_items - include the response returned from the request to the /orders/{order_id}/products endpoint in consignments. This implies include=consignments.
Products and Billing address only required for POST operation.
productsarray[]
shipping_addressesarray[object]
consignmentsobject
base_handling_coststring
The value of the base handling cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_shipping_coststring
The value of the base shipping cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_wrapping_coststring
The value of the base wrapping cost expressed as a floating point number to four decimal places in string format.
Example: 0.0000
billing_addressobject
channel_idinteger
Shows where the order originated. The channel_id will default to 1.
Example: 1
customer_idnumber
customer_messagestring
Message that the customer entered (number, options) -o the Order Comments box during checkout.
Example: Thank you
date_createdstring
The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., Tue, 20 Nov 2012 00:00:00 +0000.
default_currency_codestring
The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled.
discount_amountstring
Amount of discount for this transaction. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_order_idstring
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
Example: 0
external_idstring
(Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
Example: null
external_merchant_idstring
The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the external_merchant_id. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
Example: null
external_sourcestring
This value identifies an external system that generated the order and submitted it to BigCommerce with the Orders API.
When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or POS (Square).
If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing.
If you do not provide a value, then it will default to null.
Example: null
geoip_countrystring
The full name of the country where the customer made the purchase, based on the IP.
Example: United States
geoip_country_iso2string
The country where the customer made the purchase, in ISO2 format, based on the IP.
Example: US
handling_cost_ex_taxstring
The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The value of the handling cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
ip_addressstring
IPv4 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address value will reset the ip_address_v6 value and vice versa.
<= 30 characters
Example: 12.345.678.910
ip_address_v6string
IPv6 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address_v6 value will reset the ip_address value and vice versa.
<= 39 characters
Example: 2001:db8:3333:4444:5555:6666:7777:8888
is_deletedboolean
Indicates whether the order was deleted (archived). Set to to true, to archive an order.
Example: false
items_shippednumber
The number of items that have been shipped.
Example: 0
items_totalnumber
The total number of items in the order.
Example: 1
order_is_digitalboolean
Whether this is an order for digital products.
Example: false
payment_methodstring
The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.
The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
One of:stringnumber
Type: string
Example:
refunded_amountstring
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_ex_taxstring
The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_inc_taxstring
The value of shipping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
staff_notesstring
Any additional notes for staff.
<= 65535 characters
Example: Send Saturday
status_idinteger
The status ID of the order.
subtotal_ex_taxstring
Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
subtotal_inc_taxstring
Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
tax_provider_idstring
BasicTaxProvider - Tax is set to manual and order is created in the store.
AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.
"" (empty string) - The order is created with the API, or the tax provider is unknown.
Allowed: BasicTaxProvider | AvaTaxProvider |
customer_localestring
The customer’s locale.
Example: en
external_order_idstring
The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request.
Example: external-order-id
total_ex_taxstring
Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
total_inc_taxstring
Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
Product with Variants
JSONcURLNode.jsPHPRubyJava
Custom Product
JSONcURLNode.jsPHPRubyJava
Product with Options
JSONcURLNode.jsPHPRubyJava
Product with a Drop Down and a Text Field Modifier
JSONcURLNode.jsPHPRubyJava
Multiple Products
JSONcURLNode.jsPHPRubyJava
Response
200
Order Response.
Body
application/json
Order object returned in responses.
idinteger
Read-only. The ID of the order.
Example: 118
date_modifiedstring
A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
date_shippedstring
A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
cart_idstring
The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a read-only field; do not set or modify its value in a POST or PUT request.
Example: a8458391-ef68-4fe5-9ec1-442e6a767364
statusstring
The status will include one of the (string, options) - values defined under Order Statuses. This value is read-only. Do not attempt to modify or set this value in a POST or PUT operation.
Example: Awaiting Fulfillment
subtotal_taxstring
A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_tax_class_idinteger
Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (NOTE: Value ignored if automatic tax is enabled on the store.)
Example: 2
handling_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
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 request.
(NOTE: Value ignored if automatic tax is enabled on the store.)
Example: 2
wrapping_cost_taxstring
A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_tax_class_idinteger
A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
NOTE: Value ignored if automatic tax is enabled on the store.
Example: 3
payment_statusstring
A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
Represents the store credit that the shopper has redeemed on this individual order. This is a read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
gift_certificate_amountstring
A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 0.0000
currency_idinteger
The display currency ID. Depending on the currency selected, the value can be different from the transactional currency. A read-only value. Do not pass in a POST or PUT request. In v2 display currency is set to the transactional currency, ''default_currency_id''.
Example: 1
currency_codestring
The currency code of the display currency used to present prices to the shopper on the storefront. Depending on the currency selected, the value can be different from the transactional currency. A read-only value. Do not pass in a POST or PUT request.
Example: USD
currency_exchange_ratestring
The exchange rate between the store’s default currency and the display currency. A read-only value. Do not pass in a POST or PUT request. For orders created using the V2 endpoints, this value is always 1 (only in the storefront this value can be different to 1). (Float, Float-As-String, Integer)
Example: 1.0000000000
default_currency_idinteger
The transactional currency ID. A read-only value. Do not pass in a POST or PUT request.
Example: 1
default_currency_codestring
The currency code of the transactional currency the shopper pays in.
Example: EUR
store_default_currency_codestring
The currency code of the storeʼs default currency.
The exchange rate between the storeʼs default currency and the transactional currency used in the order.
Example: 100.0000000000
coupon_discountstring
A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
Example: 5.0000
shipping_address_countnumber
The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT.
is_email_opt_inboolean
Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.
Example: false
order_sourcestring
Orders submitted from the storeʼs website will include a www value. Orders submitted with the Checkout API will be set to checkout_api.
Example: www, iPhone, Android, mobile, manual
consignmentsobject
productsobject
shipping_addressesobject
couponsobject
status_idinteger
The status ID of the order.
Example: 7
billing_addressobject
base_handling_coststring
The value of the base handling cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_shipping_coststring
The value of the base shipping cost. (Float, Float-As-String, Integer)
Example: 0.0000
base_wrapping_coststring
The value of the base wrapping cost expressed as a floating point number to four decimal places in string format.
Example: 0.0000
billing_addressobject
channel_idinteger
Shows where the order originated. The channel_id will default to 1.
Example: 1
customer_idnumber
customer_messagestring
Message that the customer entered (number, options) -o the Order Comments box during checkout.
Example: Thank you
date_createdstring
The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., Tue, 20 Nov 2012 00:00:00 +0000.
default_currency_codestring
The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled.
discount_amountstring
Amount of discount for this transaction. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_order_idstring
If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.
Example: 0
external_idstring
(Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
Example: null
external_merchant_idstring
The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the external_merchant_id. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
Example: null
external_sourcestring
This value identifies an external system that generated the order and submitted it to BigCommerce with the Orders API.
When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or POS (Square).
If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing.
If you do not provide a value, then it will default to null.
Example: null
geoip_countrystring
The full name of the country where the customer made the purchase, based on the IP.
Example: United States
geoip_country_iso2string
The country where the customer made the purchase, in ISO2 format, based on the IP.
Example: US
handling_cost_ex_taxstring
The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
handling_cost_inc_taxstring
The value of the handling cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
ip_addressstring
IPv4 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address value will reset the ip_address_v6 value and vice versa.
<= 30 characters
Example: 12.345.678.910
ip_address_v6string
IPv6 Address of the customer, if known.
Note: You can set either ip_address or ip_address_v6. Setting the ip_address_v6 value will reset the ip_address value and vice versa.
<= 39 characters
Example: 2001:db8:3333:4444:5555:6666:7777:8888
is_deletedboolean
Indicates whether the order was deleted (archived). Set to to true, to archive an order.
Example: false
items_shippednumber
The number of items that have been shipped.
Example: 0
items_totalnumber
The total number of items in the order.
Example: 1
order_is_digitalboolean
Whether this is an order for digital products.
Example: false
payment_methodstring
The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.
The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
One of:stringnumber
Type: string
Example:
refunded_amountstring
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_ex_taxstring
The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
shipping_cost_inc_taxstring
The value of shipping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
staff_notesstring
Any additional notes for staff.
<= 65535 characters
Example: Send Saturday
status_idinteger
The status ID of the order.
subtotal_ex_taxstring
Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
subtotal_inc_taxstring
Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
tax_provider_idstring
BasicTaxProvider - Tax is set to manual and order is created in the store.
AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.
"" (empty string) - The order is created with the API, or the tax provider is unknown.
Allowed: BasicTaxProvider | AvaTaxProvider |
customer_localestring
The customer’s locale.
Example: en
external_order_idstring
The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request.
Example: external-order-id
total_ex_taxstring
Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
total_inc_taxstring
Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)
Example: 225.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)