Item Assignment Event

Item Assignment Events occur when an item is assigned, reassigned, or unassigned (whether manually or automatically).

Use this type of event to get data about an items assignment (e.g., vehicle name and ID, user name and ID, etc).

Also see: What is an Item?

{
    "itemInfo": {
        "id": "5c98cab3a78589390c5f11e1",
        "reference": "OIWNV",
        "trackingId": "9cc7096f-1554-4d33-820a-493da6650663",
        "parentItemId": null,
        "customProperties": [
            {
                "type": "ID",
                "name": "Invoice #",
                "codeName": "INVOICE_#",
                "value": "INV00333"
            }
        ],
        "service": {
            "name": "11AM-2PM (1ST)",
            "codeName": "1ST_SVC",
            "color": "#9f33c4"
        },
        "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": null
            }
        ]
    },
    "segment": {
        "id": "5c98cab3a78589390c5f11e7",
        "operator": {
            "id": "5bcd6d1946294818a42c37ea",
            "name": "3PL Express Inc",
            "codeName": null
        },
        "operatorRouteId": "5c98cb3d4629473918b20c16",
        "schedule": {
            "id": "3mosIGZg97U9/05rywp5slLFfPNquF2dtmcU84+pH5A="
        },
        "assignedResource": {
            "vehicle": {
                "id": "5c6b935946294717747fd819",
                "externalId": "RXE13S",
                "name": "RXE13S"
            },
            "users": [
                {
                    "id": "5c0f65517554454d1c501ced",
                    "externalId": null,
                    "name": "John Driver"
                }
            ]
        },
        "steps": [
            {
                "sequence": 1,
                "id": "5c98cab3a78589390c5f11e8",
                "name": "Warehouse Pickup",
                "codeName": null,
                "state": "CURRENT",
                "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": "PENDING",
                "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"
                        }
                    }
                }
            }
        ]
    },
    "assignmentBy": {
        "id": "5bcd6f7d46294818a42c3819",
        "externalId": null,
        "name": "Rose Buen"
    },
    "assignmentAt": "2019-03-25T20:36:13.83+08:00"
}

Response Parameters

itemInfo

Details of the item being assigned

segment

The segment associated to the item at the point of assignment

assignmentBy

The user who assigned the item to the asset

assignmentAt

Date and time when the item was assigned to the asset

See full list of Response Parameters