Response Parameters

List of response parameters for Legacy API and Legacy Webhooks

action

Object The action performed on the item. Read more about Types of Actions in Zyllem Help Center.

Field NameDescription
typeType of action (i.e., NORMAL, EXCEPTION, CANCEL, RE-ROUTE, TRACE)
idUnique Id of action (generated by Zyllem)
nameDisplay name of action
codeNameCode name of action (used in E2E or integration)

artifacts

Object array. The artifacts (signatures, photos, etc) that were collected when the action was performed. Read more about Types of Artifacts in Zyllem Help Center.

Field Name
typeType of artifact (e.g., OPTIONS, FORM, CASH_COLLECTION, SIGNATURE)
nameDisplay name of artifact
codeNameCode name of artifact (used for E2E or integration)
cashFor CASH_COLLECTION artifacts, the value and currency of cash collected
valueFor CUSTOMER_SATISFACTION artifacts, the satisfaction rating of the respondent. For USER_INPUT or TEXT artifacts, the value entered by the user.
callRequestedFor CUSTOMER_SATISFACTION artifacts: if the 'Call me' option was selected, this value will be true; otherwise it will be false.
fieldsFor FORM artifacts, the series of fields in the form
selectionsFor OPTIONS artifacts, the option(s) selected by the user
isPhotoSignFor SIGNATURE artifacts, this value will be true if a photosignature was required; false if only signature was required.
linkFor all image artifacts (e.g., SIGNATURE, PHOTO), the URL or link to the image

assignedResource

Object. The assets (vehicles and users) assigned to the segment or item

Field Name
vehicleVehicle assigned to the segment or item
users User(s) assigned to the segment or item

assignee

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

Field NameDescription
vehicleVehicle assigned to the segment or item
usersUser(s) assigned to the segment or item

assignmentBy

Object. The user who assigned the segment or item to the operator or asset

Field Name
idUnique Id of user (generated by Zyllem)
externalIdExternal Id of user
nameDisplay name of user

cash

Object. For CASH_COLLECTION artifacts, the value and currency of cash collected

Field NameDescription
valueValue or amount of cash
currencyCurrency of cash

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.

compliance

Object. User's time and location compliance when he performed the action.

