v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

batch

Batch - Get

Retrieve batch details by ID, including orders and fulfillment progress.

get/batch/get

Query parameters

batch_idstring

Batch ID to retrieve

Example:507f1f77bcf86cd799439011

batch_numbernumber

Batch number to retrieve

Response

Full batch detail with orders, inventory, and scan data

Example response

{
  "batch": {
    "_id": "507f1f77bcf86cd799439011",
    "orders": [
      {
        "store_id": "507f1f77bcf86cd799439011",
        "tags": [
          "507f1f77bcf86cd799439011",
          "507f1f77bcf86cd799439012"
        ]
      }
    ],
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "ship_end": "2025-01-15T12:00:00.000Z"
  }
}