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
reason	string	Required	Cancel reason

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
Shipments	array	Optional
error	array	Required	Errors
code	integer	Required	See Return Codes

Return Codes

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

Successful Response Example

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

Failed Response Example

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

results matching ""

No results matching ""