1.9 KiB
1.9 KiB
name, description
| name | description |
|---|---|
| carriers-routes | Handle 7 OpenAPI operation(s) under /v1/carriers for the carriers route group. |
carriers API Routes
Handle 7 OpenAPI operation(s) under /v1/carriers for the carriers 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_carriers
- Operation ID:
list_carriers - Route:
GET /v1/carriers - Mode: READ
- Summary: List Carriers
get_carrier_by_id
- Operation ID:
get_carrier_by_id - Route:
GET /v1/carriers/{carrier_id} - Mode: READ
- Summary: Get Carrier By ID
- Parameters:
carrier_idinpathrequired
disconnect_carrier_by_id
- Operation ID:
disconnect_carrier_by_id - Route:
DELETE /v1/carriers/{carrier_id} - Mode: WRITE
- Summary: Disconnect Carrier by ID
- Parameters:
carrier_idinpathrequired
add_funds_to_carrier
- Operation ID:
add_funds_to_carrier - Route:
PUT /v1/carriers/{carrier_id}/add_funds - Mode: WRITE
- Summary: Add Funds To Carrier
- Parameters:
carrier_idinpathrequired
- Body: JSON request body accepted.
get_carrier_options
- Operation ID:
get_carrier_options - Route:
GET /v1/carriers/{carrier_id}/options - Mode: READ
- Summary: Get Carrier Options
- Parameters:
carrier_idinpathrequired
list_carrier_package_types
- Operation ID:
list_carrier_package_types - Route:
GET /v1/carriers/{carrier_id}/packages - Mode: READ
- Summary: List Carrier Package Types
- Parameters:
carrier_idinpathrequired
list_carrier_services
- Operation ID:
list_carrier_services - Route:
GET /v1/carriers/{carrier_id}/services - Mode: READ
- Summary: List Carrier Services
- Parameters:
carrier_idinpathrequired