Endpoints

Retrieve a batch

Retrieve a batch to see its stored per-order results together with the latest live status for accepted orders. Look it up by our batch_id or by your own client_batch_id.

GET/batches/:id

Fetch a batch you created, with its per-order results and the latest live status for accepted orders. A key can only read its own batches.

Headers

Authorizationstringrequired

Your API key: Bearer rly_live_....

Path parameters

idstringrequired

The batch_id (default) or your client_batch_id — see the by query parameter.

Query parameters

bystringoptional

batch_id (default) or client_batch_id to look up by your own reference.

pageintegeroptional

Page number for the order results. Defaults to 1.

limitintegeroptional

Results per page. Defaults to 20.

curl https://dev-api.rely7.com/api/v1/batches/7c9e6a2b-1f34-4d21-a0b8-9e2c1d4f5a6b \
  -H "Authorization: Bearer rly_live_xxx"

{
  "statusCode": 200,
  "success": true,
  "data": {
    "batch_id": "7c9e6a2b-1f34-4d21-a0b8-9e2c1d4f5a6b",
    "client_batch_id": "batch-2026-07-19-001",
    "status": "COMPLETED",
    "counts": { "total": 1, "accepted": 1, "rejected": 0 },
    "orders": [
      {
        "client_order_id": "order-9001",
        "pass_order_id": "b1d2...",
        "status": "IN_TRANSIT"
      }
    ]
  },
  "meta": { "total": 1, "page": 1, "limit": 20, "totalPages": 1 }
}