90 lines
2.4 KiB
Markdown
90 lines
2.4 KiB
Markdown
---
|
|
name: transfer-orders-routes
|
|
description: Handle 8 OpenAPI operation(s) under /v2/transfer-orders for the transfer orders route group.
|
|
---
|
|
|
|
# transfer orders API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /v2/transfer-orders for the transfer orders 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
|
|
|
|
### create_transfer_order
|
|
|
|
- Operation ID: `create_transfer_order`
|
|
- Route: `POST /v2/transfer-orders`
|
|
- Mode: WRITE
|
|
- Summary: CreateTransferOrder
|
|
- Body: JSON request body accepted.
|
|
|
|
### search_transfer_orders
|
|
|
|
- Operation ID: `search_transfer_orders`
|
|
- Route: `POST /v2/transfer-orders/search`
|
|
- Mode: WRITE
|
|
- Summary: SearchTransferOrders
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_transfer_order
|
|
|
|
- Operation ID: `delete_transfer_order`
|
|
- Route: `DELETE /v2/transfer-orders/{transfer_order_id}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteTransferOrder
|
|
- Parameters:
|
|
- `transfer_order_id` in `path` required
|
|
- `version` in `query`
|
|
|
|
### retrieve_transfer_order
|
|
|
|
- Operation ID: `retrieve_transfer_order`
|
|
- Route: `GET /v2/transfer-orders/{transfer_order_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveTransferOrder
|
|
- Parameters:
|
|
- `transfer_order_id` in `path` required
|
|
|
|
### update_transfer_order
|
|
|
|
- Operation ID: `update_transfer_order`
|
|
- Route: `PUT /v2/transfer-orders/{transfer_order_id}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateTransferOrder
|
|
- Parameters:
|
|
- `transfer_order_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### cancel_transfer_order
|
|
|
|
- Operation ID: `cancel_transfer_order`
|
|
- Route: `POST /v2/transfer-orders/{transfer_order_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: CancelTransferOrder
|
|
- Parameters:
|
|
- `transfer_order_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### receive_transfer_order
|
|
|
|
- Operation ID: `receive_transfer_order`
|
|
- Route: `POST /v2/transfer-orders/{transfer_order_id}/receive`
|
|
- Mode: WRITE
|
|
- Summary: ReceiveTransferOrder
|
|
- Parameters:
|
|
- `transfer_order_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### start_transfer_order
|
|
|
|
- Operation ID: `start_transfer_order`
|
|
- Route: `POST /v2/transfer-orders/{transfer_order_id}/start`
|
|
- Mode: WRITE
|
|
- Summary: StartTransferOrder
|
|
- Parameters:
|
|
- `transfer_order_id` in `path` required
|
|
- Body: JSON request body accepted.
|