EMX API Integration Guide

Last updated: July. 28th, 2021
Emirates Post use this endpoint to push shipment status to their customers

Customer - Endpoints

The following table lists down the available endpoints that customer need to create to receive shipment status update from Emirates Post.

# EndpointName Endpoint Description
2 Customer Endpoint UPDATE /CustomerEndpoint This endpoint will be used by Emirates Post to send shipment status update.

Endpoints Details

This endpoint will be used by Emirates Post to send shipment status update

Customer Endpoint

UPDATE /CustomerEndpoint

This endpoint will be used by Emirates Post to send the below shipment status update


- Shipment status update

- Out for Delivery

- Shipment Created

- Shipment Delivered

- Shipment on Hold

- Shipment picked up by courier

- Shipment returned to sender

- Undelivered

URL: to be provided from the customer side

Required Headers
    As per the customer security standard
Sample Body

{
    "AWB_Number": "string",
    "Reference_Number": "string",
    "Time_Stamp": "string",
    "Status": "string",
    "SubStatus": "string",
    "ConsigneeContactName": "string",
    "ConsigneeAddress": "string",
    "ConsigneeMobNumber": "string",
    "DateOfShipmentCreation": "string",
    "Remarks": "string",
    "IDType": "string",
    "IDName": "string",
    "IDNumber": "string",
    "IDExpiry": "string"
}

The following tables contain the full structure of the CreateRequest object including the properties names', data types, and other useful information. Make sure to review these tables before you build your object.

RateCalculationRequest Object
Property Name Data Type Mandatory Allowed Values
AWB_Number String Yes
Reference_Number String Yes
"Time_Stamp String Yes
Status string Yes Shipment Created, Shipment Picked up by Courier, Shipment Cancelled, Shipment Delivered, Shipment Returned to Sender, Out for Delivery, Undelivered
SubStatus string Yes
ConsigneeContactName String Yes 971
ConsigneeAddress String Yes null
ConsigneeMobNumber String Yes 1
DateOfShipmentCreation String Yes
Remarks String Yes
IDType String Yes
IDName String Yes Centimeter
IDNumber String Yes
IDExpiry String Yes
Sample Request

{
    "AWB_Number": "1000006011007",
    "Reference_Number": "L1002528",
    "Time_Stamp": "3/2/2020 7:24:19 PM",
    "Status": "Shipment Delivered",
    "SubStatus": "Delivered",
    "ConsigneeContactName": "Kenneth Aimufua",
    "ConsigneeAddress": "MH ALSHAYA CO LLC",
    "ConsigneeMobNumber": "0526000000",
    "DateOfShipmentCreation": "3/2/2020 7:19:17 PM",
    "Remarks": null,
    "IDType": "EIDA Card",
    "IDName": "Sreekrishnan Kunju Nair",
    "IDNumber": "123456789123456",
    "IDExpiry": "2/17/2023 12:00:00 AM"
}
Expected Response

{
    "errorCode": null,
    "errorMsg": null,
    "status": "Success"
}