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.
Links
Further Information
First Endpoints
- Export Item
- Export Item List
- Export Price
- Export Inventory
- Export Inventory Item List
- Export Contact
- Export Contact Status
- Export Location
- Export Vendor
- Export Webshop Category
- Export Item Description
- Export Order Status
- Export Sales Order History
- Export Document Status
- Export Dynamic Attributes
- Export Branch Inventory Item Variant List
- Export Branch Inventory
- Export Free Text Attributes
- Import Sales Order
- Import Contact
- Import Return
- Import Reservation