1.4 KiB
1.4 KiB
name, description
| name | description |
|---|---|
| pickups-routes | Handle 4 OpenAPI operation(s) under /v1/pickups for the pickups route group. |
pickups API Routes
Handle 4 OpenAPI operation(s) under /v1/pickups for the pickups 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_scheduled_pickups
- Operation ID:
list_scheduled_pickups - Route:
GET /v1/pickups - Mode: READ
- Summary: List Scheduled Pickups
- Parameters:
carrier_idinquerywarehouse_idinquerycreated_at_startinquerycreated_at_endinquerypageinquerypage_sizeinquery
schedule_pickup
- Operation ID:
schedule_pickup - Route:
POST /v1/pickups - Mode: WRITE
- Summary: Schedule a Pickup
- Body: JSON request body accepted.
get_pickup_by_id
- Operation ID:
get_pickup_by_id - Route:
GET /v1/pickups/{pickup_id} - Mode: READ
- Summary: Get Pickup By ID
- Parameters:
pickup_idinpathrequired
delete_scheduled_pickup
- Operation ID:
delete_scheduled_pickup - Route:
DELETE /v1/pickups/{pickup_id} - Mode: WRITE
- Summary: Delete a Scheduled Pickup
- Parameters:
pickup_idinpathrequired