Dev Center Updates

API Announcement for January 26, 2024

2024-01-26T19:53:29.763Z

Announcement

BigCommerce for WordPress Plugin Update Required!

We have deployed a fix for a recent vulnerability found with the BigCommerce for WordPress plugin.

To prevent security vulnerabilities, please upgrade your plugin by following the steps below.

Navigate to your WordPress website and log in as an admin.
In the sidebar, select "Plugins".
Select the "update now" hyperlink for the BigCommerce for WordPress plugin.
Wait for the upgrade to finish.

API internal migration on August 7, 2023

2023-08-07T17:08:54.611Z

API

We are implementing an internal migration for GET v3/catalog/categories and GET v3/catalog/categories/{category_id} endpoints to enhance our API’s performance. If you experience any unexpected API behavior on the following endpoint, please check the documentation to ensure all accurate query params and API usage.

Node 12 End-of-life on April 30th

2022-03-29T16:49:54.023Z

Node 12 enters End-of-life on April 30, 2022 (https://endoflife.date/nodejs). From this date, new versions of Stencil CLI will drop support for Node 12, and add support for Node 14. In order to provide time for developers to update their Stencil development/deployment environments, we will not bump the required version of Stencil CLI to a version that requires Node 14+ until June 1, 2022.

Change to number of product images returned in Stencil home page resources on April 15

2022-03-28T21:03:06.735Z

On April 15, 2022, the number of product images returned by the Featured Products, New Products, and Popular Products panels on Stencil storefronts is changing.

These panels will now return up to 10 images per product, instead of returning all of the images on each product if there are greater than 10. This change will result in improvements to storefront performance when products on the store have a large number of images.

If the design of your storefront relies on accessing the data for a large number of images for each of these products, please consider using a GraphQL query instead to access more images. GraphQL can be used to fetch additional data as frontend API calls, or can be embedded in Frontmatter to be utilized directly within the theme context via Handlebars.

Change to default number of product images returned by GraphQL on April 15

2022-03-28T20:51:01.973Z

On April 15, 2022, the behavior of the product.images node in the GraphQL storefront API will be changing to only return 10 images by default. If you wish to request a different number of product images, you should specify the `first` argument explicitly with your request, which is considered a best practice when interacting with any paginated collection.

For example, if you were previously sending a request like this:

query productsWithImages {
site {
products {
edges {
cursor
node {
entityId
name
images { // will return 10 images unless explicit arguments are specified
edges {
node {
url(width: 640)
}
}
}
}
}
}
}
}

You could instead send a request like this:

query productsWithImages {
site {
products(first: 5) { // as a best practice, use `first` on all collections to specify page size
edges {
cursor
node {
entityId
name
images (first:20) { // will return up to 20 images per product
edges {
node {
url(width: 640)
}
}
}
}
}
}
}
}

Please note that requesting larger amounts of data with increased page sizes will factor into the GraphQL complexity calculation for your query.

Upcoming changes to HTTP header casing

2022-01-12T19:26:25.330Z

Infrastructural changes to BigCommerce over the next 2 weeks may result in some HTTP headers being returned as lowercase which previously had a mixture of uppercase and lowercase characters.

For example, HTTP header names such as X-Rate-Limit-Requests-Left may instead be returned as x-rate-limit-requests-left. Per the HTTP specification (https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2), HTTP header names should always be treated as case-insensitive, so we do not consider this to be a breaking change to the API. Most HTTP clients already treat headers with the appropriate case insensitivity, so we expect minimal customer impact from this change.

No changes are being made to HTTP header values as part of this change.

Required Stencil-CLI version set to 3.5.0

2021-09-15T21:41:02.720Z

A bug affecting users of stencil-CLI has been fixed as of CLI version 3.5.0.

As this bug was resulting in CLI requests incorrectly redirecting which resulted in a degradation of the local development experience, we have bumped the required version of CLI to 3.5.0to limit the customer impact of this issue. All CLI versions before 3.5.0 are affected. All users are strongly encouraged to update immediately in order to avoid issues during local development.

To get the latest version of stencil-CLI, simply run this command in your terminal:

npm install -g @bigcommerce/stencil-cli

API Announcement for March 4, 2021

2021-03-04T20:27:54.933Z

On April 30, 2021, the Coupon API will limit the characters allowed in a coupon name. An error will result if any special characters other than the following are used in the Coupon code field:

Alphanumeric values
White spaces
Underscores ( _ )
Hyphens ( - )

To prevent a disruption in service, remove special characters from all coupon codes.

The qty_in_cart property is removed from the Stencil Common Product Card object

2020-11-05T04:00:00.001Z

As part of an effort to improve the performance of BigCommerce storefronts, the qty_in_cart property is no longer supported on the Stencil Common Product Card Model. This property will return 0 from now on, and its use is discouraged.

The Storefront Cart API can be used instead to get details of products in the cart.

Inventory levels are no longer returned in Stencil context based on settings

2020-10-15T18:07:00.001Z

Inventory Levels will no longer be returned in the Stencil context data if your store’s Inventory settings are set to "Don’t show Stock Levels".

Previously, this setting would only hide the stock levels on individual product pages, while the stock level was still exposed erroneously on category, brand, and search pages.

This update will be rolling out to all stores in the coming days.