JSON-REST Interfaces

Catalog of JSON-REST interfaces for export and import in the BE-Commerce module.

Purpose

This page is the entry point for JSON-REST interfaces in the BE-Commerce module.

Scope

  • Export endpoints for master data, prices, inventory, and status information
  • Import endpoints for sales orders, contacts, returns, and reservations
  • Consistent conventions for filters, request payloads, and responses

Guardrails

  • Slugs and endpoint names remain ASCII and consistent.
  • Required filters (for example webshop channel code) are mandatory per endpoint.
  • Payload changes must be aligned with webshop integration and downstream processes.