Skip to main content

Interface Overview

DSOrder exchanges data with the ERP through a REST API. The ERP initiates every call: it pushes sales, stock, promotions, placements and order fulfillment to DSOrder, and polls DSOrder for submitted purchase orders.

Start with Getting Started for authentication, formats and error handling.

Endpoints​

Data flowMethod and pathFrequency
ERP → DSOrderPOST /sales/{date}/{store_id}Daily
ERP → DSOrderPOST /stock/{date}/{store_id}Daily
ERP → DSOrderPATCH /stock/{date}/{store_id}As needed
ERP → DSOrderPOST /promotionsNear real-time
ERP → DSOrderPOST /promotions/articlesNear real-time
ERP → DSOrderDELETE /promotions/articlesNear real-time
ERP → DSOrderPOST /promotions/articles/placementNear real-time
ERP → DSOrderPOST /articles/placementNear real-time
ERP → DSOrderDELETE /articles/placementNear real-time
ERP → DSOrderPOST /orders/{order_id}/fulfillNear real-time
ERP → DSOrderPOST /orders/{order_id}/closeNear real-time
DSOrder → ERPGET /orders/submittedPolled by the ERP (~every 5 min)
DSOrder → ERPGET /promotions/articles/{date}/{store_id}On demand
DSOrder → ERPGET /articles/placement/{date}/{store_id}On demand

Some interfaces reference data created by others. Send them in this order:

  1. Promotions
  2. Promotion Articles — the promotion must exist
  3. Promotion Article Placements — the promotion article must exist

Sales, stock, article placements and order fulfillment have no ordering dependencies between them.