# logistics.onPathUpdate
This documentation describes messages or events received on the server. For details, see Message Push.
Triggers a waybill trace update event. When the waybill trace is updated, the following data packets are generated. After receiving the event, enter success
or an empty string.
# Message Parameters
# Object
Property | Type | Description |
---|---|---|
ToUserName | string | The original ID of the Mini Program |
FromUserName | string | The openid of the sender |
CreateTime | number | The creation time of the message (integral) |
MsgType | string | Fixed event |
Event | string | Fixed add_express_path |
DeliveryID | string | The ID of the express company |
WayBillId | string | The ID of the waybill |
Version | number | The version number of the trace (integral) |
Count | number | The quantity of trace nodes (integral) |
Actions | Array.<Object> | The list of traces |
Actions is composed as follows
Property | Type | Description |
---|---|---|
ActionTime | number | Unix timestamp of the trace node |
ActionType | number | The type of the trace node |
ActionMsg | string | Details about the trace node |
Valid values of ActionType
Value | Description | Minimum Version |
---|---|---|
100001 | Pick-up — Picked up successfully | |
100002 | Pick-up — Pick-up failed | |
100003 | Pick-up — Assigning the courier | |
200001 | Transportation — Updating the transportation trace | |
300002 | Delivery — Starting the delivery | |
300003 | Delivery — Signed successfully | |
300004 | Delivery — Signing failed | |
400001 | Exception — Order canceled | |
400002 | Exception — Order delayed |
# Example of the Message Data Packet
In XML format
<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1546924844</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[add_express_path]]></Event>
<DeliveryID><![CDATA[SF]]></DeliveryID>
<WayBillId><![CDATA[123456789]]></WayBillId>
<Version>3</Version>
<Count>3</Count>
<Actions>
<ActionTime>1546924840</ActionTime>
<ActionType>100001</ActionType>
<ActionMsg><![CDATA[Picked up by Courier A]]></ActionMsg>
</Actions>
<Actions>
<ActionTime>1546924841</ActionTime>
<ActionType>200001</ActionType>
<ActionMsg><![CDATA[Arrived at the parcel gathering location of Guangzhou]]></ActionMsg>
</Actions>
<Actions>
<ActionTime>1546924842</ActionTime>
<ActionType>200001</ActionType>
<ActionMsg><![CDATA[Sent to the destination]]></ActionMsg>
</Actions>
</xml>
In JSON format
{
"ToUserName": "toUser",
"FromUserName": "fromUser",
"CreateTime": 1546924844,
"MsgType": "event",
"Event": "add_express_path",
"DeliveryID": "SF",
"WayBillId": "123456789",
"Version": 2,
"Count": 3,
"Actions": [
{
"ActionTime": 1546924840,
"ActionType": 100001,
"ActionMsg": "Picked up by Courier A"
},
{
"ActionTime": 1546924841,
"ActionType": 200001,
"ActionMsg": "Arrived at the parcel gathering location of Guangzhou"
},
{
"ActionTime": 1546924842,
"ActionType": 200001,
"ActionMsg": "Sent to the destination"
}
]
}