POST Cancel Shipment

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

You can use cancel shipment API to cancel the outbound order/shipment.

NOTE: AUS POST Return orders cannot be canceled.

Request

Attribute	Type	Required	Description
username	string	Required	Jerry username
digest	string	Required	Digest algorithm
msgType	string	Required	Should be cancelShipment
version	string	Optional	Could be 1.6
referenceNo	string	Required	The order reference number
poNumber	string	Required if referenceNo is not provided	PO number
reason	string	Required	Cancel reason

Either referenceNo 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 + cancelShipment + API password

String content = username + auPostShipmentsToJerryDto.getMsgType();
String digest = MD5Util.MD5Encode(content, auCustomer.getPassword()); 
//content = testcancelShipment
//keys = 123456
public static String MD5Encode(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

{
    "username": "DUMMY",
    "digest": "xxxxxxxxxxxxxxx",
    "msgType": "cancelShipment",
    "version": "1.6",
    "articleId": "ABC201931801000934508",
    "referenceNo": "ters213132",
    "reason": "Cancel"
}

Response

Attribute	Type	Required	Description
success	blooean	Optional
successful	blooean	Optional
message	string	Optional
successShipments	list	Optional	Lists successfully cancelled shipments when requested by poNumber.
errorShipments	list	Optional	Lists shipments that failed to cancel when requested by poNumber.
code	integer	Required	See Return Codes

Return Codes

When you use referenceNo to request.

Return Codes	Description
0	Successful
1	Unknown error
2	Service is temporarily unavailable
3	Unsupported open API method
10	Invalid parameter
30	Partial successful
31	Fully failed
101	Invalid API key
104	Incorrect signature

Successful Response Example

1. Response example - when requesting to cancel referenceNo

{
    "success": true,
    "successful": true,
    "message": "Shipment canceled!",
    "code": 0
}

2. Response example - when requesting to cancel poNumber

{
    "success": true,
    "successful": true,
    "code": 0,
    "errorShipments": {},
    "successShipments": [
        "TEST20082025_001CANCEL20250821022802",
        "TEST20082025_002CANCEL20250821022802"
    ]
}

Failed Response Example

{
    "success": false,
    "successful": false,
    "message": "Wrong box number：ABC201931801000934508",
    "code": 10
}

{
    "success": false,
    "successful": false,
    "message": "Non-existing Order.",
    "code": 1
}

3.Mixed Response - Cancellation under the same poNumber, some may succeed while others fail.

{
    "success": false,
    "successful": false,
    "code": 30,
    "errorShipments": {
        "200820251240_002": "itf100108: -75: Parse Import File error: Order cannot be cancelled"
    },
    "successShipments": [
        "200820251240_001CANCEL20250821023214"
    ]
}

{
    "success": false,
    "successful": false,
    "message": "Wrong signature",
    "code": 104
}

Cancel Shipment