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 Name

Description

type

Type of action (i.e., NORMAL, EXCEPTION, CANCEL, RE-ROUTE, TRACE)

id

Unique Id of action (generated by Zyllem)

name

Display name of action

codeName

Code 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

type

Type of artifact (e.g., OPTIONS, FORM, CASH_COLLECTION, SIGNATURE)

name

Display name of artifact

codeName

Code name of artifact (used for E2E or integration)

cash

For CASH_COLLECTION artifacts, the value and currency of cash collected

value

For CUSTOMER_SATISFACTION artifacts, the satisfaction rating of the respondent. For USER_INPUT or TEXT artifacts, the value entered by the user.

callRequested

For CUSTOMER_SATISFACTION artifacts: if the 'Call me' option was selected, this value will be true; otherwise it will be false.

fields

For FORM artifacts, the series of fields in the form

selections

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

isPhotoSign

For SIGNATURE artifacts, this value will be true if a photosignature was required; false if only signature was required.

link

For 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

vehicle

Vehicle 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 Name

Description

vehicle

Vehicle assigned to the segment or item

users

User(s) assigned to the segment or item

assignmentBy

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

Field Name

id

Unique Id of user (generated by Zyllem)

externalId

External Id of user

name

Display name of user

cash

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

Field Name

Description

value

Value or amount of cash

currency

Currency 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 Name

Description

performedBy

User who performed the action

performedAt

Date and time when action was performed

minutesToSlaWindow

How 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.

minutesToOperatorWindow

How 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).

coordinates

Geolocation of the user when he performed the action

positionRequired

If geolocation was required for the action, this value will be true; otherwise it will be 'false'. This setting is configured in the Bridge.

metersFromLocation

How 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 Name

Description

id

Unique 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.

externalId

External Id of contact

company

Company name of contact

name

Name of contact

phone

Phone number of contact

email

Email address of contact

location

Address details of contact

coordinates

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

Field Name

Description

latitude

Latitude coordinates

longitude

Longitude coordinates

accuracy

Accuracy 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

name

Display name of counter

codeName

Code name of counter (used for E2E or integration)

value

Value of the counter

currentSegment

Object. The segment where the item is currently at.

Field Name

Description

id

The unique ID of the segment (generated by Zyllem)

operator

The operator assigned to the segment

operatorRouteId

The unique Id of the route (aka bundle) assigned to the operator. If segment is unassigned, this value will be null.

assignedResource

The assets (vehicles and users) assigned to the segment

steps

The series of steps (tasks) within the segment

customProperties

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

Field Name

type

Type of custom property (e.g., ID, TEXT, NUMERIC, MONEY)

name

Display name of custom property

codeName

Code name of custom property (used for E2E or integration)

value

Value 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

type

Type of field (e.g., NUMERIC, MONEY, OPTIONS, TEXT)

sequence

The order of the field within the form. If this is the first field, the value will be 1.

name

Display name of field

codeName

Code name of field

value

For NUMERIC, MONEY, and TEXT fields, the value entered by the user

selections

For 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 Name

Description

id

Zyllem's unique Id for the item (generated upon booking)

externalId

The unique ID of the item on the client side (specified upon booking and is unique across your enterprise).

reference

Zyllem's reference number for the item. This not a unique reference (5-digit alphanumeric code).

trackingId

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

parentItemId

For EXCEPTION actions that result in child items,
the unique Id of the parent item that was booked (generated by Zyllem)

customProperties

Custom properties of the item specified upon booking

service

The service specified upon booking

scheduledEta
(previously 'eta')

The Scheduled ETA (or SLA) of the item.

target

Contact details of the item's destination

numberOfLineItems

Number of line items in the order

counters

Counters associated to the item

majorState

Major state of the item (e.g., ONGOING, CLOSED). Read more about Major States of Items in Zyllem Help Center.

statuses

Status of the item

lineItems

Object array. Line items included in the order

Field Name

Description

id

Unique Id of the line item (generated by Zyllem)

reference

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

number

The order of the line item within the order. If this is the first line item, the value will be 1.

code

Code of the line item specified upon booking

description

Description of the line item specified upon booking

quantity

Quantity of the line item specified upon booking

adjustedQuantity

Quantity of the line item after the action was performed (e.g. if 3 out of 10 were selected, this value will be 3).

customProperties

Custom properties of the line item specified upon booking

location

Object. Address details of the contact

Field Name

Description

address1

Fully qualified address

address2

Supplementary address (e.g., unit #)

postalCode

Postal code of the address

countryCode

Country code of the address

coordinates

Geolocation of the address

operator

Object. The operator assigned to the segment or item

Field Name

Description

id

Unique Id of operator (generated by Zyllem)

name

Display name of operator

codeName

Code 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 Name

Description

from

Start date and time of operator window

to

End date and time of operator window

performedBy

Object. User who performed the action

Field Name

Description

id

Unique Id of user (generated by Zyllem)

externalId

External Id of user (generated by Zyllem)

name

Display name of user

schedule

Object. Schedule of the operator

Field Name

Description

scheduleId

Same 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 Name

Description

from

start time of the Scheduled ETA window

to

end time of the Scheduled ETA window

segment

Object. Details of the segment as defined in the Bridge

Field Name

Description

id

Unique Id of the segment (generated by Zyllem)

operator

The operator assigned to the segment

operatorRouteId

Unique Id of the route (bundle) assigned to the operator. If segment is unassigned, this value will be null.

schedule

Same 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.

assignedResource

The assets (vehicles and users) assigned to the segment

steps

The steps (tasks) involved in the segment

service

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

Field Name

Description

name

Name of service

codeName

Code name of service

color

Display 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 Name

Description

from

Start date and time of SLA window

to

End 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 Name

Description

groupName

Display name of the status group. What is a Status Group?

groupCodeName

Code name of the status group (used for E2E or integration)

value

Status of the item

(Status) value

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

Field Name

Description

name

Display name of the status

codeName

Code name of the status (used for E2E or integration)

color

Display color of the status (in HEX code)

selections

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

Field Name

Description

key

Unique key of the option

value

Value 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 Name

Description

sequence

The order of the step in the segment. E.g., if the first step is 'pickup', its sequence will be '1'.

id

Unique Id of step (generated by Zyllem)

name

Display name of step (i.e., task name in the Bridge)

codeName

Code name of step (used for E2E or integration)

state

State 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.

slaWindow

Click to see details.

operatorWindow

Click to see details.

contact

Click to see details.

assignee

Click to see details.

operator

Click to see details.

action

Click to see details.

artifacts

Click to see details.

compliance

Click to see details.

itemInfo

Click to see details.

lineItems

Click to see details.

childItemId

Click to see details.

executedOnChildItem

Click to see details.

target

Object. Contact details of the item's destination

Field Name

Description

id

Contact Id based on the Address Book. If contact is not in the Address Book, this value will be auto generated by Zyllem.

externalId

External Id of contact

company

Company name of contact

name

Name of contact

phone

Phone number of contact

email

Email address of contact

location

Address 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 Name

Description

id

Unique Id of the user (generated by Zyllem)

externalId

External Id of the user (used for E2E or integration)

name

Display 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 Name

Description

id

Unique Id of the vehicle (generated by Zyllem).

externalId

External Id of the vehicle (used for E2E or integration)

name

Display name of the vehicle assigned to the segment.