Appearance
Retrieve orders ​
A retrieve orders flow returns orders on demand without storing the retrieved data in OCP. It is intended for near real-time order lookup scenarios where the source system remains responsible for delivering the latest order data.
Flow setup ​
The retrieve orders flow has exactly one source. It does not support enrichment steps or export destinations.
| Source | Description |
|---|---|
| Current data | Maps the intake orders already stored in OCP to the retrieved-order representation. |
| Connector | Calls the configured order connector and maps the connector response to the retrieved-order representation. |
WARNING
Only one source can be configured. The flow can use either current data or one connector, not both.
Current data source ​
When current data is selected, OCP reads the existing intake orders from the database and maps them to retrieved orders. The order code is selected in this order:
- ERP order number
- ERP order ID
- External ID
- OCP order ID
This source is useful for testing or for administrations where the OCP database is the desired lookup source.
Connector source ​
When a connector source is selected, OCP calls the connector at request time. The connector is responsible for returning the latest order data and for providing a near real-time experience.
The retrieved data is mapped into a simple order shape with:
| Field | Description |
|---|---|
| Order code | The external order identifier used for list and detail lookup. |
| Attributes | Connector or source-specific order properties. |
| Order lines | External order lines with a line code and line attributes. |
Error handling ​
If the retrieve orders flow is not configured, order retrieval returns a bad request response with setup guidance. Configure the flow before using retrieve-order capabilities.
INFO
Retrieved connector orders are not saved in the OCP database. If persistence or export tracking is needed, use the regular order intake and order export capabilities.