Item Snapshot Event

Item Snapshot Events can be any point of your delivery process (or Bridge) where the system takes a "snapshot" of the item and captures the details surrounding it.

Use this type of event to get data about the current state of an item at a given time (e.g., status, assignee, etc). This webhook also contains information about the future segments of an item (if any).

Also see: What is an Item?

{
    "id": "5c98cab3a78589390c5f11e1",
    "reference": "OIWNV",
    "trackingId": "9cc7096f-1554-4d33-820a-493da6650663",
    "parentItemId": null,
    "customProperties": [
        {
            "type": "ID",
            "name": "Invoice #",
            "codeName": "INVOICE_#",
            "value": "INV00333"
        }
    ],
    "service": {
        "name": "Afternoon",
        "codeName": "AFTERNOON_SVC",
        "color": "#3097ad"
    },
    "eta": {
        "from": "2019-03-26T13:00:00.00+08:00",
        "to": "2019-03-26T18:59:00.00+08:00"
    },
    "target": {
        "id": "5c75f760a7858914b82a64ec",
        "externalId": "CX00500",
        "company": "",
        "name": "Cassidy T'ang",
        "phone": "+6567986857",
        "email": "",
        "location": {
            "address1": "Block 825 Tampines St 81",
            "address2": null,
            "postalCode": "520825",
            "countryCode": "SG",
            "coordinates": {
                "latitude": 1.3494582,
                "longitude": 103.9328308,
                "accuracy": "ACCURATE"
            }
        }
    },
    "numberOfLineItems": 1,
    "counters": [],
    "majorState": "ONGOING",
    "statuses": [
        {
            "groupName": "Delivery Status",
            "groupCodeName": "LAST_MILE_STATUS",
            "value": {
                "name": "Picked up from WH",
                "codeName": "PICKED_UP_FROM_WH",
                "color": "#1bc7b2"
            }
        }
    ],
    "createdAt": "2019-03-25T20:33:55.60+08:00",
    "updatedAt": "2019-03-25T20:37:02.01+08:00",
    "currentSegment": {
        "id": "5c98cab3a78589390c5f11e7",
        "operator": {
            "id": "5bcd6d1946294818a42c37ea",
            "name": "3PL Express Inc",
            "codeName": null
        },
        "operatorRouteId": "5c98cb3d4629473918b20c16",
        "schedule": {
            "id": "3mosIGZg97U9/05rywp5slLFfPNquF2dtmcU84+pH5A="
        },
        "assignedResource": {
            "vehicle": {
                "id": "5c6b935946294717747fd819",
                "externalId": null,
                "name": "RXE13S"
            },
            "users": [
                {
                    "id": "5c0f65517554454d1c501ced",
                    "externalId": null,
                    "name": "John Driver"
                }
            ]
        },
        "steps": [
            {
                "sequence": 1,
                "id": "5c98cab3a78589390c5f11e8",
                "name": "Warehouse Pickup",
                "codeName": null,
                "state": "DONE",
                "slaWindow": {
                    "from": "2019-03-26T08:00:00.00+08:00",
                    "to": "2019-03-26T10:00:00.00+08:00"
                },
                "operatorWindow": {
                    "from": "2019-03-26T09:30:00.00+08:00",
                    "to": "2019-03-26T09:50:10.00+08:00"
                },
                "contact": {
                    "id": "5bcd709eb04f6c493c575525",
                    "externalId": "WH_NE01",
                    "company": "",
                    "name": "Central Warehouse",
                    "phone": "+6567504779",
                    "email": "",
                    "location": {
                        "address1": "130 Ang Mo Kio Avenue 3, Singapore",
                        "address2": null,
                        "postalCode": "560130",
                        "countryCode": "SG",
                        "coordinates": {
                            "latitude": 1.370334,
                            "longitude": 103.842153,
                            "accuracy": "ACCURATE"
                        }
                    }
                }
            },
            {
                "sequence": 2,
                "id": "5c98cab3a78589390c5f11e9",
                "name": "Deliver",
                "codeName": null,
                "state": "CURRENT",
                "slaWindow": {
                    "from": "2019-03-26T13:00:00.00+08:00",
                    "to": "2019-03-26T18:59:00.00+08:00"
                },
                "operatorWindow": {
                    "from": "2019-03-26T13:00:00.00+08:00",
                    "to": "2019-03-26T13:20:10.00+08:00"
                },
                "contact": {
                    "id": "5c75f760a7858914b82a64ec",
                    "externalId": "CX00500",
                    "company": "",
                    "name": "Cassidy T'ang",
                    "phone": "+6567986857",
                    "email": "",
                    "location": {
                        "address1": "Block 825 Tampines St 81",
                        "address2": null,
                        "postalCode": "520825",
                        "countryCode": "SG",
                        "coordinates": {
                            "latitude": 1.3494582,
                            "longitude": 103.9328308,
                            "accuracy": "ACCURATE"
                        }
                    }
                }
            }
        ]
    },
    "futureSegments": []
}

Response Parameters

id

The order details and properties of the item

reference

Zyllem reference number for the item (5-digit alphanumeric code)

trackingId

Public tracking URL of the item which can be sent to customers

parentItemId

For items booked via E2E, the unique Id of the item in the parent enterprise (generated by Zyllem)

customProperties

Custom properties of the item specified upon booking

service

The service specified upon booking

eta

The ETA window (estimated time of arrival window) based on the system's calculation

target

Contact details of the item's destination

numberOfLineItems

Number of line items in the order

counters

Counters associated to the item and their value

majorState

Major state of the item (e.g., ONGOING, CLOSED)

statuses

Status of the item

createdAt

Date and time when the item was booked in Zyllem

updatedAt

Date and time when the item was last updated (e.g., when the last action was peformed)

currentSegment

The segment that is currently associated to the item (where the item is at).

futureSegments

(Object array). Forecasted segments of the item if any (e.g., if this is the first-mile, future segments would include the last-mile segment).