Orders V2
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.
Example:
{
...
"currency_id": 4,
"currency_code": "EUR",
"currency_exchange_rate": 1,
"default_currency_id": 4,
"default_currency_code": "EUR",
"store_default_currency_code": "USD",
"store_default_to_transactional_exchange_rate": "100.0000000000"
...
}Get an Order
GET https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}Request
Gets an Order. To learn more about creating or updating orders, see Orders Overview.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Order Response.
Body
Order object returned in responses.
response
Multiple Items
Update an Order
PUT https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}Request
Updates an Order.
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.
After the update, the PUT request clears all discounts and promotions applied to the order. Since the order data syncs with other ERP systems, like Amazon or eBay, the updated order returns to the default setting, removing any applied discounts.
To learn more about creating or updating orders, see Orders Overview.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
application/json
Adding an existing product to order
Adding a new product to order
Removing a product from an order
Response
Order Response.
Body
Order object returned in responses.
response
Multiple Items
Archive an Order
DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}Request
Archives an order. To remove a single product from an order, see PUT /orders/{order_id}.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Get a Count of Orders
GET https://api.bigcommerce.com/stores/{store_hash}/v2/orders/countRequest
Gets an array of orders in the store organized by order status.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Order Counter response collection.
Body
statusesarray[]
countnumber
Total number of orders in the store.
Example: 45
response
Get All Orders
GET https://api.bigcommerce.com/stores/{store_hash}/v2/ordersRequest
Gets a list of orders using the filter query.
Notes
- The default sort is by order id, from lowest to highest.
- By default, requests sent without parameters will only return 50 orders.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
response
Create an Order
POST https://api.bigcommerce.com/stores/{store_hash}/v2/ordersRequest
Creates an Order. To learn more about creating or updating orders, see Orders Overview.
Create an order with an existing catalog product or a custom product.
Required Fields
productsorconsignmentsbilling_address
When you create an order, the consignment(s) array allows you to create pickup consignments.
- An order can have either a pickup or a shipping fulfillment method, but not both.
- An order can have only one pickup consignment.
Choose from one of the following:
- Create order with a shipping fulfillment method using
shipping_addressesandproducts, i.e. legacy mode - Create order with a pickup fulfillment method using
consignments, i.e. Consignment mode
You can fulfill an order with shipping or pickup, but not both.
This means that if the consignments array is present in the request, then none of the following may be present and vice-versa:
shipping_addressesproducts
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Products and Billing address only required for POST operation.
Product with Variants
Custom Product
Product with Options
Product with a Drop Down and a Text Field Modifier
Multiple Products
Response
Order Response.
Body
Order object returned in responses.