POST Shipment Details

https://jerrytest.ewe.com.au/eweApi/ewe/api/shipmentDetails

You can use shipment details API to pull the outbound order details.

NOTE:

The shipmentDetials API is only available when the outbound order has been processed via Upimium.
Only after the outbound order is manually processed by EWE admin, you can call this API to retrieve the outbound shipment details. Otherwise, the API returns empty data.
The shipmentDetails API also returns the tracking ID.

Request

Attribute	Type	Required	Description
boxNo	string	Required	Outbound order reference number
poNumber	string	Required if boxNo is not provided	Outbound reference number
username	string	Required	Jerry username
digest	string	Required	Digest algorithm

Either boxNo or poNumber must be included in the request. At least one is required.

Digest Algorithm

The digest algorithm is MD5 + base64 algorithm.

Example: digest = username + reference number + API password

String content = username + requestDto.getBoxNo();
String digest = MD5Util.MD5EncodeForCainiao(content, auCustomer.getPassword());
public static String MD5EncodeForCainiao (String content, String keys) {
String sign = "";
String charset = "UTF-8";
content = content + keys;
try {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update(content.getBytes(charset));
sign = new String(Base64.encodeBase64(md.digest()), charset);
} catch (Exception e) {
throw new RuntimeException(e);
}
return sign;
}

Request Example

Content-Type application/javascript

{
    "boxNo": "#8640",
    "username": "DUMMY DUCK",
    "digest": "xxxxxxxxxxxxxxxxxx"
}

Response

Attribute	Type	Description
data	object	Outbound order result
success	boolean	See Status Codes
error	string	Error message

Data

Attribute	Type	Description
boxNo	string	Outbound order reference number
shipDatetime	date	Outbound date time
details	list	Merchandise details
trackingIds	list	Tracking number
carrier	string	Carrier

Details

Attribute	Type	Description
sku	string	SKU
upc	string	Barcode
quantity	integer	Quantity
lotNumber	string	Lot number
itemDescription	string	Item description
revisionNumber	string	Revision number
expiryDate	Date	Expiry date
conditionCode	string	Item condition
uomRatio	string	Uom ratio
uomQuantity	string	Uom quantity
packNumber	string	LPN number
packType	string	Pack type
serialNumbers	list	Serial numbers

Status Codes

Codes	Type	Description
true	SUCCESS	Successful
false	FAILURE	Failed

Successful Response Example

Response example - when requesting for specific order number

{
    "success": true,
    "data": {
        "boxNo": "#8640",
        "shipDatetime": "2022-08-10 02:09:59",
        "carrier": "Australia Post",
        "details": [
            {
                "sku": "DUMMY",
                "upc": "00000123456789",
                "quantity": 2,
                "itemDescription": "T-shirt",
                "conditionCode": "good",
                "uomQuantity": "2.0",
                "packNumber": "EPAC000111111",
                "packType": "22",
                "serialNumbers": [
                    "ABCD123456F0226",
                    "ABCD789011F0226"
                ]
            }
        ],
        "trackingIds": [
            "33D99999999999999"
        ]
    }
}

Response example - when requesting for multiple order under one PO Number

[
    {
        "success": true,
        "data": {
            "boxNo": "TEST25070803_001",
            "shipDatetime": "2025-07-28 11:49:10",
            "carrier": "",
            "details": [
                {
                    "sku": "DummySKU",
                    "upc": "DummyUPC",
                    "quantity": 10,
                    "itemDescription": "DummyDesc",
                    "conditionCode": "good",
                    "uomQuantity": "10.0",
                    "packNumber": "EPAC00000079356",
                    "packType": "5",
                    "serialNumbers": []
                },
                {
                    "sku": "DummySKU2",
                    "upc": "DummyUPC2",
                    "quantity": 5,
                    "itemDescription": "DummyDesc2",
                    "conditionCode": "good",
                    "uomQuantity": "10.0",
                    "packNumber": "EPAC00000079356",
                    "packType": "5",
                    "serialNumbers": []
                }
            ],
            "trackingIds": [
                null
            ]
        }
    },
    {
        "success": true,
        "data": {
            "boxNo": "TEST25070803_002",
            "shipDatetime": "2025-07-28 01:40:22",
            "carrier": "",
            "details": [
                {
                    "sku": "DummySKU",
                    "upc": "DummyUPC",
                    "quantity": 10,
                    "itemDescription": "DummyDesc",
                    "conditionCode": "good",
                    "uomQuantity": "10.0",
                    "packNumber": "EPAC00000079357",
                    "packType": "14",
                    "serialNumbers": []
                },
                {
                    "sku": "DummySKU2",
                    "upc": "DummyUPC2",
                    "quantity": 5,
                    "itemDescription": "DummyDesc2",
                    "conditionCode": "good",
                    "uomQuantity": "5.0",
                    "packNumber": "EPAC00000079357",
                    "packType": "14",
                    "serialNumbers": []
                }
            ],
            "trackingIds": [
                null
            ]
        }
    }
]

Failed Response Example

{
    "success": false,
    "error": "no data"
}

{
    "success": false,
    "error": "Non-existing Order."
}

{
    "success": false,
    "error": "Incorrect signature(digest)"
}

Shipment Details