Developer docs

Changelog

Changes to the SnowBee Public API and developer documentation.

  • Demand-planning integrations can now see whether each retail store accepts replenishment-parameter uploads through updateFromApi on retail-store and replenishment-parameter responses. Uploads for stores that have not opted in are skipped without error and counted in counts.apiUpdatesDisabled.

  • Public API clients should now limit requests to 500 per minute. Requests above the per-node limit return 429 with Retry-After and rate-limit headers.

  • Catalog searches can now use the repeatable productId query parameter to retrieve known products directly while retaining webshop-assortment filtering.
  • E-commerce inventory and order responses now use each product's resolved consignment or webshop fulfillment warehouse. Order creation returns 409 FULFILLMENT_WAREHOUSE_CONFLICT when inventory-holding lines cannot resolve to one warehouse.

  • Event-notification subscriptions can now choose which subjects they receive independently for Azure Service Bus and webhooks; narrowed subscriptions do not automatically receive subjects added later.

  • GET /products/{productId} now returns an empty localized string for an applicable text attribute with no value instead of failing the product request.

  • Integrators can now receive eCom store event notifications through signed HTTPS webhooks, alongside or instead of Azure Service Bus. Deliveries use the existing event subjects and body format, retry on timeouts or non-2xx responses, and may be delivered more than once.

  • Public API product images now include a nullable productColorId, allowing storefronts to show imagery for the selected colour while treating images without a colour as general product imagery.

  • The experimental GET /store response now includes the store’s loyalty program ID and name, or null when none is configured. Storefronts can match the ID against a customer’s loyaltyPrograms to decide whether member prices apply.

  • Added the experimental GET /products/search endpoint for paginated storefront catalog browsing and search. It returns sellable product summaries with localized dimensions, images, current prices, stock status, filtering, sorting, and opaque cursors.
  • Added experimental cart endpoints for creating and updating carts, applying Snowbee's retail pricing, and checking out a cart into an e-commerce order. Unknown SKUs are rejected with 422, and monetary values are serialized as strings.
  • Experimental carts can now request live-priced delivery options and pickup points, open an Adyen Drop-in payment session, and check out with the selected freight and completed payment. Web-payment stores must complete payment before checkout; changed totals, refused payments, and expired sessions return 422.