Courier

List of supported couriers/shipping providers

API Endpoint

URL	{base url}/api/References/GetCouriers
Method	GET
Authorization	Bearer Token
Content-Type	application/json

Request Headers

Parameter	Type	Required	Description
APIKEY	string	true	System key code

Request Parameters

Parameter	Type	Required	Description
filter	string	false	Courier code / name / tag

Request Example

{base url}/api/References/GetCouriers?filter={}

Response Parameters

Parameter	Type	Description
Id	integer	Error status (e.g. 0 = No error)
Success	boolean	Request success status
Message	string	Response message
RequestId	string	Request reference ID
Size	integer	Number of records
Data	array	Courier data list

Data

Parameter	Type	Description
Id	string	Courier ID
Code	string	Courier code
Name	string	Courier name
Tag	string	Courier tags

Response JSON Example

{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "1A48315C-C310-4FC7-A3F3-E4D9AEBBBD98",
    "Size": 3,
    "Data": [
        {
            "Id": "FA63D864E16E439D988AEB99A7CEE06F",
            "Code": "DHL",
            "Name": "DHL Express",
            "Tag": "#BLONLY#DHL_TH"
        },
        {
            "Id": "906EE71851174035B694B076CC1DF684",
            "Code": "FLASH",
            "Name": "Flash Express",
            "Tag": "#FLASH_EX"
        },
        {
            "Id": "04DABA98067742FF8D264E6B42DD487E",
            "Code": "JT",
            "Name": "J&T Express",
            "Tag": "#JT_EX"
        }
    ]
}