On Cancel

Callback Response to cancel. This is called after order has been cancelled.

Request:

Context:

See Context

Message:

Example:

{
"context": {
"domain": "FINAL-MILE-DELIVERY",
"action": "string",
"version": "string",
"transaction_id": "string",
"session_id": "string",
"timestamp": "2020-07-08T08:06:44.888Z",
"token": "string",
"status": "string"
},
"message": {
"service": {
"order": {
"id": "string",
"state": "string",
"billing": {
"person": {
"title": "Mr",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"full_name": "string",
"image": {
"format": "url",
"data": "string"
},
"dob": "2020-07-08",
"gender": "male",
"contact": {
"email": "user@example.com",
"mobile": {
"country_code": "string",
"number": "string"
},
"landline": {
"country_code": "string",
"std_code": "string",
"number": "string",
"extension": "string"
}
}
},
"location": {
"type": "gps",
"gps": {
"lat": "string",
"lon": "string",
"format": "string"
},
"address": {
"door": "string",
"building": "string",
"street": "string",
"locality": "string",
"ward": "string",
"city": "string",
"state": "string",
"country": "string",
"area_code": "string"
},
"station_code": "string",
"area_code": "string",
"city": {
"name": "string",
"code": "string"
},
"country": {
"name": "string",
"code": "string"
},
"circle": {
"lat": "string",
"lon": "string",
"format": "string",
"radius": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string"
},
"form": "string"
},
"fulfillment": {
"person": {
"title": "Mr",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"full_name": "string",
"image": {
"format": "url",
"data": "string"
},
"dob": "2020-07-08",
"gender": "male",
"contact": {
"email": "user@example.com",
"mobile": {
"country_code": "string",
"number": "string"
},
"landline": {
"country_code": "string",
"std_code": "string",
"number": "string",
"extension": "string"
}
}
},
"location": {
"type": "gps",
"gps": {
"lat": "string",
"lon": "string",
"format": "string"
},
"address": {
"door": "string",
"building": "string",
"street": "string",
"locality": "string",
"ward": "string",
"city": "string",
"state": "string",
"country": "string",
"area_code": "string"
},
"station_code": "string",
"area_code": "string",
"city": {
"name": "string",
"code": "string"
},
"country": {
"name": "string",
"code": "string"
},
"circle": {
"lat": "string",
"lon": "string",
"format": "string",
"radius": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string"
},
"type": "string"
},
"created_at": "2020-07-08T08:06:44.905Z",
"updated_at": "2020-07-08T08:06:44.905Z",
"agent": {
"profile": {
"title": "Mr",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"full_name": "string",
"image": {
"format": "url",
"data": "string"
},
"dob": "2020-07-08",
"gender": "male",
"contact": {
"email": "user@example.com",
"mobile": {
"country_code": "string",
"number": "string"
},
"landline": {
"country_code": "string",
"std_code": "string",
"number": "string",
"extension": "string"
}
}
}
},
"vehicle": {
"category": "CAR",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "PETROL",
"registration": {
"category": "PERSONAL",
"number": "string"
}
},
"tasks": [
{
"id": "string",
"parent_task_id": "string",
"state": "AT-LOCATION",
"type": "PICKUP",
"descriptor": {
"id": "string",
"name": "string",
"code": "string",
"sym": "string",
"short_desc": "string",
"long_desc": "string",
"images": [
{
"type": "url",
"label": "string",
"url": "2020-07-08T08:06:44.905Z",
"data": "string"
}
],
"audio": "string",
"3d_render": "string"
},
"location": {
"type": "gps",
"gps": {
"lat": "string",
"lon": "string",
"format": "string"
},
"address": {
"door": "string",
"building": "string",
"street": "string",
"locality": "string",
"ward": "string",
"city": "string",
"state": "string",
"country": "string",
"area_code": "string"
},
"station_code": "string",
"area_code": "string",
"city": {
"name": "string",
"code": "string"
},
"country": {
"name": "string",
"code": "string"
},
"circle": {
"lat": "string",
"lon": "string",
"format": "string",
"radius": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string"
},
"spoc": {
"title": "Mr",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"full_name": "string",
"image": {
"format": "url",
"data": "string"
},
"dob": "2020-07-08",
"gender": "male",
"contact": {
"email": "user@example.com",
"mobile": {
"country_code": "string",
"number": "string"
},
"landline": {
"country_code": "string",
"std_code": "string",
"number": "string",
"extension": "string"
}
}
},
"instructions": [
{
"id": "string",
"name": "string",
"code": "string",
"sym": "string",
"short_desc": "string",
"long_desc": "string",
"images": [
{
"type": "url",
"label": "string",
"url": "2020-07-08T08:06:44.905Z",
"data": "string"
}
],
"audio": "string",
"3d_render": "string"
}
],
"created_at": "2020-07-08T08:06:44.905Z",
"updated_at": "2020-07-08T08:06:44.905Z"
}
],
"packages": [
{
"id": "string",
"parent_package_id": "string",
"descriptor": {
"id": "string",
"name": "string",
"code": "string",
"sym": "string",
"short_desc": "string",
"long_desc": "string",
"images": [
{
"type": "url",
"label": "string",
"url": "2020-07-08T08:06:44.906Z",
"data": "string"
}
],
"audio": "string",
"3d_render": "string"
},
"category": {
"id": "string"
},
"contents": [
{
"id": "string",
"parent_item_id": "string",
"descriptor": {
"id": "string",
"name": "string",
"code": "string",
"sym": "string",
"short_desc": "string",
"long_desc": "string",
"images": [
{
"type": "url",
"label": "string",
"url": "2020-07-08T08:06:44.906Z",
"data": "string"
}
],
"audio": "string",
"3d_render": "string"
},
"price": {
"currency": "string",
"estimated_value": {
"integral": "string",
"fractional": "string"
},
"computed_value": {
"integral": "string",
"fractional": "string"
},
"listed_value": {
"integral": "string",
"fractional": "string"
},
"offered_value": {
"integral": "string",
"fractional": "string"
},
"breakup": [
{
"title": "string",
"amount": {
"integral": "string",
"fractional": "string"
}
}
]
},
"model_id": "string",
"category_id": "string",
"brand_id": "string",
"promotional": true,
"ttl": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"quantity": 0,
"fragile": true
}
],
"price": {
"currency": "string",
"estimated_value": {
"integral": "string",
"fractional": "string"
},
"computed_value": {
"integral": "string",
"fractional": "string"
},
"listed_value": {
"integral": "string",
"fractional": "string"
},
"offered_value": {
"integral": "string",
"fractional": "string"
},
"breakup": [
{
"title": "string",
"amount": {
"integral": "string",
"fractional": "string"
}
}
]
},
"weight": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
},
"dimensions": {
"length": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
},
"breadth": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
},
"height": {
"type": "CONSTANT",
"value": 0,
"estimated_value": 0,
"computed_value": 0,
"unit": "string"
}
},
"state": "READY",
"task_id": "string",
"created_at": "2020-07-08T08:06:44.906Z",
"updated_at": "2020-07-08T08:06:44.906Z"
}
]
}
}
},
"error": {
"t_error": {
"t_protocol": "string",
"t_version": "string",
"t_code": "string"
},
"r_error": {
"rcode": "string",
"rmessage": "string"
},
"f_error": [
{
"fpath": "string",
"fcode": "string",
"fmessage": "string"
}
],
"d_error": {}
}
}

Response:

Context:

See Context

Message:

PropertyType
ackAck

Error:

See Error

Example:

{
"context": {
"domain": "FINAL-MILE-DELIVERY",
"action": "string",
"version": "string",
"transaction_id": "string",
"session_id": "string",
"timestamp": "2020-07-08T07:06:34.257Z",
"token": "string",
"status": "string"
},
"message": {
"status": "ACK"
},
"error": {
"t_error": {
"t_protocol": "string",
"t_version": "string",
"t_code": "string"
},
"r_error": {
"rcode": "string",
"rmessage": "string"
},
"f_error": [
{
"fpath": "string",
"fcode": "string",
"fmessage": "string"
}
],
"d_error": {}
}
}