POST Dispatch Shipment

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

You can use dispatch shipment API to manifest the outbound order/shipment.

Request

Attribute Type Required Description
username string Required Jerry username
digest string Required Digest algorithm
sender_references array Required Order reference number
msgType string Required dispatchShipments
version string Optional Could be 1.0

Digest Algorithm

The digest algorithm is MD5 + base64 algorithm.

Example: digest = username + 1 + dispatchShipment + API password
String content = username + auPostShipmentsToJerryDto.getShipments().size() +
auPostShipmentsToJerryDto.getMsgType();
String digest = MD5Util.MD5Encode(content, auCustomer.getPassword());
//content = test1dispatchShipment
//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",
    "sender_references": "TEST000001",
    "msgType": "dispatchShipments",
    "digest": "xxxxxxxxxxxxx"
}

Response

Attribute Type Required Description
success boolean Required Result
message string Required Message
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,
    "message": "success",
    "code": 0
}
Copyright © EWE Group Pty Ltd 2022 all right reserved,powered by GitbookLast Modified 19-05-2023

results matching ""

    No results matching ""