get https://www.clickpost.in/api/v1/fetch-accounts?
With help of this API enterprises can get all the carrier partner accounts that are currently active on their Clickpost dashboard. This API would be useful if the enterprise is not using Clickpost's allocation rules and just require the active list of accounts to assign the carrier manually
Important Links
Response
meta
[meta parameters]
Field Name | Data Type | Description |
---|---|---|
success | Boolean | Indicates the success of the API request |
message | String | SUCCESS in case request was successfully processed by Clickpost, else returns error message. |
status | HTTP Code | The HTTP response status code of the API request |
result
[result parameters]
Field Name | Data Type | Description |
---|---|---|
enterprise_name | String | The name of the enterprise |
accounts | List | Contains the list of all the carrier partner accounts |
courier_partner_id | num | The carrier partner ID |
courier_name | string | The name of the carrier partner |
account_code | string | The account configured under a carrier partner |
account_active | boolean | Whether the carrier account is active or not |