About Our APIs
API environments
Make BigCommerce B2B Edition API requests in the context of the storefront or server-to-server.
| API | Base URL |
|---|---|
| GraphQL Storefront API | https://api-b2b.bigcommerce.com/graphql |
| REST Storefront API | See endpoint reference (opens in a new tab) |
| REST Management V3 | https://api-b2b.bigcommerce.com/api/v3/io/ |
| REST Management V2 | https://api-b2b.bigcommerce.com/api/v2/io/ |
Key resources
| Resource | Description |
|---|---|
| Company (opens in a new tab) | Set client company info, administrator, and more. |
| Address (opens in a new tab) | Associate one or more addresses with a company. |
| Order (opens in a new tab) | Extend the BigCommerce order object with B2B-specific information, such as purchase order number. |
| Payment (opens in a new tab) | Manage company payment methods. |
| Sales staff (opens in a new tab) and super admin (opens in a new tab) | Manage sales staff and admin access privileges. |
| Quote (opens in a new tab) | Manage quotes. |
| Proxy (opens in a new tab) | Create a third-party proxy. |
Request headers
| Header | Expected value or type | Description | Example |
|---|---|---|---|
authToken | String | B2B Edition auth token | - |
Accept | MIME types | The MIME type format that indicates which response type the request expects. For more information, see HTTP Docs: Accept Header (MDN) (opens in a new tab). | application/json |
Content-Type | MIME types | The MIME type of the request body. The API uses this value to validate and parse the request. For more information, see HTTP Docs: Content-Type Header (MDN) (opens in a new tab). | application/json |
User-Agent | String | We ask that you specify a user agent to identify your integration or client. | PostmanRuntime/7.32.3 |
Pagination
Use the limit and offset query parameters together to paginate responses.
The limit value determines the number of records to return per page. The offset value is the number of results to skip before returning the first result.
For example, passing the following query param string returns the 11th through 20th results: offset=10&limit=10.
Did you find what you were looking for?