48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
---
|
|
name: tracking-routes
|
|
description: Handle 3 OpenAPI operation(s) under /v1/tracking for the tracking route group.
|
|
---
|
|
|
|
# tracking API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /v1/tracking for the tracking 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
|
|
|
|
### get_tracking_log
|
|
|
|
- Operation ID: `get_tracking_log`
|
|
- Route: `GET /v1/tracking`
|
|
- Mode: READ
|
|
- Summary: Get Tracking Information
|
|
- Parameters:
|
|
- `carrier_code` in `query`
|
|
- `tracking_number` in `query`
|
|
- `carrier_id` in `query`
|
|
|
|
### start_tracking
|
|
|
|
- Operation ID: `start_tracking`
|
|
- Route: `POST /v1/tracking/start`
|
|
- Mode: WRITE
|
|
- Summary: Start Tracking a Package
|
|
- Parameters:
|
|
- `carrier_code` in `query`
|
|
- `tracking_number` in `query`
|
|
- `carrier_id` in `query`
|
|
|
|
### stop_tracking
|
|
|
|
- Operation ID: `stop_tracking`
|
|
- Route: `POST /v1/tracking/stop`
|
|
- Mode: WRITE
|
|
- Summary: Stop Tracking a Package
|
|
- Parameters:
|
|
- `carrier_code` in `query`
|
|
- `tracking_number` in `query`
|
|
- `carrier_id` in `query`
|