Release notes

API

• The REST Management API’s Update a checkout endpoint allows you to add a custom shipping method to the consignment ID. This feature allows you to create a manual order using this shipping method.

Bug Fixes

• We corrected our authentication documentation because the Customer login API had the wrong information for token creation. Users need store-level access to create a token. You must install the app on the store before creating a JWT.

• Added missing order_level_refund_amount field to the Create a refund quote response.

• Clarified the relation between the amounts needed to complete the refund in the Create refund quote endpoint.

Developer Blog

• Revolutionizing B2B Ecommerce: BigCommerce's B2B Edition Open Source Buyer Portal

API

• The newly released SRI hash feature is now available to use. Now, you can add SRI hashes to external SRC scripts.

• We’re happy to announce the include_fields query parameter on batch metafields, which can help you query specific enum fields. 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

Payments

• We're pleased to inform you that PayPal (Commerce Platform) now supports the storage of PayPal accounts with Braintree. This update brings added convenience and ease to your payment processes.

Bug Fixes

• Replaced the incorrect currency code in the Create a cart endpoint so merchants can use the sample code for Carts with 'custom item' without encountering an error.

• Fixed a broken category assignments link on the Channel webhooks page.

• Removed an incorrect statement in the Create cart redirect URL usage notes. You can create redirects for any cart, including one created with the GraphQL Storefront API.

• Fixed an incorrect example on the Update instruments endpoint.

API

• We’re happy to announce Promotions API is Generally Available (GA).

• The GraphQL Storefront API now supports cart metafields.

• Added a Localization document that describes how to localize a Catalyst storefront.

Webhooks

• The newly-released delivery exception webhook alerts users of delivery issues at their primary delivery destination.

Announcement

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.

Developer Blog

• Navigating the End of Third-Party Cookies: A Guide for BigCommerce App Developers

• Harness the Power of the Promotions API: Now GA!

API

• The newly updated store/order/transaction/created webhook allows you to receive data for transaction_status, transaction_type, and result attributes.

Bug Fixes

• Updated the Webhooks Tutorial to change ngrok installation instructions.

• We’ve updated the cost_price field description to include how this field displays in the UI. See this field in the Create a Product Variant endpoint. Thank you, Pranay-Kumar-16, for bringing this issue to our attention.

API

• Merchants can now select which regions they want to use an automatic tax provider. To learn more about the new merchant flow, see configuring tax providers in the Tax Provider API doc.

Stencil

• Updated stencil category shop_by_price.yml description to include new functionality.

Bug Fix

• Removed duplicate listing of “Store Address” in Store information updated events.

API

• Added an End-to-end Guide for Headless checkout flow with the GraphQL Storefront API to describe how to work with shopper interactions on headless storefronts.

• The Management Checkout API now supports item-level and cart-level discounts.

• Updated the number of allowed domains for CORS to 2 for the GraphQL Storefront Tokens Create a Token endpoint.

Bug Fixes

• Revisited out-of-date screenshots in the Publishing an App article to provide the correct steps to certify an application.

• Made state_or_province required in the Add Consignment to Checkout and Create a Customer Address endpoints.

Bug Fixes

• Added missing fields (is_active and updated_at) to Get all themes and Get a theme endpoints.

• Added the missing consents array to the Subscribers API endpoints.

API

• The newly released price list and price list records webhooks are now available. Now, you can add events and use batch price lists and price list record events where appropriate.

• Added BigCommerce terms of service and privacy policy to endpoints, which included adding a product video, such as Create a Product Video.

• Updated the Create Categories endpoint to auto-generate category URLs from the category name when you don’t provide the URL.

• BigCommerce’s Storefront GraphQL now supports customer-specific mutations in a beta release. Access to customer data in the graph makes it easier for front-end developers to create customer-specific experiences for their headless storefronts as guest shoppers transition to registered customer accounts.

  Key use cases now supported by customer mutations are:

  • Register a Customer

  • Update a Customer

  • Add a Customer Address

  • Update a Customer Address

  • Delete a Customer Address

  • Change Password

  • Request a Password Reset

  • Reset Password

Bug Fixes

• Fixed incorrect schemas for the Create batch of price lists records endpoint. The previous schema returned a 400 response.

• Clarified vague text about the availability of stored PayPal accounts versus general wallet availability in the Payments API Overview.

• Fixed incorrect formatting of the example error message for GraphQL complexity limits.

Bug Fixes

• Updated the discount_amount definition in Checkout Coupons endpoints.

• Corrected the shipping consignment example in the Add Consignment to Checkout endpoint.

• Corrected the type for external_order_id query parameter in the Get All Orders endpoint.

• Added “read-only” and removed the enum of accepted values for tax_provider_id on OrdersV2 Create/update.

• Fixed a bug that shows duplication of default_currency_code and billing_address fields in the OrdersV2 API response body.

• The variants collection of product nodes now contains an SKU filter to filter the collection of variants by one or more SKU codes.

• Removed contradictory information regarding adding YAML front matter to the templates/pages subdirectory. Thank you Matt Coy from Arctic Leaf for assisting with this issue.

• We’ve updated the blog feature specification in Store Content to note that the is_published field defaults to false on both POST and PUT. Pass true to avoid reverting the post to draft status.

• We’ve clarified that some 422 errors in calls to the Channel Listings feature of the Management API include a group_id, which is the same as the listing_id of the request.

• We’re continuing to convert query params that provide comma-separated lists to unexploded form-style arrays, making generated API clients more efficient.

Developer Blog

• Composable Integration Series: Catalyst X Algolia