Shipment Change
Represents a shipment that is created, changed, or deleted.
Event Name
ShipmentChanged
Supported Events
The supported shipment change events are as follows:
- Occurs for all changes made to Dispatch Pro shipments
Payload
Within an event, there are multiple pieces of information sent as outlined in the table below.
| Key | Type | Description |
|---|---|---|
| kind | string | The kind represents the type of event being registered. This includes the item which is being acted upon as well as the event being registered. |
| id | guid | The reference id of the object that has changed. |
| [varies per event type] | [varies per event type] | The data that is changing for the given event type. It can be a key value string or a complex object. It also could be multiple it items. |
| metadata | metadata object | Information regarding the initiator of the event. This includes the: version of the object, dateTime it was changed, user of whom performed the change, and the organizationId upon which the change was performed. |
Example Payloads
Under construction.