Skip to content
On this page

API Endpoints

At the moment Merchant API provides full scope of functionality to successfully integrates with our system.

Tracking order

Endpoint:

  • tracking_number= TRACKING_NUMBER(ID)
  • slug= DELIVERY_SYSTEM_NAME (optional)
js
GET: /v1/trackings/?tracking_number=${TRACKING_NUMBER}&slug=${DELIVERY_SYSTEM_NAME}

Response:

json
{
    {
    "shipments": [
        {
            "id": "",
            "service": "",
            "origin": {
                "address": {
                    "addressLocality": ""
                },
                "servicePoint": {
                    "url": "",
                    "label": ""
                }
            },
            "destination": {
                "address": {
                    "addressLocality": ""
                },
                "servicePoint": {
                    "url": "",
                    "label": ""
                }
            },
            "status": {
                "timestamp": "",
                "location": {
                    "address": {
                        "addressLocality": ""
                    }
                },
                "statusCode": "",
                "status": "",
                "description": ""
            },
            "details": {
                "proofOfDelivery": {
                    "timestamp": "",
                    "signatureUrl": "",
                    "documentUrl": ""
                },
                "proofOfDeliverySignedAvailable": ,
                "totalNumberOfPieces": ,
                "pieceIds": [
                    ""
                ]
            },
            "events": [
                {
                    "timestamp": "",
                    "location": {
                        "address": {
                            "addressLocality": ""
                        }
                    },
                    "description": "",
                    "pieceIds": [
                        ""
                    ]
                },
                
                ...
            ]
        }
    ],
    "status": 200,
    "trackingNumber": ""
}
}

All rights reserved.