Back to Developer changelog

Checkout UI extensions: New Required Cart Instructions API when updating to 2024-07 API Version

API

Effective July 03, 2024

Action required

In the 2024-07 API version of checkout UI extensions, we have introduced a new instructions API. This API will inform checkout UI extensions when a particular extension API is/is not available for the current checkout. For example, if you intend to add a discount code via the applyDiscountCodeChange method, check discounts.canUpdateDiscountCodes to ensure it's supported in this checkout.

All checkout UI extensions updating to 2024-07 will be expected to review the list of APIs that may be restricted, and incorperate fail-safes if a particular API is not available in the current checkout. This will be required for checkout UI extensions to start rendering in draft order invoice checkouts.

For more details, please refer to our 2024-07 update guide for more details and instructions on how to safely update to 2024-07.