B2B Edition API reference corrections
Corrected B2B Edition reference pages that did not match what the API returns. The API itself is unchanged; the pages now describe the responses you already receive.
- Management API success messages. Management API responses return the status message in
meta.message, not in a top-levelmessagefield. The quote, order, and shopping list reference pages now show this. Storefront API responses still use a top-levelmessage. - Response shapes. List Quotes returns
dataas an array of quotes, with pagination inmeta. Get Order and Update Order return a single order object indata, not an array. - Channel errors. The channel endpoints return
422, not403, when multi-storefront is not enabled. Errors includedata.errMsgandmeta.message. - Extra field configurations. The extra field configuration endpoints for users, addresses, Companies, orders, invoices, and quotes now document
labelName. Limit fields (maximumLength,numberOfRows,maximumValue) are strings, and each appears only for its matchingfieldType. The order reference also fixes the field namelistOfValue, and the Storefront quote reference fixesnumberOfRowsand documentsextraFieldsInfoas an array.
If you built against these pages, recheck how you read response messages, status codes, and extra field limits:
More webhook events in the event reference
The webhook event reference now documents several scopes you could already subscribe to, along with their payloads.
- Customer and store metafields.
store/customer/metafield/{created,updated,deleted}andstore/store/metafield/{created,updated,deleted}fire when customer-level or store-level metafields change. Both support data filtering onnamespace. - Redirects.
store/redirects/updatedfires when you create or update redirects. Thedatafield is an array with one entry per redirect, andidis0when the request doesn’t include a redirect ID. - Location deleted.
store/inventory/location/deletedfires when a location is deleted. - Channel settings.
store/channel/{channel_id}/settings/search/updatedandstore/channel/{channel_id}/settings/inventory/updatedfire when a channel’s storefront search or inventory settings change. - Order notification settings.
store/channel/{channel_id}/notifications/order/updatedfires when a channel’s order notification settings change.
For details, see the customers, stores, redirects, and locations events, and the channel settings and channel notifications events.