Enable Carrier

Enable a specific carrier for a user.

/carriers/enable/:carrier_id

POST https://api.terminal.africa/v1/carriers/enable/:carrier_id

This endpoint allows you to enable a carrier. One of domestic, international or regional query parameters is required in request.

Path Parameters

Name
Type
Description

carrier_id*

string

Unique carrier_id for carrier.

Query Parameters

Name
Type
Description

domestic

boolean

Set to true to enable carrier for domestic rates and deliveries.

international

boolean

Set to true to enable carrier for international rates and deliveries.

regional

boolean

Set to true to enable carrier for regional rates and deliveries.

Headers

Name
Type
Description

Authorization*

string

Set value to Bearer SECRET_KEY

Content-Type

string

Set value to application/json

{
	status: true,
	message: 'Carrier enabled successfully',
	data: {
		active: true,
		carrier_id: 'CA-01521075089',
		domestic: true,
		id: 'loYZh5J47D6gJUKOExXeO1RLcMARScLi',
		international: true,		
		logo: 'https://ucarecdn.com/dcdd8109-af8c-4057-8104-192be821dd6e/download4.png',
		metadata: {},
		name: 'DHL Express',
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'
	}
}

Last updated