Dev Center Updates

API Updates for July 25, 2024

2024-07-25T16:57:07.012Z

API

Storefront GraphQL Order capabilities are now available to the public. You can now perform queries that fetch a customer's order history and a specific customer order and access order details. See a list of examples in GraphQL Storefront API: Customers and try them in the BigCommerce GraphQL Playground.
Updated the Get Theme Regions endpoint to include a channel_id query parameter.

Payments

We're happy to announce that we added TD Online Mart to the list of compatible payment gateways for Stored Instruments and Raw Card Data.

Bug Fix

Removed a sentence from the Delete Checkout Consignment endpoint description regarding removing the cart from its assigned customer after deleting a checkout's last consignment. This sentence is inaccurate.

Developer Blog

API Updates and Announcement for July 18, 2024

2024-07-18T17:04:29.542Z

API

Apps compatible with multi-location inventory use our Inventory API for inventory adjustments. Now, you can indicate whether an app is MLI-compatible when you submit an app in the Dev Portal. See the Add supported features section for more information.

GraphQL

We're happy to announce that you can now create GraphQL Storefront API Tokens that are valid for multiple channels. For more information, see Create a Storefront API token and Create a Customer Impersonation Token.

Announcement

We removed the API rate limit content from the Best Practices section to streamline documentation and improve clarity for developers. API Rate Limits documentation now exists as its own reference article and dives deeper into API rate limit standards and best practices.

Bug Fix

Removed all pagination objects and replaced them with an empty meta object for the Get all themes endpoint.

API Updates for July 11, 2024

2024-07-11T17:01:43.247Z

API

We're happy to announce the ability to query product videos using the storefront product graph.
We have updated the API rate limits documentation, adding new methods for handling limits and optimizing requests.

GraphQL

The GraphQL Storefront API's newly released CustomersSettings node has password complexity requirements that are now available. Now, when you register, update, or reset a customer's password, you can validate it before submitting the customer's desired password to the BigCommerce Platform.

Bug Fixes

Added an expiration time for the cart redirect URL.
Added missing information to product.yml and price.yml theme objects.
Corrected Add Discount to Checkout request body example.
Added an expiration time for the PAT token. See the Authorization header for details.

API Updates for June 27, 2024

2024-06-27T16:53:37.692Z

API

We’re happy to announce the ability to apply multiple coupons on a cart using the Checkout V3 API.
Batch metafields now include date_created and date_modified parameters. You can view this change for the following metafields:

GraphQL

We are excited to announce that we have released a new geography node to the Storefront GraphQL API. Now, you can query an unfiltered list of countries.

Bug Fix

Removed duplicate location_id parameter in locations.v3.yml. Thank you @smcc-riccardoc.

API Updates for June 13, 2024

2024-06-13T17:49:30.036Z

API

We added the origin_channel_id to the list of read-only fields in the Customers V3 API. This field is set upon customer creation and cannot be updated afterward.
The newly released Tax Settings API’s document_submission_strategy field lets you choose when to submit tax documents to third-party tax providers.
We’re happy to announce the new store/modifier/updated webhook and the store/option/updated webhook, which fires when you update a modifier or variant option globally or for a channel.
The new store/product/updated webhook fires when you update the product for a channel.

Announcements

The bigcommerce/docs repo now contains the OpenAPI Specification files for promotions, inventory, locations, and other newer API features!
The narrative documents’ source file structure in the bigcommerce/docs repo now matches the Dev Center URLs. Finding the document you want to modify is now easier than ever.
The API reference source file restructure in the bigcommerce/reference repo is in progress. After completion, we will give all API client maintainers enough notice to reset your references.

Bug Fix

Corrected the request body for the Create Cart redirect URL endpoint. Now, the request body will no longer throw errors.

API Updates and Announcements for May 30, 2024

2024-05-30T17:59:17.431Z

API

The Create an order shipment endpoint no longer supports UPSOnline as a shipper.
The newly-released product review mutation is now available. Now, you can create product reviews through the built-in comment system using the GraphQL Storefront API.
We are excited to announce Japanese language support. Now, BigCommerce’s Cornerstone Stencil theme supports uneditable strings in Japanese.
We’ve added a new query parameter, transaction_id, in GET Refunds API endpoints.
The GraphQL Storefront API now supports creating cart/checkout redirect URLs.

Announcements

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.

We’ve updated our list of dev support options to include the Resource Hub.

Bug Fixes

Updated error responses and definitions for brands v3 endpoints.
Corrected the Create a product variant response body example.
Clarified the ambiguity around what it means to be a subscriber and added examples of POST/PUT requests for subscribers. See Customers and subscribers for details.
Updated data type from array to string for the name:link parameter for Get All Price Lists.
Removed duplicated parameters in the following openAPI operations. Thank you @smack-riccardoc!

API Updates for May 9, 2024

2024-05-09T17:36:49.378Z

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 Updates for May 2, 2024

2024-05-02T17:59:56.506Z

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:

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 Updates and Announcement for April 25, 2024

2024-04-25T17:59:03.073Z

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

API Updates for April 18, 2024

2024-04-18T16:55:11.507Z

API

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