Ingest

Push shipments and events in. Org-scoped; rows are stamped with your organization. Max 500 rows per request.

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

Upload shipment master records

POST/v1/ingest/shipments

Requires X-Organization-Id. Live.

Request body

[
  {
    "tracking_number": "1Z999AA10123456784",
    "carrier": "ups",
    "shipped_at": "2026-07-20T15:00:00Z",
    "promised_at": "2026-07-23T23:59:00Z",
    "origin_zip": "07001",
    "dest_zip": "94107",
    "service_level": "ground"
  }
]

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "accepted": 1
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

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

POST/v1/ingest/shipments

Upload shipment master records

API key (Bearer token)

X-Organization-Id *

Request body (JSON)[ { "tracking_number": "1Z999AA10123456784", "carrier": "ups", "shipped_at": "2026-07-20T15:00:00Z", "promised_at": "2026-07-23T23:59:00Z", "origin_zip": "07001", "dest_zip": "94107", "service_level": "ground" } ]

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

Push raw tracking events

POST/v1/ingest/events

Requires X-Organization-Id. Live.

Request body

[
  {
    "tracking_number": "1Z999AA10123456784",
    "carrier": "ups",
    "status": "in_transit",
    "description": "Departed facility",
    "occurred_at": "2026-07-21T08:12:00Z"
  }
]

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "accepted": 1
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

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

POST/v1/ingest/events

Push raw tracking events

API key (Bearer token)

X-Organization-Id *

Request body (JSON)[ { "tracking_number": "1Z999AA10123456784", "carrier": "ups", "status": "in_transit", "description": "Departed facility", "occurred_at": "2026-07-21T08:12:00Z" } ]

https://api-staging.orderlycore.com/v1/ingest/events

Ingest/import job status

GET/v1/jobs/{id}

Live.

Parameters

Name	In	Required	Description
id	path	yes	Job id

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "id": "job_123",
    "status": "completed",
    "processed": 500,
    "failed": 0
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

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

GET/v1/jobs/{id}

Ingest/import job status

API key (Bearer token)

id * (path)

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