API Reference

Order Status Change

Field Type Description
order_id uuid Abbiamo uuid generated when order is created
order_number string The same value of order_number input field in Create Order V2 endpoint
order_type string The same value of type input field in Create Order V2 endpoint
invoice_number string The same value of invoice_number input field in Create Order V2 endpoint
seller_identifier string The same value of seller_identifier input field in Create Order V2 endpoint
seller_document_number string Value of the registered document number from seller when created
seller_trading_name string Value of the registered trading name from seller when created
customer_name string The same value of customer.name input field in Create Order V2 endpoint
customer_email string The same value of customer.email input field in Create Order V2 endpoint
customer_phone string The same value of customer.phone input field in Create Order V2 endpoint
external_order_id string The same value of external_id input field in Create Order V2 endpoint
status enum(read about status) Updated status of the order
substatus enum(read about substatus) Updated substatus of the order
event_type string("ORDER_STATUS_CHANGE")
tracking string(length: 7) Abbiamo tracking generated
timestamp integer Timestamp when Abbiamo triggered the event
event_at ISOString Timestamp (ISOString format) of when the event happened
driver_name string Name of the driver associated with the order
driver_document string Document of the driver associated with the order
delivery_type string Type of the delivery: either "PRIVATE-FLEET" or the specific name of some carrier
failure_code number The reason of the failure according to the failure codes table
failure_message string The reason of the failure according to the failure codes table
failure_driver_message string The message the driver writes about the failure 
{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier": "1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "COLLECTED",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "driver_name": "João",
  "driver_document": "17027297623",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "TAKEOUT",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "CREATED",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "DISPATCHED",
  "sub_status": "ROUTE_PLANNED",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "driver_name": "João",
  "driver_document": "17027297623",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "FAILED",
  "sub_status": "COLLECT_FAILED",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "driver_name": "João",
  "driver_document": "17027297623",
  "delivery_type": "CARRIER",
  "failure_code": 17, //number
  "failure_message": "FAILURE_MESSAGE",
  "failure_driver_message": "FAILURE_DRIVER_MESSAGE",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "HANDLING",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "IN_TRANSIT",
  "sub_status": "COLLECTING",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "MANUAL_HANDLE",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "ORDER_FAILED",
  "sub_status": "CARRIER_TIMEOUT",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "PENDING",
  "sub_status": "WAITING_FOR_CARRIER",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "RETURNED",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "RETURNING",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "delivery_type": "CARRIER",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "START_DELIVERY",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "driver_name": "João",
  "driver_document": "17027297623",
  "delivery_type": "PRIVATE-FLEET",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}

{
  "order_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "order_number": "123456789",
  "order_type": "DELIVERY",
  "invoice_number": "xxxxxxxxxx",
  "access_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "invoice_created_timestamp": "2023-01-09T13:43:21.000Z",
  "seller_identifier":"1234569191",
  "seller_document_number": "1234569191",
  "external_order_id":"1892831",
  "status": "SUCCESSFUL",
  "sub_status": "DELIVERED",
  "event_type":"ORDER_STATUS_CHANGE",
  "tracking": "a7g92yd",
  "timestamp": 1661280476296,
  "event_at": "2023-01-10T10:18:44.000Z",
  "driver_name": "João",
  "driver_document": "17027297623",
  "delivery_type": "PRIVATE-FLEET",
  "seller_trading_name": "Go Go Salads",
  "customer_name": "John Doe",
  "customer_phone": "21999999999",
  "customer_email": "[email protected]"
}