Release notes

API

• The newly-released comparison_price and extended_comparison_price fields are now available in the Checkout V3 API. Now, you can identify the price of a single or line item (product x quantity) used for strike-through.

• The newly-released Product custom fields Admin API is now available. Now, you can deliver localized experiences to fit different shopper needs. For example, when selling products internationally, you can add custom field information for products in various languages, have different product custom fields for different brand websites, or for different shopper segments (e.g., B2B and B2C). 

Announcement

• The response structure of included consignment resources in the Get an Order and Get All Orders endpoints will change on February 1, 2025. If you add include=consignments or include=consignments.line_items to the request parameters, please update integrations to read the new structure specified in the documentation. Currently, the response structure for these resources is as follows:

{
  consignments: [{
    pickups: [...],
    shipping: [...],
    downloads: [...],
    email: {...}
  }],
}

After February 1, the response structure for these resources will be as follows:

{
  consignments: {
    pickups: [...],
    shipping: [...],
    downloads: [...],
    email: {...}
  },
}

If you wish to opt in to this change early, please include the following flag in your request: consignment_structure=object

API

• We are excited to announce a new form of authentication for our GraphQL Storefront API which improves our security posture and solves session synchronization issues with headless checkouts. The customer access token offers the following benefits:

  • Logged-in customers maintain their login state through to checkout (without having to use the Customer Login API).

  • A synchronized session between storefront & checkout; logging out in one place will log you out in both places.

  • Support for more security-sensitive features we will add to Catalyst in the future, such as Saved Payment Methods.

GraphQL

• We are happy to announce that HTTPS webhooks are now manageable with Admin GraphQL APIs.

Improvements

• Clarified the accepted Tax Provider API quote ID values and usages.

Bug Fixes

• Fixed a bug to indicate that the Update a channel endpoint does not support restoring a channel to prelaunch status. Thank you @mattcoy-arcticleaf

• Fixed incorrect schema for the Create Batch Price Lists Records endpoint.

• Removed invalid event store/order/transaction/updated from the Callbacks documentation.

• Updated and fixed missing attributes in the Callbacks documentation.

API

• Storefront GraphQL Order capabilities are now available to the public. You can now perform queries that fetch a customer's order history and a specific customer order and access order details. See a list of examples in GraphQL Storefront API: Customers and try them in the BigCommerce GraphQL Playground.

• Updated the Get Theme Regions endpoint to include a channel_id query parameter. 

Payments

• We're happy to announce that we added TD Online Mart to the list of compatible payment gateways for Stored Instruments and Raw Card Data.

Bug Fix

• Removed a sentence from the Delete Checkout Consignment endpoint description regarding removing the cart from its assigned customer after deleting a checkout's last consignment. This sentence is inaccurate.

Developer Blog

• Bringing Automation to B2B: Enhance Your B2B Store with Atom8

• Navigating BigCommerce’s API Rate Limits Update

API

• Apps compatible with multi-location inventory use our Inventory API for inventory adjustments. Now, you can indicate whether an app is MLI-compatible when you submit an app in the Dev Portal. See the Add supported features section for more information.

GraphQL

• We're happy to announce that you can now create GraphQL Storefront API Tokens that are valid for multiple channels. For more information, see Create a Storefront API token and Create a Customer Impersonation Token. 

Announcement

• We removed the API rate limit content from the Best Practices section to streamline documentation and improve clarity for developers. API Rate Limits documentation now exists as its own reference article and dives deeper into API rate limit standards and best practices.

Bug Fix

• Removed all pagination objects and replaced them with an empty meta object for the Get all themes endpoint.

API

• We're happy to announce the ability to query product videos using the storefront product graph.

• We have updated the API rate limits documentation, adding new methods for handling limits and optimizing requests.

GraphQL

• The GraphQL Storefront API's newly released CustomersSettings node has password complexity requirements that are now available. Now, when you register, update, or reset a customer's password, you can validate it before submitting the customer's desired password to the BigCommerce Platform.

Bug Fixes

• Added an expiration time for the cart redirect URL.

• Added missing information to product.yml and price.yml theme objects.

• Corrected Add Discount to Checkout request body example.

• Added an expiration time for the PAT token. See the Authorization header for details.

API

• We’re happy to announce the ability to apply multiple coupons on a cart using the Checkout V3 API.

