Release notes

Enhancements

• Updated the order_source description to be more specific regarding what values you can set for each origin. See the updated description in the response body for Get an order, Get all orders, Create an order, and Update an order endpoints as well as in the request body for Create an order and Update an order endpoints.

• Updated the is_customers_only description in the Pages API documentation to clarify that the page is only visible to logged-in customers.

Bug Fixes

• Added the order_source field as a request parameter for the Create an order and Update an order endpoints.

• Corrected the Update an order request example. Thank you @cjbarth.

• Fixed the rendering of the table in the Get all Order Statuses endpoint.

• Removed a legacy reference from the Using Event Hooks article because it is no longer valid. Thank you @bobmurdoch.

API

• We’re happy to announce the newly released Promotion Settings API.

• The V2 Orders API endpoints now include the is_tax_inclusive_pricing field in the response.

Catalyst

• Added a document about the Catalyst API Client. Learn how to fetch data from BigCommerce’s GraphQL Storefront API in Catalyst.

Enhancement

• Added security requirements developers can implement while creating an app. Now, you can deliver secure apps and keep clients safe. See the Submit your app for approval section for information.

Bug Fix

• Updated the subtotal_ex_tax description and other relevant Order and Product fields to clarify they can’t have a negative value. See Issue-512 for information.

API

• We’re happy to announce that we’ve added the following protected UI sections when you build a storefront channel. You can now include these settings when you create a channel menu: Overview, Localization, Script Manager, Payments, Checkout, Web pages and Data solutions.

• Updated the Form Fields endpoint of the REST Storefront API to include password requirements.

Enhancement

• Update the response schemas for the Checkout endpoints of the REST Storefront API.

Deprecations

• The following Stencil attributes are now deprecated and support for them will be dropped starting June 2025:

  • settings.request.is_crawler

  • settings.request.user_agent

  • settings.client_ip_address

  • settings.is_eu_ip_address

  • settings.region_code

Bug Fixes

• Clarified the text in Working with cart metafields to alleviate confusion. Cart metafields will not work with REST Storefront Carts.

• Clarified the descriptions for parent_id and tree_id in the Catalog > Category trees > Categories endpoints for creating a top-level category.

• Updated the description for is_customers_only in the Pages endpoint.

• Moved the Create a Webhook endpoint to Manage Webhooks (Single) since you can only create one webhook at a time.

API

• The newly-released Customer Segmentation API is generally available (GA) to use.

Stencil

• We updated Stencil React foundation documentation to work with the latest Babel plugin packages. Now, the guidance works for React 18.

Enhancements

• Clarified the role of the is_fallback boolean property of shipping methods, indicating when advanced shipping rules are unavailable.

• Added a Get a favicon example to the storefront example queries article.

Bug Fixes

• Corrected the consent category numbers in the Set Cookie Consent Preferences endpoint.

• Corrected the Content-Type for Catalog V3 image upload endpoints:

  • Create a brand image

  • Create a a category image

  • Create a product modifier image

  • Create a product variant image

  • Create a product image

API

• The Store Information API now includes the infrastructure_region of the store so you can determine the hosted store’s geographical location. This location is helpful when deploying supporting infrastructure for the store so you can deploy it nearby (or in the same GCP region) to minimize latency.

• We recently exposed the added_by_promotion field in the v3 cart and checkout endpoints.

Catalyst

• We’re happy to announce the newly released XML sitemap in Catalyst. You can now submit a complete BigCommerce sitemap to search engines for your Catalyst store.

Payments

• We’re happy to announce the update of the Braintree SDK version from 3.104.0 to 3.106.0 as of 4 PM EEST, September 4, 2024. See the Checkout SDK JS in GitHub for more information.

Bug Fix

• Updated the Create a Channel Site example from HTTP to HTTPS and added a note about using the HTTPS protocol.

API

We’re happy to announce that we have updated the Sites API reference to deprecate the ssl_status field. To determine whether a site uses a private or shared SSL, retrieve the status from the Site Certificate endpoint instead.

B2B

B2B Editions’s API reference documentation has now been moved into our Developer Center to provide a faster, more consistent experience for developers creating future B2B experiences. If you run into anything that we can improve, let us know!

Theme

The Stencil CLI tunnel option now contains a password field implemented by the tunnel provider to prevent abuse by malicious parties. Thank you, Jordan Ramsay.

Bug Fixes

• Added custom_provider_field_result to the response for the Get Order Transactions endpoint.

• Updated schema and query parameters for Storefront Carts endpoints.

• Added a sku_id field to the response for the Get Inventory at Locations endpoint.

Payments

• We are happy to announce the update of the Braintree SDK version from 3.95.0 to 3.104.0 as of 4 PM EEST, August 22, 2024. See the Checkout SDK JS in GitHub for more information.

API

• Updated the Create a Refund Quote endpoint of the Refund API to support product refund deductions

Enhancements

• Added undocumented webhook event types to webhook callbacks.

Bug Fixes

• Corrected the following endpoints:

  • Get Inventory at Locations

  • Get Store Information

  • Order Products

  • Order Shipments

API

• We are happy to announce that the Cart and Checkout API now supports optimistic concurrency control. This feature helps prevent lost updates caused by concurrent requests overriding changes made by others. If the version number provided by an API client does not match the version on the server, the request will be rejected, allowing the client to handle it accordingly.

• We added new formats for product codes upc, mpn, and gtin for Catalog V3 Products and Product variant APIs.

Themes

• Updated the Product Recommendations (Beta) docs. We now have reference code for Cornerstone available to modify your Stencil theme when you request recommendations.

Bug Fixes

• Corrected the Updated an order endpoint to specify that we remove discounts from line items changed in the request, not the whole order.

Enhancements

• We created a Create a Bulk Pricing Rule endpoint for our documentation. Thanks @altugyavuz7.

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.