The response structure of included consignment resources in the Get an Order and Get All Orders endpoints will change on February 1, 2025. If you add include=consignments
or include=consignments.line_items
to the request parameters, please update integrations to read the new structure specified in the documentation. Currently, the response structure for these resources is as follows:
{
consignments: [{
pickups: [...],
shipping: [...],
downloads: [...],
email: {...}
}],
}
After February 1, the response structure for these resources will be as follows:
{
consignments: {
pickups: [...],
shipping: [...],
downloads: [...],
email: {...}
},
}
If you wish to opt in to this change early, please include the following flag in your request: consignment_structure=object
API
We are excited to announce a new form of authentication for our GraphQL Storefront API which improves our security posture and solves session synchronization issues with headless checkouts. The customer access token offers the following benefits:
Logged-in customers maintain their login state through to checkout (without having to use the Customer Login API).
A synchronized session between storefront & checkout; logging out in one place will log you out in both places.
Support for more security-sensitive features we will add to Catalyst in the future, such as Saved Payment Methods.
GraphQL
We are happy to announce that HTTPS webhooks are now manageable with Admin GraphQL APIs.
Improvements
Clarified the accepted Tax Provider API quote ID values and usages.
Bug Fixes
Fixed a bug to indicate that the Update a channel endpoint does not support restoring a channel to prelaunch
status. Thank you @mattcoy-arcticleaf
Fixed incorrect schema for the Create Batch Price Lists Records endpoint.
Removed invalid event store/order/transaction/updated
from the Callbacks documentation.
Updated and fixed missing attributes in the Callbacks documentation.
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.
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.
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.
We are happy to announce the newly released storefront selector feature in Stencil themes. Shoppers can now choose which storefront they want to browse when they visit your storefront.
GraphQL
The Storefront GraphQL API now includes a statusMessage
field under the Settings schema type. You can now have a customer-facing message associated with the current storefront status.
Bug Fixes
Clarified the need for Stencil CLI, a local session, and a CSRF token to perform Checkout Storefront API requests.
Defined the namespace for the GraphQL Create Cart Metafield mutation to alleviate confusion for merchants and developers. Thank you, @harnerdesigns.
Removed restrictions for scripts on All Pages.
Removed brand_name
from the response body in the REST Management Catalog-Products 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
]]>Hi Devs! We added a submitContactUs mutation to our GraphQL Storefront API, enabling a frontend customer feedback experience. This feature relies on reCaptcha for security and requires the customer to supply, at minimum, an email and comments. It also supports optional fields such as fullName, phoneNumber, orderNumber, companyName, and rmaNumber. This mutation also provides descriptive results for errors that can occur, including the failing field, what caused the error, and a description of the error. For more details, see the GraphQL Storefront Playground for your store or sandbox and experiment with the submitContactUs mutation.
Bug Fix
Fixed a typo in Deprecation and Sunset Support for Node-sass. Now, you can see potential changes and reevaluate changes by running the following commands.
stencil scss-autofix --dry
stencil scss-autofix
Happy to announce rate limits are now available for the Create a Customer Address endpoint.
The Carts and Checkout Storefront APIs now allow adding, updating, and deleting gift wrapping to lineItems similar to the REST Management APIs.
Deprecated the view_count
field for products in the Catalog API to improve platform performance.
The newly released Delete Locations endpoint of the Locations API allows you to delete locations that do not have open transaction associated with them. Now you can remove an incorrectly added location or a location that is interfering with a workflow.
Bug Fix
Fixed a GraphQL bug related to price fields displaying even when Show Product’s Price is disabled in the Settings>Display>Product Settings section of the control panel.
General availability for GraphQL Storefront API.
Added redirects V3 import-export functionality.
Added Universal Analytics to the list of deprecations.
Updated the Request shipping rates response body documentation to clarify that the discounted_cost
field is optional.
Stored Payment Instruments is now open beta.
The Update Cart Line Item endpoint can now update or delete an existing GiftWrapping.
Added Best Practices for API Integration Design article.
Added Keyword Search and View Banner event schemas to BODL.
Announcements
We are implementing an internal migration for GET v3/catalog/variants endpoint to enhance our API's performance. If you experience any unexpected API behavior on the following endpoint, please check the documentation to ensure all accurate query parameters and API usage.
The BigCommerce DevX team is pleased to announce the launch of a new GraphQL Storefront Playground. We’ve made the following improvements:
Add new GraphQL UI
Replace initial tabs with Sample queries navigation to reduce clunkiness
Select queries from samples now auto-populate URL parameters
Add Explorer plugin to help with query construction
Move the URL bar to the bottom right footer
Resolve several UI-related bugs