List courier accounts - celdotro/marketplace GitHub Wiki

About

  • List all courier accounts

Class

celmarket\Admin\AdminCouriers

Method

getAccounts

API

  • method: admininfo
  • action: getAccountCouriers

Parameters

(No parameters)

Response

An array with the following elements

  • (element din array) = a courier account -> obiect
    • id = courier account ID
    • courier_id = courier ID
    • courier_name = courier name
    • name = courier account name
    • epod = ePOD
      • 1 = enable ePOD
      • 0 = disable ePOD
    • awb_format = AWB format
    • service = courier service
    • default_orders = default account for orders
      • 1 = active
      • 0 = inactive
    • status = courier account status
      • 1 = active
      • 0 = inactive

Example - PHP

https://github.com/celdotro/marketplace_examples/blob/master/Admin/47.getAccounts.php

Example - JSON

{
    "request": {},

    "response": [
        {
            "id": 123,
            "courier_id": 1,
            "courier_name": "Fan Courier",
            "name": "Fan Courier - TEST",
            "epod": 0,
            "awb_format": "A4",
            "service": "",
            "default_orders": 0,
            "status": 1
        },
        {
            "id": 124,
            "courier_id": 4,
            "courier_name": "DPD",
            "name": "DPD - TEST",
            "epod": 0,
            "awb_format": "A4",
            "service": "2002",
            "default_orders": 1,
            "status": 1
        }
    ]
}