Terminal Shipping API
Ask or search…
K

Disable Carrier

Disable a specific carrier for a user.
post
https://api.terminal.africa
/v1/carriers/disable/:carrier_id
/carriers/disable/:carrier_id
This endpoint allows you to disable a carrier. Disabled carriers can not be used to retrieve rates or arrange pickups and deliveries. One of domestic, international or regional query parameters is required in request.
Parameters
Path
carrier_id*
string
Unique carrier_id for carrier.
Query
domestic
boolean
Set to true to disable carrier for domestic rates and deliveries.
international
boolean
Set to true to disable carrier for international rates and deliveries.
regional
boolean
Set to true to disable carrier for regional rates and deliveries.
Header
Authorization*
string
Set value to Bearer SECRET_KEY
Content-Type
string
Set value to application/json
Responses
200
Carrier disabled successfully.