Best Practices

B2B Edition is built to provide optimal stability and performance to your B2B store. In order to maintain a stable and reliable platform, we implement rate limits for our APIs, and we suggest several best practices when creating custom developments.

Resources in B2B Edition share many of the guidelines as the BigCommerce platform in general. In this document, we will cover the rate limits and considerations that are specific to B2B Edition, but you can find more information on best practices in the following resources:

Ensure your integration is up-to-date

We make regular updates to B2B Edition’s REST Management V3 API endpoints and the GraphQL Storefront API. This allows us to incorporate new features and maintain existing resources.

Updating your integration ensures that it is compatible with any new or updated features, and also prevents it from using deprecated endpoints. Check our release notes (opens in a new tab) regularly to learn about any new features, as well as any upcoming changes to existing endpoints.

API rate limits

B2B Edition enforces a limit of 150 API requests per minute. Any additional requests made in the time frame are rejected by the system until the interval resets.

This limit is applied across all integrations that make requests to B2B Edition APIs in your store. See our best practices for API rate limits (opens in a new tab) to learn how to manage them in your integration.

Endpoint-specific limits

Some B2B Edition API endpoints have their own rate limits. For example, Add a Company Attachment (opens in a new tab) has a limit of 15 requests per minute. Check the reference documentation for a particular endpoint to confirm whether or not it has a specific quota.

Concurrent API call rate limits

Certain API resources rate limit concurrent requests. This is to ensure the performance and reliability of the platform for all of our users. API calls are metered on a per-store, per-endpoint basis.

B2B Edition API requests that invoke additional API calls to BigCommerce's APIs are also subject to BigCommerce rate limits. For example, the Create a User (opens in a new tab) endpoint creates a Company user account, which also generates a customer account in the BigCommerce control panel.

Webhooks

Currently, B2B Edition does not support the use of custom webhook events to listen for B2B Edition events, such as Company account creation or quote conversion. Some analogous events are supported by the standard BigCommerce APIs, and they can serve as viable alternatives with additional setup

For example, you can listen for newly-created Company accounts by starting with the store/customer/created webhook, which fires when a new customer account is created. With a subsequent request to the Get a User by Customer ID (opens in a new tab) endpoint, you confirm if the customer is associated with a Company account, and then you can use Get Company Details (opens in a new tab) to compare its createdAt timestamp with the payload object of the original webhook.

See Webhooks Overview (opens in a new tab) to learn more about using webhooks in your integration.

Did you find what you were looking for?

Authentication Open source repo