Overview

By entering the Clickpost API Key, enterprises can get all the active carrier partner accounts

Usecase

This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders

This is a standard API which supports all shipments created and transported within

📘
NOTE
The API will give an array of all carrier partner accounts

Field Name	Data Type	Field	Description	Max Length	Example
`key`	`string`	Mandatory	Unique license key provided by Clickpost for the enterprise		00000000-0000-0000-0000-000000000000
`active`	`boolean`	Optional	Whether enterprise wants to fetch all active carrier partner accounts or not		True

meta [meta parameters]

Field Name	Data Type	Description	Example
`success`	`Boolean`	Indicates the success of the API request	`true`
`message`	`String`	SUCCESS in case request was successfully processed by Clickpost, else returns error message.	"SUCCESS"
`status`	HTTP Code	The HTTP response status code of the API request	200

result [result parameters]

Field Name	Data Type	Description	Example
`enterprise_name`	`String`	The name of the enterprise	"Demo Enterprise"
`accounts`	`List`	Contains the list of all the carrier partner accounts	[ { "courier_partner_id": 218, "courier_name": "RedBox", "account_code": "Redbox-test", "account_active": true }, { "courier_partner_id": 86, "courier_name": "Madhur Courier Service", "account_code": "test", "account_active": true } ]
`courier_partner_id`	`num`	The carrier partner ID	4
`courier_name`	`string`	The name of the carrier partner	"Bluedart"
`account_code`	`string`	The account configured under a carrier partner	"Xpressbees_Surface"
`account_active`	`boolean`	Whether the carrier account is active or not	true