Release notes
Your bookmark friendly source for BigCommerce platform updates and enhancements.
Latest updates
API Updates for November 7, 2024
API
We’re happy to announce that you can create shipping methods specific to a storefront channel to help you localize your storefront when selling internationally and across customer segments.
We’ve added a
fee
item type to Refund endpoints of the Orders API to represent order-level fees like package insurance, gratuities/tips, and credit card fees. To see an example request, see Creating refund quotes.Configuring the headless checkout URL with
www_redirect
settings is now available using the Settings API.
Catalyst
We’ve integrated Customer Access Tokens into the
main
branch of the Catalyst repository.
Enhancements
Added documentation surrounding the multiConcat handlebar helper. Thanks, Andrew Barber.
Added the security.md file so security researchers know where to report a vulnerability found on this repository.
Added a note to clarify that orders created through the V2 Orders API will not result in an order notification email being sent to the customer.
Added a note to clarify that
total_sold
on products for imported orders will remain unaffected if theexternal_source
value is M-MIG.Updated the required node and npm versions for Installing Stencil CLI to 20.16.0.
Added introductory information to the Settings API documentation.
Bug Fix
We replaced the
code
field withpaymentCode
in the Get Payments of Store B2B endpoint response body. Thank you, bbogovich-vs.
API Updates for October 31, 2024
API
Added an optional
token
field in the storefront Create a Customer request body.Added an
order_pickup_method_id
field to the Get All Order Taxes endpoint.
Enhancements
A
phone:in
query parameter was added to the Get All Customers endpoint.New query filters were added to the Get Redirects endpoint.
Reordered sections in the Customizing invoices article to increase readability.
Bug Fixes
Added the missing
giftcertificate
option for thetype
field in the List Order Products endpoint.Corrected
purchase_date
andexpiry_date
date formats in the Gift Certificate API response examples.Updated the example queries in the GraphQL Storefront API Orders (Beta) article.
Corrected inaccurate examples and request fields for the Create a Product Image endpoint.
Developer Blog
API Updates for October 24, 2024
API
Store metafields are now available to use. Add metafield data to a merchant’s store using this set of APIs. Metafields can be created, updated, and deleted on stores.
We’re happy to announce that trusted proxy enablement is available for headless merchants and merchants behind a proxy.
Added the
trigger_account_created_notification
field as a request parameter for the Create Customers endpoint.We’ve added
country_code
(alpha-2) to the /v3/pricing/products endpoint in support of tax geolocation for shoppers outside the default tax zone.
Enhancements
Added a 422 error response body to the Create Channel Menus endpoint.
Added additional query parameters to the Get Subscribers endpoint.
Added default and alternate behavior information to the Locations article.
Added details to the Create Order Shipment endpoint regarding
tracking_carrier
.
API Updates for October 17, 2024
Enhancements
Clarified the need to enter a JSON formatted string for Shipper HQ metafields for product metafields and product variant metafields.
Added error codes to the Get all customers and Delete customer endpoint descriptions. Thank you @sshaw.
Bug Fix
Removed brackets to correct the Update a metafield request body for the Customers V3 API.
API Updates for October 10, 2024
API
The Upsert Customer Form Field Values endpoint is now deprecated. Use Update a Customer Address and Update Customers endpoints instead.
Developer Blog
API Updates for October 3, 2024
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 Updates for September 26, 2024
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 Updates for September 19, 2024
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
andtree_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 Updates for September 12, 2024
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: