The Delivery Object

The Object

Attribute

Description

*id

stringrequired

It is a unique 32 characters string

*createdAt

stringrequired

Date and time of the visit checkin, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds)

*type string

This is an immutable field which indicates the type of the object. In this case 'delivery'

event

string

Only used by Webhook Endpoint

pictureUrl string

The url of the delivery picture

message

string

Optional message dropped by the deliveryman

hosts

array

An array of The Host Object

notes

string

Private notes of the delivery

Short Sample

{
"id":"6F2A1988-AC8B-458E-A447-4F852A7BB95E",
"type":"delivery",
"createdAt":"2019-09-04T11:30:08-03:00",
"message": "Your pizza",
"hosts":[
{
"type":"host",
"id":"142e81feb92c0a66ee70fd7f4e57a28d",
"email":"alisson@w3lcome.com",
"name":"Alisson Enz Rossi",
"position":"CTO",
"sector":"IT",
"phone":"(43) 99982-0420",
"countryCode":"+55"
}
]
}

Available Methods

Coming soon