The shipments data model defines every field associated with shipments. Shipments are included in order data. When an order is imported, the connector populates the fields associated with shipments. When the order(/shipment) is exported from Connect, each of those fields is mapped to its counterpart in the external platform.
The data model gives insight into the data saved with each stock update and what data is available for rule building.
In this article you will learn more about:
Data model
| Field | Description | Example of input | Required |
|---|---|---|---|
| Shipments.*.Identifier | ID of shipment | "U230015275" | Yes |
| Shipments.*.Provider | Provider of shipment | "other" | |
| Shipments.*.ServiceLevel | Service Level of shipment | "1109" | |
| Shipments.*.TrackingCode | Tracking code | "05162023227429" | |
| Shipments.*.TrackingUrl | Tracking URL | "https://postnl.nl/shipments/..." | |
| Shipments.*.ShipmentDate | Stock status | "2025-03-29T00:00:00+00:00" | |
| Shipments.*.AddedTo | Array of connector configuration IDs that this shipment has successfully propagated to | "ee666a17-0532-43c0-9460-2e7171fe8579" | |
| Shipments.*.Meta | Meta data for shipment | differs per connector |