Release notes

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

• 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.

Cornerstone 6.13.0

• Fix HTML markup for product listing and below content region. #2426

• With Product Filtering enabled widgets on the category page disappear after navigating using pagination. #2425

• Update layout with correct usage of main tag. #2421

• Anchor links on category pages are not working when product filtering is enabled. #2415

• Dispatch an event on productOptionsChanged. #2400

• Check lang helpers usage and the existence of a key in translation file. #2403

• Display fees on cart page. #2376

• Replace the Twitter logo with the X logo within social sharing and social link components. #2387

• Added nvm config. #2389

• Displaying the Hidden cart_order_source Input field on the PDP page. #2392

• Videos added through the Product Editor have their thumbnails cropped compared to videos added through the page builder. #2413

• Update Shop By Price Widget. #2408

• ‘Please Select a file’ popup forces the shopper to re-upload the file if the option type is ‘File Upload’ and is set to required. #2409

• Top Global Region Image Widget overlaps the mobile menu. #2402

• Changed default PayPal checkout button color. #2405

• Changed default PayPal checkout button size. #2406

• Change case of Page Builder menu item text. #2407

• Corrected typo with the word default previously deafault in config.json. #2410

• Adding autocomplete to common input fields. #2397

• Pre-Ordered text in Polish looks cropped in the button on Product page. #2414

• Use triple parentheses on the customer’s company name to prevent escaping ampersands. #2399

• Adding aria attributes to cart page coupon code and gift certificate buttons. #2391

API

• The newly-released metafield endpoints are now available to use. Now, you can manage metafields in batches 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

• We’ve updated the Embedded Checkout Tutorial to indicate that the channel_id is a requirement for a Customer Login JWT used in the embedded checkout process.

Bug Fix

• Updated the sale price definition in the Using Catalog Price Objects article due to a bug fix.

API

• Store-level API accounts now have dedicated scopes for working with metafields. These scopes are helpful for API consumers who wish to prevent their metafields from interference.

• We now have more query examples for the Users feature of the GraphQL Account API. Account admins can include collectionInfo and totalItems in your query requests to collect the total number of items in the collection.

• The Get Store Information endpoint now returns information about storefront limits! The new data includes the number of active storefronts and the total number of storefronts, including inactive ones.

• The Get All Orders parameters now include external_order_id. You can add the parameter to your request to include Order IDs from external systems.

• Updated the Delete All Pricelist endpoint’s parameter to include the in value. To run a request to delete multiple pricelists, you must pair the in value with the id value: id:in.

Bug Fixes

• Corrected the option_id type from a number to an integer in option_selections on POSTS Carts V3.

• Removed unused and empty allOf sections in webhooks.v3.yml.

• Added clarity around the usage of stored PayPal accounts.

• We fixed an error in the category attributes schema in the Stencil Front matter reference. Setting product limits should now be clearer!

• We’ve updated the shipping_provider property throughout the Orders V2 specification to allow arbitrary strings. This update better indicates support for new and custom shipping providers and improves API client autogeneration.

• Fixed categories_catalog.v3.yml to ensure it is a valid Swagger format.

• Added some missing title fields to product-variants_catalog.v3.yml and category-trees_catalog.v3.yml API specification.

Bug Fixes

• Added missing category_id in the sample response for the POST /catalog/trees/categories endpoint. Thank you, Aten Software, for your feedback.

• Updated the menu paths for integrating with Disqus for MSF and non-MSF storefronts.

Announcement

BigCommerce for WordPress Plugin Update Required!

We have deployed a fix for a recent vulnerability found with the BigCommerce for WordPress plugin.

To prevent security vulnerabilities, please upgrade your plugin by following the steps below.

1. Navigate to your WordPress website and log in as an admin.

2.  In the sidebar, select "Plugins".

3.  Select the "update now" hyperlink for the BigCommerce for WordPress plugin.

4.  Wait for the upgrade to finish.

Payments

• We’re happy to announce the ability to use stored Braintree ACH accounts in the Payments API. Now customers can store their bank accounts in a BigCommerce store and use it for recurring payments.

• The newly-released Square V2 payment gateway is available for stored instrument data. See the list of compatible payment gateways.

Announcement

• The Dev Center now contains a UX Writing Guide for developers using BigDesign in their apps and implementations. Developers can now make their apps feel more seamlessly integrated into the BigCommerce control panel. Many thanks to the Product Design team for all their work on this!

Developer Blog

• High-Risk Permissions Now Available!

Announcement

• 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

Announcement

• A valued partner has done the heroic work of making the OAS operation IDs programmatic across our public APIs. The operationId property is now consistently camelCase and relates to the plain-language name of the endpoint. You can use operation IDs as basis for the method name in a generated SDK.