List Batches

Use this endpoint to list batches for a customer with pagination.

REST Endpoint

GET /restapi/v1/customers/:customerId/batch

Query Parameters

Parameter	Type	Required	Default	Description
page	integer	false	1	Page number (1-based)
limit	integer	false	25	Number of batches per page (1-100)

Request Example

GET /restapi/v1/customers/TEST00002/batch?page=1&limit=25

Response Status Code

200 OK

Response Content Type

application/json

Response JSON Example

{
  "batches": [
    {
      "batchId": 42,
      "name": "April Shipments",
      "status": "completed",
      "quoteCount": 10,
      "bookedCount": 9,
      "errorCount": 1,
      "createdAt": "2026-04-01 10:00:00",
      "updatedAt": "2026-04-01 11:30:00",
      "processedAt": "2026-04-01 11:30:00"
    },
    {
      "batchId": 43,
      "name": "Returns Batch",
      "status": "open",
      "quoteCount": 5,
      "bookedCount": 0,
      "errorCount": 0,
      "createdAt": "2026-04-02 09:00:00",
      "updatedAt": "2026-04-02 09:15:00",
      "processedAt": null
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 25
}

Explanation of Response Fields

Field	Type	Description
batches	array	Array of batch summary objects
batches[n].batchId	integer	System-generated batch ID
batches[n].name	string	Customer-provided batch name
batches[n].status	string	Batch status: "open", "processing", "completed", "failed", or "cancelled"
batches[n].quoteCount	integer	Number of quotes in the batch
batches[n].bookedCount	integer	Number of successfully booked quotes
batches[n].errorCount	integer	Number of quotes that failed during booking
batches[n].createdAt	string	Timestamp when the batch was created
batches[n].updatedAt	string	Timestamp when the batch was last updated
batches[n].processedAt	string or null	Timestamp when the batch was processed, null if not yet processed
total	integer	Total number of batches for this customer
page	integer	Current page number
limit	integer	Items per page