About

• List all couriers

Class

celmarket\Admin\AdminCouriers

Method

getCouriers

API

• method: admininfo
• action: getCouriers

Parameters

(No parameters)

Response

An array with the following elements

• (element from array) = a courier -> obiect
  • id = courier ID
  • uid = courier identifier
  • name = courier name
  • awb_formats = list of supported awb formats
  • services = list of supported services
  • epod = ePOD
    • 1 = support ePOD
    • 0 = does not support ePOD
  • status = courier status
    • 1 = active
    • 0 = inactive

Example - PHP

https://github.com/celdotro/marketplace_examples/blob/master/Admin/46.getCouriers.php

Example - JSON

{
    "request": {},

    "response": [
        {
            "id": 1,
            "uid": "fancourier",
            "name": "Fan Courier",
            "awb_formats": ["A4", "A5", "A6"],
            "services": [],
            "epod": 1,
            "status": 1
        },
        {
            "id": 4,
            "uid": "dpd",
            "name": "DPD",
            "awb_formats": ["A4", "A6"],
            "services": [
                {
                    "text": "DPD Standard",
                    "value": 2505
                },
                {
                    "text": "Clasic National",
                    "value": 2002
                },
                {
                    "text": "Clasic National LOCO",
                    "value": 2113
                }
            ],
            "epod": 0,
            "status": 1
        }
    ]
}