118 lines
2.7 KiB
Markdown
118 lines
2.7 KiB
Markdown
---
|
|
name: batches-routes
|
|
description: Handle 10 OpenAPI operation(s) under /v1/batches for the batches route group.
|
|
---
|
|
|
|
# batches API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /v1/batches for the batches route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_batches
|
|
|
|
- Operation ID: `list_batches`
|
|
- Route: `GET /v1/batches`
|
|
- Mode: READ
|
|
- Summary: List Batches
|
|
- Parameters:
|
|
- `status` in `query`
|
|
- `page` in `query`
|
|
- `page_size` in `query`
|
|
- `sort_dir` in `query`
|
|
- `batch_number` in `query`
|
|
- `created_at_start` in `query`
|
|
- `created_at_end` in `query`
|
|
- `processed_at_start` in `query`
|
|
- `processed_at_end` in `query`
|
|
- `sort_by` in `query`
|
|
|
|
### create_batch
|
|
|
|
- Operation ID: `create_batch`
|
|
- Route: `POST /v1/batches`
|
|
- Mode: WRITE
|
|
- Summary: Create A Batch
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_batch_by_external_id
|
|
|
|
- Operation ID: `get_batch_by_external_id`
|
|
- Route: `GET /v1/batches/external_batch_id/{external_batch_id}`
|
|
- Mode: READ
|
|
- Summary: Get Batch By External ID
|
|
- Parameters:
|
|
- `external_batch_id` in `path` required
|
|
|
|
### delete_batch
|
|
|
|
- Operation ID: `delete_batch`
|
|
- Route: `DELETE /v1/batches/{batch_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Batch By Id
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
|
|
### get_batch_by_id
|
|
|
|
- Operation ID: `get_batch_by_id`
|
|
- Route: `GET /v1/batches/{batch_id}`
|
|
- Mode: READ
|
|
- Summary: Get Batch By ID
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
|
|
### update_batch
|
|
|
|
- Operation ID: `update_batch`
|
|
- Route: `PUT /v1/batches/{batch_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Batch By Id
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
|
|
### add_to_batch
|
|
|
|
- Operation ID: `add_to_batch`
|
|
- Route: `POST /v1/batches/{batch_id}/add`
|
|
- Mode: WRITE
|
|
- Summary: Add to a Batch
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_batch_errors
|
|
|
|
- Operation ID: `list_batch_errors`
|
|
- Route: `GET /v1/batches/{batch_id}/errors`
|
|
- Mode: READ
|
|
- Summary: Get Batch Errors
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
- `page` in `query`
|
|
- `pagesize` in `query`
|
|
|
|
### process_batch
|
|
|
|
- Operation ID: `process_batch`
|
|
- Route: `POST /v1/batches/{batch_id}/process/labels`
|
|
- Mode: WRITE
|
|
- Summary: Process Batch ID Labels
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### remove_from_batch
|
|
|
|
- Operation ID: `remove_from_batch`
|
|
- Route: `POST /v1/batches/{batch_id}/remove`
|
|
- Mode: WRITE
|
|
- Summary: Remove From Batch
|
|
- Parameters:
|
|
- `batch_id` in `path` required
|
|
- Body: JSON request body accepted.
|