The API integration of ICS is based on two fundamental operations: sending scan orders to ICS and retrieving the inventory documents generated after scanning.
General flow:
/DataExchange/TR/Orders/Create/DataExchange/TR/Stocks/GetExportFor general information about the API (authentication, versioning, document structure), see the API General Guidelines section of the Integration chapter.
Each type of order generates a specific type of stock document:
| Order | Code | Generated stock document | Code |
|---|---|---|---|
| Shipping Order (Online) | O-ONL | Shipping (Online) | S-ONL |
| Shipping Order (Transfer) | O-MG | Shipping (Transfer) | S-AV |
| Order Reception (Warehouse) | O-GNI | Reception (Warehouse) | GNI |
| Order Reception (Online Return) | O-ROL | Reception (Online) | S-ROL |
| — (no order) | — | Orderless shipping | S-AVS |
These are the usual types of documents. Additional types can be added depending on business needs.
| Operation | Scan Type | Description |
|---|---|---|
| Expedition | Guided | Only the items in the order can be scanned, in equal or smaller quantities. The scanner guides the operator through items and locations |
| Reception | Guided | The operator is not restricted to the order document — can scan different quantities |
| Free shipping | Unguided | Can scan any item with no ordering restrictions |
The complete list of configured document types can be obtained by:
GET /DataExchange/TR/Lists/Documents
Each document type is assigned to a specific workflow. The server and scanner interact differently with each document, depending on the process flow and settings configured.
<!-- SCREENSHOT: API Flow Chart — Orders → Scan → Stock -->