Get batch

Retrieve a single batch by its number, including all associated units, serial numbers, and part revisions.

Access

API Key	Access Level	Description
User	Full	Users can read batchs
Station	Full	Stations can read batchs

Endpoint

GET/v2/batches/{number}

Authorization

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

numberstring

Number of the batch to retrieve.

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.batches.get(
    number="string"
)

# Handle response
print(result)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "number": "BATCH-2024-001",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by_user": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "John Doe"
  },
  "created_by_station": {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Assembly Station 01"
  },
  "units": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "serial_number": "SN-2024-001234",
      "created_at": "2024-01-15T10:30:00Z",
      "part": {
        "id": "550e8400-e29b-41d4-a716-446655440007",
        "number": "PCB-MAIN-001",
        "name": "Main Control Board",
        "revision": {
          "id": "550e8400-e29b-41d4-a716-446655440006",
          "number": "REV-A"
        }
      }
    }
  ]
}

{
  "message": "Bad request",
  "code": "BAD_REQUEST",
  "issues": []
}

{
  "message": "Unauthorized",
  "code": "UNAUTHORIZED",
  "issues": []
}

{
  "message": "Not found",
  "code": "NOT_FOUND",
  "issues": []
}

{
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "issues": []
}

How is this guide?