• Batch metafields now include date_created and date_modified parameters. You can view this change for the following metafields:

  • Brand Batch Metafields

  • Categories Batch Metafields

  • Products Batch Metafields

  • Product Variants Batch Metafields

  • Customers Batch Metafields

  • Orders Batch Metafields

  • Channels Batch Metafields

  • Carts Batch Metafields

  • Locations Batch Metafields

GraphQL

• We are excited to announce that we have released a new geography node to the Storefront GraphQL API. Now, you can query an unfiltered list of countries.

Bug Fix

• Removed duplicate location_id parameter in locations.v3.yml. Thank you @smcc-riccardoc.

Themes

• We are happy to announce the newly released storefront selector feature in Stencil themes. Shoppers can now choose which storefront they want to browse when they visit your storefront.

GraphQL

• The Storefront GraphQL API now includes a statusMessage field under the Settings schema type. You can now have a customer-facing message associated with the current storefront status.

Bug Fixes

• Clarified the need for Stencil CLI, a local session, and a CSRF token to perform Checkout Storefront API requests.

• Defined the namespace for the GraphQL Create Cart Metafield mutation to alleviate confusion for merchants and developers. Thank you, @harnerdesigns.

• Removed restrictions for scripts on All Pages.

• Removed brand_name from the response body in the REST Management Catalog-Products API.

API

• We added the origin_channel_id to the list of read-only fields in the Customers V3 API. This field is set upon customer creation and cannot be updated afterward.

• The newly released Tax Settings API’s document_submission_strategy field lets you choose when to submit tax documents to third-party tax providers.

• We’re happy to announce the new store/modifier/updated webhook and the store/option/updated webhook, which fires when you update a modifier or variant option globally or for a channel.

• The new store/product/updated webhook fires when you update the product for a channel.

Announcements

• The bigcommerce/docs repo now contains the OpenAPI Specification files for promotions, inventory, locations, and other newer API features!

• The narrative documents’ source file structure in the bigcommerce/docs repo now matches the Dev Center URLs. Finding the document you want to modify is now easier than ever.

• The API reference source file restructure in the bigcommerce/reference repo is in progress. After completion, we will give all API client maintainers enough notice to reset your references.

Bug Fix

• Corrected the request body for the Create Cart redirect URL endpoint. Now, the request body will no longer throw errors.

Bug Fixes

• Corrected and improved Pages V2 (Deprecated) and Pages V3 specification files.

• Corrected and improved Categories and Category Trees specification files.

• Clarified that delivery exception hooks supersede the Get Events (Deprecated) endpoint. Thank you, @cjbarth, for submitting Issue 300.

API

• The Create an order shipment endpoint no longer supports UPSOnline as a shipper.

• The newly-released product review mutation is now available. Now, you can create product reviews through the built-in comment system using the GraphQL Storefront API.

• We are excited to announce Japanese language support. Now, BigCommerce’s Cornerstone Stencil theme supports uneditable strings in Japanese.

• We’ve added a new query parameter, transaction_id, in GET Refunds API endpoints.

• The GraphQL Storefront API now supports creating cart/checkout redirect URLs.

Announcements

• BigCommerce will deprecate support for Stencil CLI version 6 and older starting June 3, 2024. This decision is part of our ongoing efforts to ensure optimal performance and security for all platform users.

  Action required: To facilitate a smooth transition, we encourage you to upgrade to the latest version of Stencil CLI before the deprecation date. Upgrading ensures you and your team access the latest enhancements and features.

  How to upgrade: Run the following command in your terminal window to install the latest version.

  npm i -g @bigcommerce/stencil-cli

  If you have any questions or need assistance with the upgrade process, please don’t hesitate to contact our support team. We’re here to help ensure a seamless transition for your storefront.

• We’ve updated our list of dev support options to include the Resource Hub.

Bug Fixes

• Updated error responses and definitions for brands v3 endpoints.

• Corrected the Create a product variant response body example.

• Clarified the ambiguity around what it means to be a subscriber and added examples of POST/PUT requests for subscribers. See Customers and subscribers for details.

• Updated data type from array to string for the name:link parameter for Get All Price Lists.

• Removed duplicated parameters in the following openAPI operations. Thank you @smack-riccardoc!

  • customers.v3

  • orders.v2

  • themes.v3

  • widgets.v3