POST Stock Synchronization (Webhook)

When the stock changes in Jerry, this API will notify you of the change in details. You must provide us with the URL to receive the notifications.

NOTE:

This is a call back API sending you all the stock changes, including the following 3 types:
- Stock changes due to inbound order received;
- Stock changes due to outbound order shipped;
- Stock changes due to manual adjustments.
The message field changeType flags which type it is.
The message will be sent out once the stock change happens. You can use Stock Sync API message as the instant order fulfilment confirmation.
If you want to retrieve more fulfilment details such as lot number, serial number, you will need to refer to Receipt Details API for ASN or Shipment Details API for outbound order.
Retry up to 7 times (10s per retry) if the message fails to be delivered.

Request

Attribute	Required	Description
userName	Required	Jerry username
apiPassword	Required	API password
goods	Required	Stock data of product
sign	Required	Stock data of product

Goods

Attribute	Type	Required	Description
time	string	Required	Stock change time: yyyy-MM-dd HH:mm:ss [UTC time]
stockChangeId	integer	Required	Unique Stock change ID
upc	string	Required	Barcode of product
qty	integer	Required	The number of inventory changes
flag	integer	Required	1 means outbound, 2 means inbound
changeType	string	Required	When flag is 1: 101 Outbound 102：Warehouse adjustment (deduction) When flag is 2: 200：Inbound 201：Outbound cancellation 202：Warehouse adjustment (addition)
businessNo	string	Optional	It is the BoxNo when changeType is 101, 200 or 201; otherwise it is empty
reason	string	Optional	Reason for change
lotNumber	string	Optional	Lot number
seq	integer	Optional	Serial Number
itemProperties	string	Optional	Item conditions: Good, Damaged

changeType

Status	Type	Description
101	string	Outbound
201	string	Inbound
102	string	Stock Adjustment – Decrease
202	string	Stock Adjustment – Increase
0	string	Unknown

NOTE: There will be multiple changes when there are numerous item change the stock under a single order.

Digest Algorithm </a>

The digest algorithm is MD5.

Example: digest = $USERNAME+$APIPASSWORD+goods+key

Request Example

Content-Type `application/json

{
    "userName": "DUMMY DUCK",
    "apiPassword": "xxxxxxxxxxxx",
    "goods": [
        {
            "time": "2022-09-01 10:25:40",
            "stockChangeId": 14556,
            "upc": "99999992222",
            "qty": "2",
            "reason": "out reason",
            "changeType": "101",
            "businessNo": "ATW198274921",
            "flag": "1",
            "lotNumber": "batch123456"
            "seq": null,
            "itemProperties": “good”
        },
        {
            "time": "2022-09-02 10:25:40",
            "stockChangeId": 14557,
            "upc": "888888888888",
            "qty": "2",
            "reason": "in reason",
            "changeType": "201",
            "businessNo": "ATW198274922",
            "flag": "2"
        }
    ],
    "sign": "a8a7f8eae357b9c6b23d3c99ec18b2e3"
}

Response

Attribute	Description
SUCCESS	Successful
FAIL	Failed

Response Example

SUCCESS

Stock Synchronization (Webhook)