58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
---
|
|
name: manifests-routes
|
|
description: Handle 4 OpenAPI operation(s) under /v1/manifests for the manifests route group.
|
|
---
|
|
|
|
# manifests API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /v1/manifests for the manifests 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_manifests
|
|
|
|
- Operation ID: `list_manifests`
|
|
- Route: `GET /v1/manifests`
|
|
- Mode: READ
|
|
- Summary: List Manifests
|
|
- Parameters:
|
|
- `warehouse_id` in `query`
|
|
- `ship_date_start` in `query`
|
|
- `ship_date_end` in `query`
|
|
- `created_at_start` in `query`
|
|
- `created_at_end` in `query`
|
|
- `carrier_id` in `query`
|
|
- `page` in `query`
|
|
- `page_size` in `query`
|
|
- `label_ids` in `query`
|
|
|
|
### create_manifest
|
|
|
|
- Operation ID: `create_manifest`
|
|
- Route: `POST /v1/manifests`
|
|
- Mode: WRITE
|
|
- Summary: Create Manifest
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_manifest_by_id
|
|
|
|
- Operation ID: `get_manifest_by_id`
|
|
- Route: `GET /v1/manifests/{manifest_id}`
|
|
- Mode: READ
|
|
- Summary: Get Manifest By Id
|
|
- Parameters:
|
|
- `manifest_id` in `path` required
|
|
|
|
### get_manifest_request_by_id
|
|
|
|
- Operation ID: `get_manifest_request_by_id`
|
|
- Route: `GET /v1/manifests/requests/{manifest_request_id}`
|
|
- Mode: READ
|
|
- Summary: Get Manifest Request By Id
|
|
- Parameters:
|
|
- `manifest_request_id` in `path` required
|