API Updates and Announcement for August 1, 2024

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.