Order
Company based order management.
Get Orders
GET https://api-b2b.bigcommerce.com/api/v2/ordersRequest
Get orders.
Equivalent Storefront GraphQL API Query: allOrders
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- beginDateAt in query - stringBegin query date
- endDateAt in query - stringEnd query date
- orderBy in query with default of createdAt - stringOrder by
- sortBy in query with default of DESC - stringSort order by desc or asc
- offset in query with default of 0 - stringPagination offset
- limit in query with default of 10 - stringPagination limit
- isShowMy in query with default of 0 - stringIs show my orders
- includeExtra in query with default of 0 - stringInclude extra field
- q in query - stringQuery string
- companyName in query - stringCompany name
- orderNumber in query - stringOrder number
- poNumber in query - stringPO number
- status[] in query - stringOrder status
example
Response
Body
codenumber
requireddataobject
required
example-1
Create an Order
POST https://api-b2b.bigcommerce.com/api/v2/ordersRequest
Create an order in the BigCommerce store.
Equivalent Storefront GraphQL API Mutation: createOrder
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
orderIdstring
requiredUnique order ID in BigCommerce storepoNumberstring
PO numberisSaveOrderCommentstring
If save order commentextraFieldsarray[object]
example
Response
Body
codenumber
requireddataobject
required
example-1
Get Order Images
GET https://api-b2b.bigcommerce.com/api/v2/orders/imagesRequest
Get order images.
Equivalent Storefront GraphQL API Query: orderImages
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- orderIds[] in query - stringUnique order ID
example
Response
Body
codenumber
requireddataarray[object]
required
example-1
Get Order Products
GET https://api-b2b.bigcommerce.com/api/v2/orders/{orderId}/productsRequest
Get order products by orderId.
Equivalent Storefront GraphQL API Query: orderProducts
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- orderId in path - stringrequiredUnique order ID in BigCommerce store
example
Response
Body
codenumber
requireddataarray[object]
required
example-1
Get Order Detail
GET https://api-b2b.bigcommerce.com/api/v2/orders/{orderId}/detailsRequest
Get order detail by orderId. Please refer to BigCommerce API for detailed parameter introduction.
Equivalent Storefront GraphQL API Query: order
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- orderId in path - stringrequiredUnique order ID in BigCommerce store
example
Response
Body
codenumber
requireddataobject
required
example-1
Get Ordered Product List
GET https://api-b2b.bigcommerce.com/api/v2/ordered-productsRequest
Get ordered products.
Equivalent Storefront GraphQL API Query: orderedProducts
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- offset in query - stringPagination offset
- limit in query - stringPagination limit
- beginDateAt in query - stringBegin date
- endDateAt in query - stringEnd date
- minOrderedTimes in query - stringMinimum ordered times
- maxOrderedTimes in query - stringMaximum ordered times
- productID in query - stringProduct ID
- q in query - stringQuery string
example
Response
Body
codenumber
requireddataobject
required
example-1
See something you can improve? Edit this file on GitHub