Shipments

Per-shipment reads, predictions, and submission.

Served by the gateway at https://api.orderlycore.com under /v1, bearer-authenticated. Use the Try it consoles against the Preview server.

All shipments with filters

GET/v1/network

Requires X-Organization-Id. Live.

Parameters

Name	In	Required	Description
status	query	no
carrier	query	no
zip	query	no
facility	query	no
tracking	query	no
lane	query	no
shipped_from	query	no
shipped_to	query	no
promised_from	query	no
promised_to	query	no
limit	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

400 org_required when the X-Organization-Id header is missing. 401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/network

All shipments with filters

API key (Bearer token)

X-Organization-Id *

status (query)

carrier (query)

zip (query)

facility (query)

tracking (query)

lane (query)

shipped_from (query)

shipped_to (query)

promised_from (query)

promised_to (query)

limit (query)

https://api-staging.orderlycore.com/v1/network

In-transit shipments with predictions + lane geo

GET/v1/live-shipments

Requires X-Organization-Id. Live.

Parameters

Name	In	Required	Description
limit	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

400 org_required when the X-Organization-Id header is missing. 401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/live-shipments

In-transit shipments with predictions + lane geo

API key (Bearer token)

X-Organization-Id *

limit (query)

https://api-staging.orderlycore.com/v1/live-shipments

Scan trail (event sources) for a shipment

GET/v1/shipment-trail

Live.

Parameters

Name	In	Required	Description
tracking	query	yes	Tracking number

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/shipment-trail

Scan trail (event sources) for a shipment

API key (Bearer token)

tracking * (query)

https://api-staging.orderlycore.com/v1/shipment-trail?tracking=1Z999AA10123456784

Full prediction payload (all models)

GET/v1/shipment-predict

Live.

Parameters

Name	In	Required	Description
tracking	query	yes	Tracking number

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "tracking_number": "1Z999AA10123456784",
    "carrier": "ups",
    "predictions": {
      "eta": {
        "predicted_at": "2026-07-23T18:20:00Z",
        "confidence": 0.82
      },
      "sla_breach": {
        "sla_flag": "amber",
        "probability": 0.31
      }
    }
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/shipment-predict

Full prediction payload (all models)

API key (Bearer token)

tracking * (query)

https://api-staging.orderlycore.com/v1/shipment-predict?tracking=1Z999AA10123456784

Re-run scoring for one shipment now

POST/v1/rescore

Live.

Parameters

Name	In	Required	Description
tracking	query	yes	Tracking number

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

POST/v1/rescore

Re-run scoring for one shipment now

API key (Bearer token)

tracking * (query)

Request body (JSON)

https://api-staging.orderlycore.com/v1/rescore

Submit one or a batch (max 500)

POST/v1/shipments

Accepts a single object, an array, or \{ shipments: [...] \}. Carriers and services are referenced by numeric ID. Live.

Request body

{
  "shipments": [
    {
      "tracking_number": "1Z999AA10123456784",
      "carrier_id": 1,
      "carrier_service_id": 4,
      "ship_date": "2026-07-20"
    }
  ]
}

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

POST/v1/shipments

Submit one or a batch (max 500)

API key (Bearer token)

Request body (JSON){ "shipments": [ { "tracking_number": "1Z999AA10123456784", "carrier_id": 1, "carrier_service_id": 4, "ship_date": "2026-07-20" } ] }

https://api-staging.orderlycore.com/v1/shipments

List the caller's shipments

GET/v1/shipments

Returns shipments available to the authenticated organization. Live.

Parameters

Name	In	Required	Description
status	query	no
carrier	query	no
limit	query	no
cursor	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/shipments

List the caller's shipments

API key (Bearer token)

status (query)

carrier (query)

limit (query)

cursor (query)

https://api-staging.orderlycore.com/v1/shipments

Status + predictions for one shipment

GET/v1/shipments/{tn}

Returns the latest status and prediction details for one tracking number. Live.

Parameters

Name	In	Required	Description
tn	path	yes	Tracking number

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/shipments/{tn}

Status + predictions for one shipment

API key (Bearer token)

tn * (path)

https://api-staging.orderlycore.com/v1/shipments/

On-demand prediction for one shipment

POST/v1/shipments/{tn}/predict

Runs an on-demand prediction for one shipment and returns the updated result. Live.

Parameters

Name	In	Required	Description
tn	path	yes	Tracking number

Request body

{}

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

POST/v1/shipments/{tn}/predict

On-demand prediction for one shipment

API key (Bearer token)

tn * (path)

Request body (JSON){}

https://api-staging.orderlycore.com/v1/shipments//predict