/shipments-history

ESSENTIAL STANDARD ADD-ON

Shipments-history is how you retrieve shipment history that goes back a maximum of six (6) months.

Huomaa

The REST API endpoints are only accessible via HTTPS and are located at api.unifaun.com.

https://api.unifaun.com/rs-extapi/v1

Before getting started you need to know your developer ID and create an API key.

Fetch status information

GET /alerts

Fetches status information about shipments.

Huomaa

Max. 100 events are returned per call. If more events are available the done value in the result will be "false" and you should make another call to fetch the remaining events.

An event is stored for seven (7) days and are then automatically deleted.

If calls are made too fast the minDelay value in the result will return how many milliseconds you have to wait before calling again. To avoid an uneven call rate, max. one (1) call per five (5) minutes is recommended.

The calls are returned with an alertCode for each event.

Query parameters

Parameter	Type	Description	Category
fetchId	string	The ID of the next batch of events to fetch. Save the fetchId returned by a previous call and use it as parameter value for the next call. If a fetchId is not available, use the value -1 to make a call that will return a fetchId to use in a subsequent call.	Optional

Parameter

Type

Description

Category

fetchId

string

The ID of the next batch of events to fetch. Save the fetchId returned by a previous call and use it as parameter value for the next call.

If a fetchId is not available, use the value -1 to make a call that will return a fetchId to use in a subsequent call.

Optional

{
    "fetchId": "2",
    "done": true,
    "minDelay": 100,
    "alerts": [
        {
            "alertCode": "STATUS_TRANSITION_PRINTED",
            "alertTime": "2021-02-09T10:04:09.896+0000",
            "alertCreated": "2021-02-09T10:06:06.458+0000",
            "alertInfo": "STATUS",
            "shipmentInfo": {
                "shipmentNo": "4387174669",
                "parcels": [
                    {
                        "parcelNo": "373325382784979088",
                        "returnParcelNo": null,
                        "reference": null,
                        "partOrderNo": null
                    }
                ],
                "orderNo": null,
                "reference": "",
                "printDate": "2021-02-09T10:04:09.896+0000",
                "shipDate": "2021-02-09T10:03:00.000+0000",
                "serviceId": "AEX",
                "partnerId": "DHLROAD",
                "parcelCount": 1,
                "profileGroup": "Grundprofilgrupp",
                "normalShipment": true,
                "returnShipment": false
            }
        },
        {
            "alertCode": "STATUS_PRINTED",
            "alertTime": "2021-02-09T10:04:09.896+0000",
            "alertCreated": "2021-02-09T10:06:06.458+0000",
            "alertInfo": "STATUS",
            "shipmentInfo": {
                "shipmentNo": "4387174669",
                "parcels": [
                    {
                        "parcelNo": "373325382784979088",
                        "returnParcelNo": null,
                        "reference": null,
                        "partOrderNo": null
                    }
                ],
                "orderNo": null,
                "reference": "",
                "printDate": "2021-02-09T10:04:09.896+0000",
                "shipDate": "2021-02-09T10:03:00.000+0000",
                "serviceId": "AEX",
                "partnerId": "DHLROAD",
                "parcelCount": 1,
                "profileGroup": "Grundprofilgrupp",
                "normalShipment": true,
                "returnShipment": false
            }
        }
    ]
}

Vihje

For schema and testing, please refer to https://api.unifaun.com/rs-docs/.

For description of properties, please refer to the Property reference guide.

For information about some crucial objects, please refer to REST API Objects.

Tässä osiossa:

nShift Delivery Help Center