List of packages

Request

GET /packages/list

Optional GET request parameters for additional result filtering:

The minimum length of any of the parameters listed below is 3 characters. Filtration is done under the 'AND' condition on all specified parameters by searching for the specified substring in the object parameter value. Incorrectly filled parameters will be ignored .

Parameter Type Description
dateFrom YYYY-MM-DD Initial date packages were added
dateTo YYYY-MM-DD Last date packages were added
trackNumber String Package tracking number
courierId String Delivery service digital ID
status Int Package status
destinationCountry String (ISO 3166-1 alpha-2) Two-letter code for package destination country
departureAddress String Sender's address
destinationAddress String Delivery address
orderId String | Int Order number
recipientName String Recipient name
recipientEmail String Recipient's e-mail
recipientPhone String Recipient phone number
comment String Note for the package

GET request parameters for page navigation:

Parameter Type Description Default
page Int Page number (starting with 1) 1
per-page Int Number of objects per page: from 20 to 100 20

Example of a successful response

The response will return an array of Package objects. A response can be broken down into pages:

        
{
    "code": 200,
    "payload": {
        [
            "created_at": "2021-07-06T13:46:25+03:00",
            "updated_at": "2021-07-06T13:46:25+03:00",
            "started_tracking_at": "2021-07-06T13:46:25+03:00",
            "track_number": "UA937578848US",
            "origin": null,
            "destination": null,
            "last_status": "Receiving status...",
            "status": -1,
            "checkpoints": [
                {
                    "id": "",
                    "date": "2021-07-06T13:46:25+03:00",
                    "title": "Tracking started",
                    "location": "The package most likely isn't shipped yet",
                    "latitude": null,
                    "longitude": null,
                    "courier_id": null
                }
            ],
            "last_status_date": "2021-07-06T13:46:25+03:00",
            "est_delivery_date_from": null,
            "est_delivery_date_to": null,
            "extra_track_numbers": [],
            "hash": "f25370e9",
            "consolidated_track_number": null,
            "consolidation_date": null,
            "destination_country_code": "ru",
            "updating": false,
            "last_tracking_date": null,
            "days_on_way": 1,
            "weight": null,
            "extra_info": [],
            "couriers_ids": [
                1,
                4,
                10,
                366
            ],
            "courier_id": null,
            "info": []
        ],
        //..........
    }
}