Field NameDescription
performedByUser who performed the action
performedAtDate and time when action was performed
minutesToSlaWindowHow early or late the user performed the action based on the slaWindow. If user performed it earlier, value will be negative; if later, it will be positive (e.g., -10 means user performed it 10 min earlier than the slaWindow start time.
minutesToOperatorWindowHow early or late the user performed the action based on the operatorWindow. If user performed it earlier, value will be negative; if later, it will be positive (e.g., -10 means user performed it 10 min earlier than the operatorWindow start time).
coordinatesGeolocation of the user when he performed the action
positionRequiredIf geolocation was required for the action, this value will be true; otherwise it will be 'false'. This setting is configured in the Bridge.
metersFromLocationHow far the user was from the expected location when he performed the action (e.g., 100 means user performed it 100 meters away from the step geolocation).

contact

Object. Contact details associated to the step (task) or item. Details are based on the Address Book or source.

Field NameDescription
idUnique Id of the contact. If contact is found in the Address Book, this is the Contact Id; otherwise, this value will be auto generated by Zyllem.
externalIdExternal Id of contact
companyCompany name of contact
nameName of contact
phonePhone number of contact
emailEmail address of contact
locationAddress details of contact

coordinates

Object. Geolocation of the address record or the user when he performed the action

Field NameDescription
latitudeLatitude coordinates
longitudeLongitude coordinates
accuracyAccuracy of the geolocation (e.g., ACCURATE, APPROXIMATE, etc). Read more about Location Accuracy in Zyllem Help Center.

counters

Object. Counters associated to the item (defined in the enterprise portal). Read more about Counters in Zyllem Help Center.

Field Name
nameDisplay name of counter
codeNameCode name of counter (used for E2E or integration)
valueValue of the counter

currentSegment

Object. The segment where the item is currently at.

Field NameDescription
idThe unique ID of the segment (generated by Zyllem)
operatorThe operator assigned to the segment
operatorRouteIdThe unique Id of the route (aka bundle) assigned to the operator. If segment is unassigned, this value will be null.
assignedResourceThe assets (vehicles and users) assigned to the segment
stepsThe series of steps (tasks) within the segment

customProperties

Object array. Custom properties of the item or line item specified upon booking

Field Name
typeType of custom property (e.g., ID, TEXT, NUMERIC, MONEY)
nameDisplay name of custom property
codeNameCode name of custom property (used for E2E or integration)
valueValue of the custom property

eta

See scheduledEta

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.

fields

Object array. For FORM artifacts, the series of fields in the form

Field Name
typeType of field (e.g., NUMERIC, MONEY, OPTIONS, TEXT)
sequenceThe order of the field within the form. If this is the first field, the value will be 1.
nameDisplay name of field
codeNameCode name of field
valueFor NUMERIC, MONEY, and TEXT fields, the value entered by the user
selectionsFor OPTIONS fields, the option(s) selected by the user

itemInfo

Object. The order details and properties of the item. This also applies to the response of GET /items/{id}

Field NameDescription
idZyllem's unique Id for the item (generated upon booking)
externalIdThe unique ID of the item on the client side (specified upon booking and is unique across your enterprise).
referenceZyllem's reference number for the item. This not a unique reference (5-digit alphanumeric code).
trackingIdPublic tracking URL of the item which can be sent to customers
parentItemIdFor EXCEPTION actions that result in child items,
the unique Id of the parent item that was booked (generated by Zyllem)
customPropertiesCustom properties of the item specified upon booking
serviceThe service specified upon booking
scheduledEta
(previously 'eta')
The Scheduled ETA (or SLA) of the item.
targetContact details of the item's destination
numberOfLineItemsNumber of line items in the order
countersCounters associated to the item
majorStateMajor state of the item (e.g., ONGOING, CLOSED). Read more about Major States of Items in Zyllem Help Center.
statusesStatus of the item

lineItems

Object array. Line items included in the order

Field NameDescription
idUnique Id of the line item (generated by Zyllem)
referenceZyllem reference number for the line item (5-digit alphanumeric code)
numberThe order of the line item within the order. If this is the first line item, the value will be 1.
codeCode of the line item specified upon booking
descriptionDescription of the line item specified upon booking
quantityQuantity of the line item specified upon booking
adjustedQuantityQuantity of the line item after the action was performed (e.g. if 3 out of 10 were selected, this value will be 3).
customPropertiesCustom properties of the line item specified upon booking

location

Object. Address details of the contact

Field NameDescription
address1Fully qualified address
address2Supplementary address (e.g., unit #)
postalCodePostal code of the address
countryCodeCountry code of the address
coordinatesGeolocation of the address

operator

Object. The operator assigned to the segment or item

Field NameDescription
idUnique Id of operator (generated by Zyllem)
nameDisplay name of operator
codeNameCode name of operator (used for E2E or integration)

operatorWindow

Object. Also known as the Forecasted ETA of the item. This is usually a narrow time window within the slaWindow, and is calculated by the routing algorithm taking into consideration the item's SLA, driver's route and schedule.

Field NameDescription
fromStart date and time of operator window
toEnd date and time of operator window

performedBy

Object. User who performed the action

Field NameDescription
idUnique Id of user (generated by Zyllem)
externalIdExternal Id of user (generated by Zyllem)
nameDisplay name of user

schedule

Object. Schedule of the operator

Field NameDescription
scheduleIdSame as "shift Id". The unique Id of the operator schedule (generated by Zyllem)

scheduledEta

Previously eta

Object. The Scheduled ETA (or SLA) of the item. How is Scheduled ETA calculated?

Field NameDescription
fromstart time of the Scheduled ETA window
toend time of the Scheduled ETA window

segment

Object. Details of the segment as defined in the Bridge

Field NameDescription
idUnique Id of the segment (generated by Zyllem)
operatorThe operator assigned to the segment
operatorRouteIdUnique Id of the route (bundle) assigned to the operator. If segment is unassigned, this value will be null.
scheduleSame as "shift". The operator schedule that this segment is allotted in (generated by Zyllem). If the segment is unassigned or if shift is not enabled, this value will be null.
assignedResourceThe assets (vehicles and users) assigned to the segment
stepsThe steps (tasks) involved in the segment

service

Object. The service specified upon booking. Read more about Service in Zyllem Help Center.

Field NameDescription
nameName of service
codeNameCode name of service
colorDisplay color of service (in HEX code)

slaWindow

Object. Also known as the Scheduled ETA of the item. This is determined by the system upon booking, based on your configuration. If you reschedule an item, its slaWindow will change accordingly to the new date and time you have selected. When the system calculates the operatorWindow, it will try to adhere to this slaWindow.

Field NameDescription
fromStart date and time of SLA window
toEnd date and time of SLA window

statuses

Object. Status and status group of the item (defined in the enterprise portal). Read more about Item Status and Status Groups in Zyllem Help Center.

Field NameDescription
groupNameDisplay name of the status group. What is a Status Group?
groupCodeNameCode name of the status group (used for E2E or integration)
valueStatus of the item

(Status) value

Object. Status of the item. Read more about Item Status and Status Groups in Zyllem Help Center.

Field NameDescription
nameDisplay name of the status
codeNameCode name of the status (used for E2E or integration)
colorDisplay color of the status (in HEX code)

selections

Object array. For OPTIONS artifacts, the option(s) selected by the user.

Field NameDescription
keyUnique key of the option
valueValue or name of the option

steps

Object array. The series of steps (or tasks) within a segment.

step

Object. The step (task) associated to the action

Field NameDescription
sequenceThe order of the step in the segment. E.g., if the first step is 'pickup', its sequence will be '1'.
idUnique Id of step (generated by Zyllem)
nameDisplay name of step (i.e., task name in the Bridge)
codeNameCode name of step (used for E2E or integration)
stateState of the step. This value will be CURRENT if it is the current step that needs to be performed; PENDING if it is the next or a future step that needs to be performed; DONE if the step has been performed.
slaWindowClick to see details.
operatorWindowClick to see details.
contactClick to see details.
assigneeClick to see details.
operatorClick to see details.
actionClick to see details.
artifactsClick to see details.
complianceClick to see details.
itemInfoClick to see details.
lineItemsClick to see details.
childItemIdClick to see details.
executedOnChildItemClick to see details.

target

Object. Contact details of the item's destination

Field NameDescription
idContact Id based on the Address Book. If contact is not in the Address Book, this value will be auto generated by Zyllem.
externalIdExternal Id of contact
companyCompany name of contact
nameName of contact
phonePhone number of contact
emailEmail address of contact
locationAddress details of the contact

users

Object array. User(s) assigned to the segment or item. If the segment or item is unassigned, all values will be null.

Field NameDescription
idUnique Id of the user (generated by Zyllem)
externalIdExternal Id of the user (used for E2E or integration)
nameDisplay name of the user

vehicle

Object. Vehicle assigned to the segment or item. If the segment or item is unassigned, all values will be null. This value will also be null if the segment or item is assigned to a lane that does not have any vehicle or users defined.

Field NameDescription
idUnique Id of the vehicle (generated by Zyllem).
externalIdExternal Id of the vehicle (used for E2E or integration)
nameDisplay name of the vehicle assigned to the segment.