API Status Codes
The BigCommerce API responds to requests with different HTTP status codes depending on the result from the request. Error responses might also include an error message in the body to assist in resolving the problem.
2xx codes are returned for requests that were understood and processed successfully.
|201||Created||For a successful
|202||Accepted||For a request that resulted in a scheduled task being created to perform the actual request.|
|204||No Content||For a successful request that produced no response (such as
|207||Multi-Status||Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occured.|
3xx codes are returned for requests that require further action.
|301||Moved Permanently||When the API routes have changed (unlikely), or if the incoming request is not secure (
|304||Not Modified||This response will be sent if the request included an
4xx Client Error
4xx codes are returned for requests that could not be processed due to problems with the request or the data.
|400||Bad Request||Issued when a malformed request was sent.|
|401||Unauthorized||This response is sent when your client failed to provide credentials or its credentials were invalid.|
|403||Forbidden||Returned when permissions do not allow the operation.|
|404||Not Found||When a particular resource doesn’t exist or couldn’t be found.|
|405||Method Not Allowed||The resource was found, but doesn’t support the request method. Issued when either a specific method isn’t yet implemented on a resource, or the resource doesn’t support the method at all. For example, a
|406||Not Acceptable||When the client specifies a response content type in the
|409||Conflict||A change requested by the client is being rejected, due to a condition imposed by the server. The exact reasons for this response will vary from one resource to the next. An example might be attempting to delete a category whose deletion would cause products to be orphaned. Additional information about the conflict, and about how to resolve it, might be available in the response’s
|413||Request Entity Too Large||When the client requests too many objects. For example, the
|415||Unsupported Media Type||Returned due to issues with the
|422||Missing or Invalid Data||The request cannot be processed either because it omitted required fields or because it contained invalid data. See the response for more details.|
|429||Too Many Requests||When an OAuth client exceeds the rate limit for API requests to a store.|
5xx Server Error
5xx codes are returned for requests that could not be processed due to an internal error with the API or server.
|500||Internal Server Error||When an error has occurred within the API.|
|501||Not Implemented||When a request method is sent that is not supported by the API (e.g.,
|503||Service Unavailable||When the store is “Down for Maintenance,” being upgraded to a new version, or is suspended due to administrative action or a billing issue.|
|507||Insufficient Storage||When the store has reached a limitation for the resource, according to their BigCommerce plan (e.g., 500-product limit).|
|204, 301, and 302||Redirects||Try the
|400||Invalid syntax, required data missing,
||Double-check request body for syntax errors and missing data; check
|401||API credentials are missing or invalid.||Double-check the
|Send cURL request with the same credentials to rule app or config issues.|
|403||App lacks required OAuth scopes, a store-owner account changed, operations resulting from API request exceed a platform limit, or URL requested is incorrect.||Double-check OAuth Scopes in control panel > API Accounts or in Developer Portal > My Apps.|
|Check the URL. Are the endpoint and store hash correct?|
|Ensure platform limits have not been reached.|
|415||Request headers specify an unsupported
|500||Expensive API calls or an internal server error in BigCommerce.||Re-attempt the request three to five times, with increasing delays of at least a minute between attempts.|
|Try reducing the number of objects being requested. You can request fewer objects in the in the v2 API, by using
|Check the BigCommerce Status Page.|