Item Activity Event

Item Activity Event occurs when an action is performed on an item, such as when a button is pressed (e.g., driver taps on 'Deliver' button)

Use this type of event to get data surrounding an action that has been performed on an item (e.g., time compliance, location compliance, artifacts, etc.)

Also see: What is an Item?

{
    "id": "5c98cab3a78589390c5f11e9",
    "itemId" : "624a83625fed716464491646",
    "step": {
        "id": "5c98cab3a78589390c5f11e9",        
        "name": "Deliver",
        "codeName": null,
        "state": "DONE",
        "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"
                }
            }
        }
    },
    "assignee": {
        "vehicle": {
            "id": "5c6b935946294717747fd819",
            "externalId": null,
            "name": "RXE13S"
        },
        "users": [
            {
                "id": "5c0f65517554454d1c501ced",
                "externalId": null,
                "name": "John Driver"
            }
        ]
    },
    "operator": {
        "id": "5bcd6d1946294818a42c37ea",
        "name": "3PL Express Inc",
        "codeName": null
    },
    "action": {
        "type": "NORMAL",
        "id": "5c0f640e7554454d1c501bb7",
        "name": "Full Delivery",
        "codeName": null
    },
    "artifacts": [
        {
            "type": "CASH_COLLECTION",
            "name": "COD",
            "codeName": "COD",
            "cash": {
                "value": 2300,
                "currency": "SGD"
            }
        },
        {
            "type": "FORM",
            "name": "Additional Info",
            "codeName": "ADDITIONAL_INFO",
            "fields": [
                {
                    "type": "OPTIONS",
                    "sequence": 1,
                    "name": "Delivery Type",
                    "codeName": "DELIVERY_TYPE",
                    "selections": [
                        {
                            "key": "NORMAL_DELIVERY",
                            "value": "Normal Delivery"
                        }
                    ]
                },
                {
                    "type": "OPTIONS",
                    "sequence": 2,
                    "name": "Payment Type",
                    "codeName": "PAYMENT_TYPE",
                    "selections": [
                        {
                            "key": "CASH",
                            "value": "Cash"
                        }
                    ]
                },
                {
                    "type": "TEXT",
                    "sequence": 3,
                    "name": "Additional Bldg Info",
                    "codeName": "ADDTL_BLDG_INFO",
                    "value": "all good"
                }
            ]
        },
        {
            "type": "CUSTOMER_SATISFACTION_MOBILE",
            "name": "App Customer Sat Survey",
            "codeName": "APP_CUST_SAT",
            "value": 4,
            "callRequested": false
        },
        {
            "type": "SIGNATURE",
            "name": "Recipient Signature",
            "codeName": "RECIPIENT_SIGNATURE",
            "isPhotoSign": true,
            "link": "https://any.zyllem.com/Analytics/Artifact/5c98cbbda7858a5de80a6338"
            "token" : "xjshe80abdffuande80asedDodmwcusnsufjkjlksieunncyueywuicn83nc743j4nfn"
        }
    ],
    "compliance": {
        "performedBy": {
            "id": "5c0f65517554454d1c501ced",
            "externalId": null,
            "name": "John Driver"
        },
        "performedAt": "2019-03-25T20:38:08.00+08:00",
        "minutesToSlaWindow": -982,
        "minutesToOperatorWindow": -982,
        "coordinates": {
            "latitude": 1.29948937,
            "longitude": 103.78618699,
            "accuracy": "ACCURATE"
        },
        "positionRequired": true,
        "metersFromLocation": 17223
    },
    "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-25T20:38:08.00+08:00",
            "to": "2019-03-25T20:38:08.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"
                }
            }
        },
        "counters": [],
        "majorState": "CLOSED",
        "statuses": [
            {
                "groupName": "Delivery Status",
                "groupCodeName": "LAST_MILE_STATUS",
                "value": {
                    "name": "Full delivery",
                    "codeName": "FULL_DELIVERY",
                    "color": "#1bc7b2"
                }
            }
        ]
    },
    "lineItems": [
        {
            "id": "5cf4ecef48b9fa4ac44c37df",
            "reference": "CSMYC.1",
            "number": 1,
            "code": "MOON",
            "description": "Strawberry",
            "quantity": 19,
            "adjustedQuantity": 16,
            "customProperties": []
        }
    ],
    "childItemId": null,
    "executedOnChildItem": false
}

Response Parameters

id

Unique Id of the item activity (generated by Zyllem)

itemId

Unique Id of the item (generated by Zyllem)

step

The step (task) where the action was performed on

assignee

The assets (vehicle and users) assigned to the segment or item

operator

The operator assigned to the segment of the step where the action was performed on

action

The action performed on the item

artifacts

The artifacts (action inputs) that were collected when the action was performed

compliance

Time and location compliance of the user when he performed the action.

itemInfo

The order details and properties of the item

lineItems

Line items included in the order (specified upon booking) and their remaining quantity after the action was performed

childItemId

For EXCEPTION actions that result in child items, the unique Id of that child item (generated by Zyllem). Read more about Types of Actions.

executedOnChildItem

If the action was performed on the child item (that resulted from an EXCEPTION action), this value will be true. If it was performed on the parent item (that was originally booked), it will be false.

See full list of Response Parameters