Orders
The Orders Storefront REST and GraphQL APIs allow you to retrieve order details from Company accounts. By authenticating requests as a Company user, you can retrieve information on the orders visible in their Buyer Portal.
In order to return order information, you must generate a storefront authToken for a buyer with the following Company user permissions:
- Get orders
- Get order detail
The storefront experience of placing an order, for both B2B and B2C customers, relies on the BigCommerce checkout or use of the standard BigCommerce APIs. As a result, the B2B Orders API does not include endpoints for creating new orders or adding existing orders. Use the BigCommerce Orders V2 API to accomplish these tasks.
When specifying an order as a parameter of an endpoint, provide the BigCommerce order ID as the unique identifier. The B2B Edition Order ID, presented as the id value of certain B2B Orders API responses, is not a supported identifier for the bcOrderId field.
Legacy Extra Fields
The Get All Orders and Get Order Details endpoints include the following legacy Company extra fields used by older stores:
extraInt1extraInt2extraInt3extraInt4extraInt5extraStr1extraStr2extraStr3extraStr4extraStr5extraText
These fields return null values in newer stores. We recommend using the Get Company Extra Fields endpoint to retrieve Company extra field information.