Latest updates

API Updates and Announcement for April 25, 2024

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

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

API
Announcement
Developer Blog
GraphQL
Webhooks

API Updates for April 18, 2024

API

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

API

API Updates for April 11, 2024

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.

Bug Fix

API Updates for April 4, 2024

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

Bug Fix

API
Stencil
Bug Fix

API Updates for March 28, 2024

API

Bug Fixes

API
Bug Fix

API Updates for March 21, 2024

Bug Fixes

Bug Fix

API Updates for March 14, 2024

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

API
Bug Fix

API Updates for March 7, 2024

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

Bug Fix
Developer Blog

API Updates for February 29, 2024

API

  • Added the MPN filter attribute to Catalog Products endpoints. Thank you, Andrew Barber, at Space 48, for submitting Issue 126.

  • Added recommendations for cursor-based pagination when iterating over a large number of coupons.

  • The Big Open Data Layer now includes two newly-released events, load and update shopper consent. Now, you can send these events to 3rd-party analytics providers.

Bug Fixes

  • Resolved incorrect variants array schemas in the Product Variants and Products endpoints.

  • Added a missing field for the custom_url object schema for the Update a Product endpoint.

  • Updated the url_zoom description to include the maximum image size for the Catalog Products endpoints.

  • Fixed the description about option type set by default from radio buttons to rectangles in the Create variant using the product endpoint operation.

  • Clarified the need to include a cart’s entityID when using the getCart query with customer impersonation tokens.

API
Bug Fix

API Updates for February 22, 2024

API

  • Added the date_last_imported field to the product model. The field format is a nullable datetime string (e.g., “2024-01-24T14:36:56+00:00”). The field is modifiable and filterable.

  • We’re happy to announce that you can add a set of query_parameters to the Create Cart Redirect URL when redirecting the shopper. For example, specifying query_params =[“utm_source” => “mailchimp”] in a request captures the utm_source parameter. When the shopper clicks on the redirect URL to proceed to the checkout page, the appended link will appear as /checkout?utm_source=mailchimp.

Bug Fixes

  • Renamed the “Get All Metafields” reference titles to be more relevant to the resource type you want to retrieve and to prevent duplicate names across different schemas.

  • We’ve updated the Creating Channels section of the Headless Guide to provide more clarity around the order of the steps in the channel creation process.

  • The correct schema is now available for Create a Refund. Previous Request Body and Response Body examples displayed reason in the order level and items level.

  • Added titles to Catalog response schemas. These changes will make return types more readable for users using our docs to generate clients.

  • Changed primary_images to primary_image for the include query parameter for the Category API’s Get All Products endpoint.

API
Bug Fix
Did you find what you were looking for?