Release notes
Your bookmark friendly source for BigCommerce platform updates and enhancements.
Latest updates
API Updates for December 19, 2024
API
The newly released custom order level fees are now available for use across both checkout and orders. You can apply and manage the order level fee via the v3 Management API for checkouts and via the v2 Management API for orders. Additionally, you can fetch any applied fees through the Storefront Checkout API.
Enhancements
Added new Stencil CLI options to bundle and push to allow for source map inclusion in theme builds and a new section on theme optimization and source maps. Tools that provide automatic error reporting, session playback, and optimization suggestions can rely on source maps for more readable insight.
Added Get an order metafield and Get metafields for a customer examples to the GraphQL Storefront API: orders(beta) document.
Added additional attributes that trigger a product update webhook.
Added a note to the Add to Cart URLs article to clarify that you need a product ID or SKU in the URL to add a coupon code.
Bug Fixes
Corrected the
discount_rules
array of the v2 Customer Groups endpoint.Updated the maximum characters for an email from 255 to 250 when creating a custom account.
Corrected the
option_values
array in the Product Modifiers endpoints.
Developer Blog
API Updates for December 12, 2024
API
We’ve added a platform limit of 40000 zip-type shipping locations per store. Users can add up to 40000 zip-type locations to their store.
Enhancements
Added information on how to set up an RSS feed for release notes.
Added
CustomerAccessToken
as an optional parameter for the B2B Storefront Token endpoint.Updated the Stencil CLI installation instructions for a Mac.
Clarified the description for the store/product/inventory/order/updated webhook when updating inventory.
Added an example showing how a customer can log in to an embedded checkout using the session-sync URL. See the Customer single sign-on section for details.
Updated the
sku
description for the Catalog Products API to clarify that the SKU has to be unique for products and variants regardless of the letter cases.
Bug Fixes
Removed incorrect required label for
variant_id
from the Create a Cart, Add Cart Line Items, and Update Cart Line Item endpoint.Fixed broken links in the B2B’s Key resources section.
Fixed incorrect link for Orders on the Metafields page.
Developer Blog
API Updates for December 5, 2024
API
We’re happy to announce that you can now retrieve channels to which a product is assigned when you get a product through the Catalog API. You can also filter products by the channel when you Get All Products.
GraphQL
We added the ability to upgrade a guest cart to a customer cart as part of the login mutation. See the Signing customers in section for details.
B2B
The following newly-released B2B endpoints for getting and selecting shipping rates on quotes are available to use.
Enhancements
Added
required
tags to clarify that either a userId or customerId is needed to run the Get Shopping Lists query.Updated the description of
key
in the Widget Template API to prevent confusion.Added a 403 response error code to the Create Promotion endpoint.
Bug Fix
Removed the limit of 40 concurrent requests because only adaptive limits are used for product endpoints.
Developer Blog
API Updates for November 21, 2024
API
We’re happy to announce that you can now use the Admin Graph to filter metafields by their date created or date modified.
Enhancements
Updated the
listPrice
description in Add Cart Line Items and Update Cart Line Items endpoints to reflect that you can change the default behavior in the control panel.Added query parameters to the Get a Count of Orders endpoint.
Added a note clarifying the “amount” should not be added to “item_type”:”PRODUCT” while creating refunds and refund quotes.
Bug Fixes
Corrected the
global.js
file path in the Customizing display text section of B2B Edition for Stencil.Changed the limit of customer widget templates per store to 250. See Definitions for information.
Updated the Delete Pages endpoint to allow the optional query parameter
delete_children
to replicate the same cleanup behavior in the control panel.Removed the incorrect “required” flags for the Update Products(Batch) endpoint to prevent confusion.
API Updates for November 14, 2024
API
We’re happy to announce the new
line_items.coupon_amount
field in the Big Open Data Layer for hosted storefronts, which indicates the coupon amount for a line item in a cart.
Enhancements
Added missing concurrency rate limits to the Update Customers and Upsert Customer Attribute Values endpoints.
Added information to clarify that the Create Cart Redirect URL endpoint only supports carts created using the REST management API or Storefront GraphQL API.
Added a note to clarify that admins are the only role allowed to create API tokens using the B2B Get Server to Server Tokens endpoint.
Bug Fixes
Updated the description for the
company
parameter for the Get Quote Form List endpoint to specify the parameter filters by company name, not company ID.Added the missing
page
parameter and pagination limits to the Get Product Sort Order endpoint and updated the response body.Corrected the Combined order status email object reference schema.
Fixed a bug in the Big Open Data Layer documentation regarding which BigCommerce API field maps to
line_items.discount
.Added the missing Order ready for pickup email template.
Updated the
id
field type from string to integer in the product theme object reference.
Developer Blogs
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.