The Bigcommerce API supports various HTTP headers which are used for authorization, controlling content type. Some headers can be also used for purposes such as increasing performance of your application by only returning responses when content has been modified.
Header |
Operations |
Allowed Values |
Description |
Required |
Example |
|---|---|---|---|---|---|
Accept |
All |
application/json (for .json requests) |
The MIME type for the format you want to receive a response in. See the Data Formats page for details. |
|
application/xml |
Authorization |
All |
Basic |
The user credentials for accessing the API. See the YesAuthentication page for details. |
Yes |
Basic YWRtaW46cGFzc3dvcmQ= |
Content-Type |
All |
application/json (for .json requests) |
The MIME type of the request body. Use to validate and parse the request to the API. |
Yes |
application/json |
If-Modified-Since |
GET |
An RFC 2822 date. |
If supplied, then only resources modified since the specified date will be returned. If there are no modified objects, then a 304 Not Modified response will be sent. Please refer to the individual resource pages for support for this header. |
|
Tue, 15 Nov 2011 12:45:26 GMT |
User-Agent |
All |
String |
While it is not required, we ask that you specify a user agent which identifies your integration/client with your requests. |
|
|
Header |
Operations |
Possible Values |
Description |
Example |
|---|---|---|---|---|
Date |
All |
An RFC 2822 date. |
The date the response was sent. |
Tue, 15 Nov 2011 12:45:26 GMT |
Last-Modified |
GET, PUT, POST |
An RFC 2822 date. |
The date the resource was last modified. Please refer to the individual resource pages for support for this header. |
Tue, 15 Nov 2011 12:45:26 GMT |
Content-Type |
All |
application/json (for .json requests) |
The MIME type of the response, dependent on the extension of the endpoint that was requested. |
application/json |
Content-Location |
All |
A URI. |
Sent if the request was redirected. |
/api/v2/orders/5.json |
WWW-Authenticate |
All |
Basic |
Indicates the authentication scheme that should be used to access the API. Sent with a 401 Unauthorized response if HTTP Basic authentication credentials weren't supplied. |
Basic |
Location |
POST |
A URI. |
The URI of a newly created resource. Sent with a 201 Created response. |
/api/v2/products/7 |
X-BC-ApiLimit-Remaining |
All |
An integer. |
The number of API requests remaining for the current period (rolling 1 hour). |
987 |
X-BC-Store-Version |
All |
A version code. |
The version of Bigcommerce the store is running on. This header is available from versions 7.3.6+. |
7.3.6 |