Skip to navigation

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-level message field. The quote, order, and shopping list reference pages now show this. Storefront API responses still use a top-level message.
  • Response shapes. List Quotes returns data as an array of quotes, with pagination in meta. Get Order and Update Order return a single order object in data, not an array.
  • Channel errors. The channel endpoints return 422, not 403, when multi-storefront is not enabled. Errors include data.errMsg and meta.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 matching fieldType. The order reference also fixes the field name listOfValue, and the Storefront quote reference fixes numberOfRows and documents extraFieldsInfo as 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} and store/store/metafield/{created,updated,deleted} fire when customer-level or store-level metafields change. Both support data filtering on namespace.
  • Redirects. store/redirects/updated fires when you create or update redirects. The data field is an array with one entry per redirect, and id is 0 when the request doesn’t include a redirect ID.
  • Location deleted. store/inventory/location/deleted fires when a location is deleted.
  • Channel settings. store/channel/{channel_id}/settings/search/updated and store/channel/{channel_id}/settings/inventory/updated fire when a channel’s storefront search or inventory settings change.
  • Order notification settings. store/channel/{channel_id}/notifications/order/updated fires 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.