Shipments API

GET /api/shipments

This public endpoint is used to get a list of supply chain shipments. They can be filtered by PO (purchase order) number, country, year, and status.

The order of the statuses below reflects the order of the shipments. At the present, in_country and mda are rarely used.

Params

    po_number
    country
    year
    status: { issued | packed | greenlight | shipping | delivered | in_country | mda }

Request

    https://admin.espen.afro.who.int/api/shipments?country={country}&year={year}&status={status}

    https://admin.espen.afro.who.int/api/shipments?po_number={po_number}

Response

    [
      {
            "po_number": 201818674,
            "country": "Ghana",
            "year": 2018,
            "stage": "delivered",
            "drug": "PZQ",
            "quantity": 6445000,
            "program": "ESPEN",
            "estimated_packing_completion": "2017-11-07T01:46:48.336Z",
            "packing_list_received": "2017-12-07T01:46:48.336Z"
        }, ...
    ]