POST Shipment Status

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

You can use shipment status API to check the outbound order status (whether the order has been shipped or not).

NOTE:

  1. Use this API to retrieve the tracking ID via the following field:

    • When product_id = WHDC, the field "article_ids" returned by getShipments API specifies the tracking IDs;
    • When product_id is not WHDC, the field "article_id" returned by getShipments API specifies the tracking ID.
  2. If the order is processed via Upimium, the tracking ID is also available via the shipmentDetails API.


Request

Attribute Type Required Description
username string Required Jerry username
password string Required API password
list list Required Article number, order reference number or EPAC number
Request Example

Content-Type application/javascript

{
    "username": "DUMMY DUCK",
    "password": "xxxxxxxxxxxxxxxx",
    "list": [
        "ABC123456789",
        "TEST0819001"
    ]
}

Response

Attribute Type Description
payload list Valid data load. Return array object
success boolean Status: True or False
message string Text messages

Payload

Attribute Type Required Description
is_packing integer Required Whether it has been packed or not. 0: No; 1:Yes 2:Cancelled
order_status integer Required Whether it has been checked weight or not. 0: No; 1:Yes 2:Cancelled
shipment_reference string Optional EPAC number
sender_references string Optional Order reference number
article_id string Optional Article number
checked_weight double Optional Checked weight
storage_time string Optional The time when ops team completes the outbound process
Successful Response Example
{
    "payload": [
        {
            "shipment_reference": "EPAC0001111111",
            "sender_references": "TEST0819001",
            "article_id": "ABC123456789",
            "is_packing": 1,
            "tracking_url": "",
            "order_status": 0
        }
    ],
    "success": true
}
Failed Response Example
{
    "message": "Incorrect user name or password",
    "success": false
}
Copyright © EWE Group Pty Ltd 2022 all right reserved,powered by GitbookLast Modified 19-05-2023

results matching ""

    No results matching ""