Logistics systems of record
Order, transport, warehouse, yard and inventory management systems are read by one REST implementation, parameterised by system. Across these systems, what differs is the default resource and the vendor’s paging and filter dialect. Those differences are data, not separate connectors.
Systems and type spellings
| System | Type spellings | Default resource | Changed-since parameter | Default lookback |
|---|---|---|---|---|
| OMS (orders) | oms, ordermanagement | orders | updatedSince | 1,440 min |
| WMS (warehouse) | wms, warehousemanagement | inventory | modifiedAfter | 240 min |
| WHS (warehouse receipts) | whs, warehouse | receipts | modifiedAfter | 1,440 min |
| YMS (yard) | yms, yardmanagement | appointments | updatedSince | 720 min |
| TMS (transport) | tms, transportmanagement | shipments | updatedSince | 1,440 min |
| IMS (inventory) | ims, inventory, inventorymanagement | inventory | modifiedAfter | 240 min |
| FMS (fleet) | fms, fleetmanagement | assets | modifiedAfter | 1,440 min |
| DPS (demand planning) | dps, demandplanning | forecasts | updatedSince | 10,080 min |
| RPS (route planning) | rps, routeplanning, routeoptimization | routeplans | updatedSince | 1,440 min |
| UAS (drone fleet) | uas, drone, dronefleet | missions | updatedSince | 240 min |
| Generic | logisticsapi, logistics | from system | — | — |
With the generic logisticsapi type, the system comes from the config’s
system field. The default paging parameters are limit, offset and cursor.
Provider dialects
Setting provider changes the paging and changed-since parameters:
provider | Changed-since | Page size | Offset / cursor |
|---|---|---|---|
project44 | updatedAfter | perPage | offset |
fourkites | since | page_size | page_token |
manhattan | lastUpdatedSince | size | page |
blue_yonder | modifiedSince | pageSize | — |
ibm_sterling | modifyTsFrom | maximumRecords | — |
netsuite | lastModifiedDate | limit | offset |
oracle | LastUpdateDate | limit | offset |
generic or empty | the system’s defaults |
Settings (LogisticsAPIConnectionConfig)
| Setting | Meaning |
|---|---|
system | oms, wms, whs, yms, tms, ims (and the other systems above) |
provider | The vendor dialect (see above) |
base_url | An http:// or https:// URL. Required. |
resource | The resource path to read. Empty uses the system default. |
site_id | Warehouse, yard or DC scope |
auth_mode | api_key (default), bearer, basic, oauth2_client_credentials or none |
api_key_header | The API-key header. Default X-API-Key. |
token_url, scope | For oauth2_client_credentials |
page_size | Default 200, maximum 1,000 |
max_records | Default 5,000, maximum 50,000 |
lookback_minutes | Changed-in window. Default is per system, maximum 90 days. |
Older connections that were stored with the per-system messages
(OMSConnectionConfig, WHSConnectionConfig, TMSConnectionConfig,
YMSConnectionConfig, InventoryConnectionConfig) are still read:
- Their
base_urlis used. system_typeorproviderbecomes the provider.warehouse_idoryard_idbecomes the site.
Every setting can also be given as a connection property (base_url, resource,
site_id, provider, auth_mode, …).
Credentials by auth_mode
auth_mode | Credential keys |
|---|---|
api_key | api_key (also apikey, token, access_token), sent in api_key_header |
bearer | token (also bearer_token, access_token, api_key) |
basic | username and password |
oauth2_client_credentials | client_id and client_secret. The token is cached until shortly before it expires. |
none | — |
Behaviour
- Test requests the target resource with a page size of 1, within 15 s. A success means the API answered and accepted the credential.
- Execute pages through the resource:
- Within the record cap, at most 200 pages, and a 3-minute budget.
- Each page is capped at 16 MiB.
- Redirects are followed on the same host only, up to 5.
- Rows are the records as the API returns them. The columns are the union of
fields seen across the rows. An empty result is reported as
Success=false:<SYSTEM> connector reached … and received no records.
- Explore returns
supported=false. These systems publish no common catalogue. - Internal addresses are allowed by default. Set
allow_internal_network=falsefor a public API.