Eu Entrego (1.0.0)

Download OpenAPI specification:Download

E-mail: jonatas.ribeiro@euentrego.com Terms of Service

Introdução

API para acesso aos serviços da Eu Entrego.

Autenticação

Solicite a nosso atendimento seu token de acesso para que tenha acesso a sua conta. Para uso do Webhook, um token deverá ser cadastro no lada da Eu Entrego.

Bearer

Um token válido precisa ser enviado em todas as chamadas através do header 'Authorization'. O token é gerado pela Eu Entrego e enviado para o responsável pela integração.

Exemplo do header 'Authorization':

 Bearer xxxxxx.yyyyyyy.zzzzzz

Security Scheme Type: API Key

Header parameter name: Authorization

Token

Um token deverá ser informado para a Eu Entrego notificar no endpoint. Será enviado em todas as requisições através do header 'Authorization'.

Exemplo do header 'Authorization':

 Bearer xxxxxx.yyyyyyy.zzzzzz ou Basic ZW5jb2RlZChtZXV0b2tlbjptaW5oYXNlbmhhKQ==

Security Scheme Type: API Key

Header parameter name: Authorization

Fluxograma de Status

Alt text

Detalhamento de Status

Status	Descrição	Finalizador (DeliveryReason)
OPEN	Aberto	Não
OUT_OF_RANGE	Fora de abrangência	Sim
LOCATION_NOT_FOUND	Localização não encontrada	Não
UNAVAILABLE	Indisponível	Sim
ERROR	Erro	Não
EN_ROUTE	Em rota	Não
ACCEPTED	Aceito	Não
PLANNED	Planejado	Não
DELIVERED	Entregue	Sim
DELIVERED_TO_RECIPIENT	Entregue ao próprio	Sim
DELIVERED_TO_RELATIVE	Entregue ao parente	Sim
DELIVERED_TO_GATEKEEPER	Entregue na portaria	Sim
DELIVERED_OTHER	Outros casos em entrega	Sim
NOT_READY_TO_DELIVER	Não liberado	Sim
NOT_READY_ORDER_COLLECTED_BY_CARRIER	Não liberado (coletado por outra transportadora)	Sim
ADDRESS_WRONG	Endereço não encontrado	Não
REJECTED	Entrega rejeitada	Sim
RECIPIENT_ABSENT	Cliente ausente	Não
ORDER_RETURNED	Pedido devolvido	Sim
DELIVERY_OTHER	Outro problema com a entrega	Sim
DELIVERY_STRAYED	Pedido extraviado	Sim
COLLECTED	Coletado	Não
COLLECT_NONEXISTENT	Coleta não existe	Sim
COLLECT_ADDRESS_WRONG	Endereço não encontrado para coleta	Não
COLLECT_REJECTED	Coleta Rejeitada	Sim
COLLECT_RECIPIENT_ABSENT	Cliente ausente para coleta	Sim
INVOICE_RETURNED	Coleta devolvida	Sim
COLLECT_OTHER	Outros problema com a coleta	Sim
COLLECT_STRAYED	Coleta extraviada	Sim
TIME_LIMIT	Tempo insuficiente para entrega	Não
VEHICLE_PROBLEM	Problema com o veículo	Não
CLIMATE_PROBLEM	Problema com intempéries (chuva, alagamento, etc)	Não
STRAYED	Extraviada	Sim
STOLEN	Roubada	Sim
CANCELLED	Cancelada	Não
CLOSED	Fechada	Sim
NOT_READY_TO_DELIVER	Pedido não liberado	Sim

Gestão de Ordem de Serviço

Gestão das ordens de serviço

Buscar dados de uma ordem de serviço

Authorizations:

Bearer

path Parameters

id

required

integer

Número identificador da ordem de serviço

Responses

Response samples

200
404

Content type

application/json

{"serviceId": "string",
"serviceDate": "string",
"type": "DELIVERY",
"typeLabel": "string",
"deadline": "string",
"lotId": "string",
"lotDate": "string",
"pickupPoint": "string",
"pickupPointName": "string",
"destinationPoint": {"contactName": "string",
"address": "string",
"number": "string",
"neighborhood": "string",
"complement": "string",
"reference": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"latitude": 0,
"longitude": 0
},
"status": "OPEN",
"statusLabel": "string",
"lastDeliveryReason": "DELIVERED",
"customer": {"email": "string",
"mainPhone": {"ddd": "string",
"number": "string"
},
"secondaryPhone": {"ddd": "string",
"number": "string"
},
"individualCustomer": {"cpf": "string",
"firstName": "string",
"lastName": "string"
},
"corporateCustomer": {"cnpj": "string",
"corporateName": "string",
"stateInscription": "string"
}
},
"partnerInfo": {"shipperId": "string",
"shipperName": "string",
"saleChannel": "string",
"shippingCosts": 0,
"integrationServiceId": "string",
"shipmentOrderType": "string",
"orderDate": "string",
"shippedDate": "string"
},
"transportFileInfo": {"transportFileId": "string",
"transportFileLicensePlate": "string",
"sequence": 0,
"transportFileDate": "string",
"initialTimeWindow": "string",
"finalTimeWindow": "string",
"transportFileDeliverymanDoc": "string"
},
"packages": [{"code": "string",
"number": 0,
"itemQuantity": 0,
"trackingCode": "string",
"weight": 0,
"width": 0,
"height": 0,
"length": 0,
"volume": 0,
"invoiceDate": "string",
"invoiceNumber": "string",
"invoiceSeries": "string",
"invoiceKey": "string",
"invoiceLink": "string",
"invoiceCfop": "string",
"invoiceTotalValue": 0,
"invoiceProductsValue": 0
}
],
"routeId": 0
}

Cria uma nova ordem de serviço

Authorizations:

Bearer

Request Body schema: application/json

Ordem de serviço a ser criada. Lembre de alterar o valor do pickupPoint para sua empresa.

serviceId required	string Código único da ordem de serviço
serviceDate required	stringyyyy-MM-dd Data para entrega da ordem de serviço
type required	string Enum: "DELIVERY" "COLLECT" Tipo da ordem de serviço
pickupPoint required	string Ponto de coleta
required	object (Address) Endereço para realizar coleta/entrega
required	object (Customer)
	object (PartnerInfo) Informações do parceiro em relação a entrega
	object (TransportFileInfo) Dados para romaneio
required	Array of objects (Package)
	Array of objects (Transfer)
	Array of objects (Constraint)
	object (ServiceOrderMetadata) Metadados da Ordem de Serviço
logisticsCode	string Código da Transportadora

Responses

Request samples

Payload

Content type

application/json

{"serviceId": "564123",
"serviceDate": "2020-04-15",
"type": "DELIVERY",
"pickupPoint": "SEU_PONTO_DE_COLETA",
"customer": {"email": "carlos.teste@gmail.com",
"mainPhone": {"ddd": "11",
"number": "967224455"
},
"individualCustomer": {"cpf": 3404894057,
"firstName": "Carlos",
"lastName": "da Silva Costa"
}
},
"partnerInfo": {"shipperId": "1",
"shipperName": "Embarcador Gelo",
"shippingCosts": 14,
"saleChannel": "E-COMMERCE",
"shipmentOrderType": "EXPRESS",
"orderDate": "2020-02-09T14:52:08-03:00",
"shippedDate": "2020-02-10T10:20:08-03:00"
},
"destinationPoint": {"contactName": "Carlos Costa",
"address": "Rua da Proclamação",
"neighborhood": "Bonsucesso",
"number": "244",
"complement": "AP 153 BL A",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "21042432",
"reference": "Próximo a Av. Brasil"
},
"constraints": [{"code": "VEHICLE_GROUP",
"value": "CAR"
}
],
"transportFileInfo": {"transportFileId": "ABC123",
"transportFileLicensePlate": "KDA8871",
"sequence": 1,
"initialTimeWindow": "09:00",
"finalTimeWindow": "18:00",
"transportFileDate": "2020-02-09T14:52:08-03:00",
"transportFileDeliverymanDoc": "00000000000"
},
"packages": [{"code": "564123-01",
"number": 1,
"weight": 0.6,
"width": 10,
"height": 10,
"length": 8,
"volume": 0.005,
"itemQuantity": 2,
"invoiceSeries": "1",
"invoiceNumber": "005601",
"invoiceDate": "16/01/2019",
"invoiceKey": "12356789876543456789876543456789876543234123",
"invoiceLink": "http://www.nfe.fazenda.gov.br?nfe=12354323456782345123",
"invoiceTotalValue": 174,
"invoiceProductsValue": 167
},
{"code": "564123-02",
"number": 2,
"weight": 0.4,
"width": 15,
"height": 12,
"length": 10,
"volume": 0.01,
"itemQuantity": 1,
"invoiceSeries": "1",
"invoiceNumber": "005602",
"invoiceDate": "16/01/2019",
"invoiceKey": "12337898765434561238765434567887654345678774",
"invoiceLink": "http://www.nfe.fazenda.gov.br?nfe=12354323456782345123",
"invoiceTotalValue": 94.9,
"invoiceProductsValue": 87.9
}
],
"transfers": [{"sequenceStep": 0,
"destination": "EE_TRANSF_II",
"type": "FIXED"
},
{"sequenceStep": 1,
"destination": "EE_TRANSF_III",
"type": "FIXED"
}
],
"metadata": {"additionalInfos": [{"code": "SECURITY_CODE",
"showCode": true,
"label": "Token de coleta",
"value": "TOKEN_DE_COLETA",
"moment": "PICKUP_AND_SERVICE"
}
]
},
"logisticsCode": "SUA_TRANSPORTADORA"
}

Response samples

422

Content type

application/json

{"message": "string",
"errorCode": "string",
"errors": [{"field": "string",
"error": "string",
"validationType": "MISSING_REQUIRED_FIELD"
}
]
}

Cancela uma ordem de serviço

Authorizations:

Bearer

Request Body schema: application/json

Informações sobre a Ordem de Serviço que será cancelada. Pode ser preenchido somente o campo ID, caso contrário todos os demais campos (serviceId, invoiceNumber, pickupPoint, serviceDate) serão obrigatórios.

id	string Código da Ordem de Serviço retornado pelo serviço de criação de Ordem de Serviço
serviceId	string Código da Ordem de Serviço definido na criação da Ordem de Serviço
invoiceNumber	string Número da nota fiscal
pickupPoint	string Código da loja definido na criação da Ordem de Serviço
serviceDate	string <yyyy-MM-dd> Data de realização da ordem de serviço

Responses

Request samples

Payload

Content type

application/json

{"id": "34920",
"serviceId": "pedido01",
"invoiceNumber": "243456",
"pickupPoint": "LOJA-1",
"serviceDate": "2020-01-30"
}

Response samples

422

Content type

application/json

{"message": "string",
"errorCode": "string",
"errors": [{"field": "string",
"error": "string",
"validationType": "MISSING_REQUIRED_FIELD"
}
]
}

Adiciona pacotes à ordens de serviço existentes

Authorizations:

Bearer

path Parameters

id

required

integer

Número identificador da ordem de serviço

Request Body schema: application/json

Informações sobre os pacotes que deverão ser adicionados à Ordem de serviço existente.

Array

code required	string Código único do volume
number required	number Sequencial do volume
itemQuantity required	number Quantidade de itens dentro do volume
trackingCode	string Código de rastreio do volume
weight required	number <double> Peso em kg
width required	number <double> Profundidade em cm
height required	number <double> Altura em cm
length required	number <double> Comprimento em cm
volume required	number <double> Volume em cm cúbico
invoiceDate	string <yyyy-MM-dd'T'HH:mm:ss.SSSZ> Data da emissão da nota fiscal
invoiceNumber	string Número da nota fiscal
invoiceSeries	string Série da nota fiscal
invoiceKey	string Chave da nota fiscal
invoiceLink	string Link para nota fiscal
invoiceCfop	string CFOP da nota fiscal
invoiceTotalValue	number <double> Valor total da nota fiscal
invoiceProductsValue	number <double> Valor dos produtos nota fiscal

Responses

Request samples

Payload

Content type

application/json

[{"code": "string",
"number": 0,
"itemQuantity": 0,
"trackingCode": "string",
"weight": 0,
"width": 0,
"height": 0,
"length": 0,
"volume": 0,
"invoiceDate": "string",
"invoiceNumber": "string",
"invoiceSeries": "string",
"invoiceKey": "string",
"invoiceLink": "string",
"invoiceCfop": "string",
"invoiceTotalValue": 0,
"invoiceProductsValue": 0
}
]

Response samples

422

Content type

application/json

{"message": "string",
"errorCode": "string",
"errors": [{"field": "string",
"error": "string",
"validationType": "MISSING_REQUIRED_FIELD"
}
]
}

Importa o arquivo de ordens de serviço

Authorizations:

Bearer

Request Body schema: multipart/form-data

file	string <binary> The file to upload.

Responses

Altera dados de agendamento em ordens de serviço

Authorizations:

Bearer

path Parameters

serviceId

required

string

Código da ordem de serviço

Request Body schema: application/json

Identificadores da Ordem de Serviço que será atualizada e dados a serem atualizados (nova data, horário de início, horário de fim)

date	string <yyyy-MM-dd> Data da ordem de serviço
pickupPoint	string Código do ponto de coleta
newDate	string <yyyy-MM-dd> Nova data a ser atribuída à ordem de serviço (opcional)
initialTimeWindow	string <HH:mm> Horário de início da Janela de Entrega (opcional)
finalTimeWindow	string <HH:mm> Horário de término da Janela de Entrega (opcional)

Responses

Request samples

Payload

Content type

application/json

{"date": "2021-03-15",
"pickupPoint": "LOJA_XPTO",
"newDate": "2021-03-20",
"initialTimeWindow": "15:00",
"finalTimeWindow": "19:00"
}

Altera dados fiscais de um pacote

Authorizations:

Bearer

path Parameters

serviceId required	string Código da ordem de serviço
packageCode required	string Código do pacote

Request Body schema: application/json

Identificadores da Ordem de Serviço que será atualizada e dados a serem atualizados (nova data, horário de início, horário de fim)

date	string <yyyy-MM-dd> Data da ordem de serviço
pickupPoint	string Código do ponto de coleta
invoiceDate	string <yyyy-MM-dd> Data a ser atribuída ao pacote (opcional)
invoiceSeries	string Série da nota fiscal(opcional)
invoiceNumber	string Número da nota fiscal (opcional)
invoiceKey	string Chave de acesso da nota fiscal (opcional)
invoiceLink	string Link de acesso à nota fiscal (opcional)

Responses

Request samples

Payload

Content type

application/json

{"date": "2021-03-15",
"pickupPoint": "LOJA_XPTO",
"invoiceDate": "2021-03-20",
"invoiceSeries": "1234567890",
"invoiceNumber": "11223344556677889900",
"invoiceKey": "ABC_123_XPTO",
"invoiceLink": "https://xpto.com"
}

Adiciona uma ordem de serviço a uma rota

Authorizations:

Bearer

path Parameters

routeId required	integer Número identificador da rota
serviceId required	string Número identificador da ordem de serviço para o parceiro

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Reabre uma ordem de serviço

Authorizations:

Bearer

path Parameters

serviceId

required

string

Número identificador da ordem de serviço para o parceiro

Responses

Response samples

200
404
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Cria um ticket para mudança de endereço

Authorizations:

Bearer

path Parameters

serviceId

required

string

Número identificador da ordem de serviço para o parceiro

Request Body schema: application/json

type	string Value: "ADDRESS_CHANGE_BY_PARTNER" Tipos de ticket `ADDRESS_CHANGE_BY_PARTNER` - Mudança de endereço solicitada pelo cliente
customerName	string Nome do cliente
customerCellphone	string Telefone do cliente
	object Detalhe da recomendação de risco

Responses

Request samples

Payload

Content type

application/json

{"type": "ADDRESS_CHANGE_BY_PARTNER",
"customerName": "string",
"customerCellphone": "string",
"addressCorrection": {"address": "string",
"number": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"complement": "string",
"reference": "string"
}
}

Response samples

200
400
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Remove uma ordem de serviço de uma rota

Authorizations:

Bearer

path Parameters

routeId required	integer Número identificador da rota
serviceId required	string Número identificador da ordem de serviço para o parceiro

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Receber devolução de ordem de serviço na base

Recebe a devolução de uma ordem de serviço em uma rota de coleta. Esta operação valida se a rota está em status de devolução e se a ordem de serviço pertence à rota.

Motivos possíveis de devolução (campo reason):

Para entregas:
- ORDER_RETURNED: pacote de entrega devolvido na base
- DELIVERY_STRAYED: pacote de entrega extraviado
- DELIVERY_STOLEN: pacote de entrega roubado
Para coletas:
- COLLECT_CLOSED: pacote recebido na base (evento finalizador de sucesso)
- INVOICE_RETURNED: insucesso na coleta do pacote (permitirá a finalização da rota)
- COLLECT_STRAYED: pacote de coleta extraviado
- COLLECT_STOLEN: pacote de coleta roubado

Authorizations:

Bearer

path Parameters

routeId

required

integer

ID da rota onde a devolução será registrada

Request Body schema: application/json

name required	string Nome do usuário que está recebendo o pacote
email required	string <email> Email do usuário que está recebendo o pacote
serviceId required	string ID da ordem de serviço que está sendo devolvida
reason required	string Enum: "ORDER_RETURNED" "DELIVERY_STRAYED" "DELIVERY_STOLEN" "COLLECT_CLOSED" "INVOICE_RETURNED" "COLLECT_STRAYED" "COLLECT_STOLEN" Motivo da devolução

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "user@example.com",
"serviceId": "string",
"reason": "ORDER_RETURNED"
}

Response samples

200
400
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Status de OS

Enviamos através desse webhook toda atualização de status de ordens de serviço

Notificação de Status da OS Webhook

Envio de notificação de ordens de serviço. Conforme a ordem de serviço evoluir, novas informações serão adicionadas.

Authorizations:

Token

Request Body schema: application/json

internalId	integer Identificador da Ordem de serviço na Eu Entrego
orderId	string Identificador da Ordem de Serviço
originalServiceId	string Identificador original do parceiro para a Ordem de Serviço
serviceType	string Enum: "DELIVERY" "COLLECT" Tipos de Ordem de serviço `DELIVERY`- Entrega `COLLECT`- Coleta
lotId	string Identificador de carga
returnedReasonLabel	string Tipos de razões de retorno
	object Informações sobre os pacotes
status	string (ServiceOrderStatus) Enum: "OPEN" "OUT_OF_RANGE" "LOCATION_NOT_FOUND" "UNAVAILABLE" "ERROR" "EN_ROUTE" "ACCEPTED" "PLANNED" "DELIVERED" "DELIVERED_TO_RECIPIENT" "DELIVERED_TO_RELATIVE" "DELIVERED_TO_GATEKEEPER" "DELIVERED_OTHER" "NOT_READY_TO_DELIVER" "NOT_READY_ORDER_CANCELLED" "NOT_READY_ORDER_COLLECTED_BY_CARRIER" "ADDRESS_WRONG" "REJECTED" "RECIPIENT_ABSENT" "RECIPIENT_ABSENT_COMMERCIAL" "ORDER_RETURNED" "DELIVERY_OTHER" "DELIVERY_STRAYED" "COLLECTED" "COLLECT_CLOSED" "COLLECT_NONEXISTENT" "COLLECT_ADDRESS_WRONG" "COLLECT_REJECTED" "COLLECT_RECIPIENT_ABSENT" "INVOICE_RETURNED" "COLLECT_OTHER" "COLLECT_STRAYED" "TIME_LIMIT" "VEHICLE_PROBLEM" "CLIMATE_PROBLEM" "STRAYED" "STOLEN" "CANCELLED" "CLOSED" "NOT_READY_TO_DELIVER" Status que serão notificados `OPEN`- Aberto `OUT_OF_RANGE`- Fora de abrangência `LOCATION_NOT_FOUND`- Localização não encontrada `UNAVAILABLE`- Indisponível `ERROR`- Erro `EN_ROUTE`- Em rota `ACCEPTED`- Aceito `PLANNED`- Planejado `DELIVERED`- Entregue `DELIVERED_TO_RECIPIENT`- Entregue ao próprio `DELIVERED_TO_RELATIVE`- Entregue ao parente `DELIVERED_TO_GATEKEEPER`- Entregue na portaria `DELIVERED_OTHER`- Outros casos em entrega `NOT_READY_TO_DELIVER`- Não liberado `NOT_READY_ORDER_CANCELLED`- Não liberado cancelada `NOT_READY_ORDER_COLLECTED_BY_CARRIER`- Não liberado (coletado por outra transportadora) `ADDRESS_WRONG`- Endereço não encontrado `REJECTED`- Entrega rejeitada `RECIPIENT_ABSENT`- Cliente ausente `RECIPIENT_ABSENT_COMMERCIAL`- Cliente comercial ausente `ORDER_RETURNED`- Pedido devolvido `DELIVERY_OTHER`- Outro problema com a entrega `DELIVERY_STRAYED`- Pedido extraviado `COLLECTED`- Coletado `COLLECT_CLOSED`- Coleta finalizada `COLLECT_NONEXISTENT`- Coleta não existe `COLLECT_ADDRESS_WRONG`- Endereço não encontrado para coleta `COLLECT_REJECTED`- Coleta Rejeitada `COLLECT_RECIPIENT_ABSENT`- Cliente ausente para coleta `INVOICE_RETURNED`- Coleta devolvida `COLLECT_OTHER`- Outros problema com a coleta `COLLECT_STRAYED`- Coleta extraviada `TIME_LIMIT` - Tempo insuficiente para entrega `VEHICLE_PROBLEM` - Problema com o veículo `CLIMATE_PROBLEM` - Problema com intempéries (chuva, alagamento, etc) `STRAYED` - Extraviada `STOLEN` - Roubada `CANCELLED` - Cancelada `CLOSED` - Fechada `NOT_READY_TO_DELIVER` - Pedido não liberado
statusLabel	string Descrição do status que será notificado
customReasonName	string Descrição customizada do status que será notificado
customReasonCode	string Código customizado do status que será notificado
processedAt	string <yyyy-MM-dd'T'HH:mm:ss.SSSX> Data da ocorrência do status
createdAt	string <yyyy-MM-dd'T'HH:mm:ss.SSSX> Data da criação do pedido na Eu Entrego
trackingLink	string URL para rastreamento da Ordem de Serviço
observation	string Observação informada pelo entregador caso exista
receipts	Array of strings Lista com links dos comprovantes e assinatura digital caso existam
	object Informações fiscais
	object (PickupPointNotification) Informações referentes ao ponto de coleta
	object (CustomerNotification) Informações referentes ao destinatário
	object Informações sobre a rota
latitude	number Latitude do ponto onde o pedido foi entregue (caso seja notificação de entrega)
longitude	number Longitude do ponto onde o pedido foi entregue (caso seja notificação de entrega)
recipientName	string Nome do recebedor (caso seja notificação de entrega)
recipientDocument	string Número do Documento apresentado do recebedor (caso seja notificação de entrega)
recipientDocumentType	string Enum: "CPF" "RG" Tipo do documento que foi apresentado
loadGroup	string Código do grupo de carga da Ordem de Serviço
	object Informações referentes ao local a ser entregue
	object Informações referentes ao parceiro
logisticsCarrierName	string Nome da transportadora
logisticsIntegrationCode	string Código da transportadora

Responses

Request samples

Payload

Content type

application/json

{"internalId": 21358322,
"orderId": "549632664",
"originalServiceId": "12345667",
"serviceType": "DELIVERY",
"lotId": "1234ab",
"returnedReasonLabel": "Entregue",
"packages": [{"code": "549632664001",
"itemQuantity": 1
},
{"code": "549632664002",
"itemQuantity": 1
}
],
"status": "DELIVERED_TO_RELATIVE",
"statusLabel": "Entregue ao parente",
"customReasonCode": "100001",
"customReasonName": "Entregue em mãos a parente",
"processedAt": "2020-03-10T10:20:30.435",
"createdAt": "2020-03-09T08:30:30.435",
"trackingLink": "https://tracking.euentrego.com.br/track/2/ENT-549632664/68038",
"observation": "Recebido pelo primo do cliente, senhor Antônio Carlos.",
"customer": {"name": "Maria da Silva",
"cpf": "123.456.789-11"
},
"invoice": {"invoiceNumber": "68038",
"invoiceSeries": "1",
"invoiceKey": "1231233131231231231231231231",
"invoiceIssuerDocument": "123131231"
},
"pickupPoint": {"id": "123",
"code": "LOJAJO",
"name": "Loja do João",
"cnpj": "12345678901234",
"address": {"address": "Av. Nossa Senhora de Copacabana",
"number": "1234a",
"complement": "Portão Verde",
"neighborhood": "Copacabana",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22123456"
},
"corporate": {"id": "456",
"code": "EMPRESAJO",
"name": "Empresa do João",
"cnpj": "23456789101112"
}
},
"route": {"id": "677924",
"order": 2,
"distance": 5431,
"deliveryman": {"id": 762,
"name": "Carlos Andrade",
"phone": "(11) 999999999",
"cpf": "99999999",
"licensePlate": "LPQ3976"
},
"transportFileInfo": {"transportFileId": "ABC123",
"transportFileDate": "2020-02-09T14:52:08-03:00",
"initialTimeWindow": "09:00",
"finalTimeWindow": "18:00"
}
},
"receipts": ["https://recibo.url.com/87917f7d-3c78-47e9-ba09-75acf456b5a4.jpg",
"https://recibo.url.com/9c8a7c63-9670-494e-9d0b-f02ebbb4951f.jpg"
],
"latitude": -21.335271,
"longitude": -41.663748,
"recipientName": "Antônio Carlos",
"recipientDocument": "12345678910",
"recipientDocumentType": "CPF",
"loadGroup": "123",
"destinationPoint": {"address": "Rua dos alfaces",
"number": "3",
"neighborhood": "Copacabana",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "21042432",
"latitude": "-21.335271",
"longitude": "-41.457845"
},
"logisticsCarrierName": "Transportadora Express",
"logisticsIntegrationCode": "TRANSPORTADORA_EE"
}

Gestão de Rota

Gestão das rotas

Listar rotas

Authorizations:

Bearer

path Parameters

code

required

string

Código identificador do ponto de coleta

query Parameters

date	string Filtra uma data específica para listar as rotas, se não enviado utilizará a data atual
status	string Enum: "UNCONFIRMED" "CONFIRMED" "AT_PICKUP_POINT" "ON_GOING" "RETURNING" "FINISHED" "UNAVAILABLE" Filtra o status desejado

Responses

Response samples

200
404

Content type

application/json

{"routeDay": "string",
"routes": [{"id": 0,
"status": "UNCONFIRMED",
"timeWindow": "string",
"distance": 0,
"order": 0,
"dateCreated": "string"
}
]
}

Buscar dados de uma rota

Authorizations:

Bearer

path Parameters

id

required

integer

Número identificador da rota

Responses

Response samples

200
404

Content type

application/json

{"routeDay": "string",
"timeWindow": "string",
"distance": 0,
"deliveryman": {"id": 0,
"name": "string",
"cpf": "string",
"licensePlate": "string"
},
"serviceOrders": [{"serviceId": "string",
"type": "COLLECT"
}
]
}

Criar uma rota através de Ordens de Serviço já criadas no sistema

Authorizations:

Bearer

Request Body schema: /

Códigos de erro

Quando houver erro, o código de erro será quando retornado descreve mais claro o erro ocorrido na criação da rota, retornado no campo errorCode.

transportFileId	string Código da Rota
routeDay	string <yyyy-MM-dd> Data para realização da Rota
initialTimeWindow	string <HH:mm> Início da janela horário de realização da Rota
finalTimeWindow	string <HH:mm> Fim da janela horário de realização da Rota
	Array of objects (RouteRequestServiceOrder) Ordens de serviço que serão realizadas na Rota. Pode ser preenchido somente o campo ID, caso contrário todos os demais campos (serviceId, invoiceNumber, pickupPoint, serviceDate) serão obrigatórios.

Responses

Response samples

500

Content type

application/json

{"message": "string",
"errorCode": "string",
"errors": [{"field": "string",
"error": "string",
"validationType": "MISSING_REQUIRED_FIELD"
}
]
}

Adiciona uma ordem de serviço a uma rota

Authorizations:

Bearer

path Parameters

routeId required	integer Número identificador da rota
serviceId required	string Número identificador da ordem de serviço para o parceiro

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Aloca um entregador a uma rota

Authorizations:

Bearer

path Parameters

transportFileId required	string Identificador do romaneio
cpf required	string CPF do entregador

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Remove um entregador de uma rota

Authorizations:

Bearer

path Parameters

transportFileId required	string Identificador do romaneio
cpf required	string CPF do entregador

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Remove uma ordem de serviço de uma rota

Authorizations:

Bearer

path Parameters

routeId required	integer Número identificador da rota
serviceId required	string Número identificador da ordem de serviço para o parceiro

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Receber devolução de ordem de serviço na base

Recebe a devolução de uma ordem de serviço em uma rota de coleta. Esta operação valida se a rota está em status de devolução e se a ordem de serviço pertence à rota.

Motivos possíveis de devolução (campo reason):

Para entregas:
- ORDER_RETURNED: pacote de entrega devolvido na base
- DELIVERY_STRAYED: pacote de entrega extraviado
- DELIVERY_STOLEN: pacote de entrega roubado
Para coletas:
- COLLECT_CLOSED: pacote recebido na base (evento finalizador de sucesso)
- INVOICE_RETURNED: insucesso na coleta do pacote (permitirá a finalização da rota)
- COLLECT_STRAYED: pacote de coleta extraviado
- COLLECT_STOLEN: pacote de coleta roubado

Authorizations:

Bearer

path Parameters

routeId

required

integer

ID da rota onde a devolução será registrada

Request Body schema: application/json

name required	string Nome do usuário que está recebendo o pacote
email required	string <email> Email do usuário que está recebendo o pacote
serviceId required	string ID da ordem de serviço que está sendo devolvida
reason required	string Enum: "ORDER_RETURNED" "DELIVERY_STRAYED" "DELIVERY_STOLEN" "COLLECT_CLOSED" "INVOICE_RETURNED" "COLLECT_STRAYED" "COLLECT_STOLEN" Motivo da devolução

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "user@example.com",
"serviceId": "string",
"reason": "ORDER_RETURNED"
}

Response samples

200
400
404
422
500

Content type

application/json

{"success": true,
"message": "Operação xpto concluída"
}

Status de Rota

Enviamos através desse webhook toda atualização de status de rotas

Notificação de Status da Rota Webhook

Envio de notificação de ordens de serviço. Conforme a ordem de serviço evoluir, novas informações serão adicionadas.

Authorizations:

Token

Request Body schema: application/json

routeId	integer Identificador da rota na Eu Entrego
routeStatus	string Enum: "CONFIRMED" "ON_GOING" "RETURNING" "FINISHED" Status que serão notificados `CONFIRMED`- Confirmada `ON_GOING`- Em andamento `RETURNING`- Devolvendo `FINISHED`- Finalizada
transportFileId	string Identificador do romaneio
	object Informações do entregador
	Array of objects Informações das ordens de serviço na rota

Responses

Request samples

Payload

Content type

application/json

{"routeId": 123,
"routeStatus": "ON_GOING",
"deliveryman": {"id": 676,
"cpf": "11011010042",
"name": "José da Silva",
"licensePlate": "LAO7683",
"type": "SEDAN",
"model": "VW Voyage"
},
"transportFileId": "rota123",
"serviceOrders": [{"serviceId": "7910239",
"serviceOrderId": 6724037,
"stepOrder": 3,
"latitude": -21.2356821,
"longitude": -41.45784512,
"status": "EN_ROUTE",
"type": "DELIVERY",
"loadGroup": "123",
"pickupPoint": {"id": 1524,
"code": "LOJA_1",
"name": "Supermercado Gotham",
"corporate": {"id": 889,
"code": "WAYNE_CORP"
}
}
}
]
}

Check-in

Enviamos através desse webhook toda atualização de checkpoint do entregador

Notificação de Check-in Webhook

Envio de notificação de check-in do entregado no ponto de coleta. Deve ser idempotente pois em caso de erro haverão retentativas.

Authorizations:

Token

Request Body schema: application/json

checkinDate	string Data e hora que o entregador chegou na loja
routeId	integer Identificador da rota (se houver associação)
	object Informações referentes ao entregador
	object (PickupPointNotification) Informações referentes ao ponto de coleta

Responses

Request samples

Payload

Content type

application/json

{"checkinDate": "string",
"routeId": 0,
"deliveryman": {"id": 0,
"name": "string",
"cpf": "string",
"licensePlate": "string",
"model": "string",
"color": "string"
},
"pickupPoint": {"id": 0,
"code": "string",
"name": "string",
"cnpj": "string",
"address": {"zipCode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string"
},
"corporate": {"id": 0,
"code": "string",
"name": "string",
"cnpj": "string"
}
}
}

Gestão de pontos de coleta

Buscar dados de ponto de coleta

Authorizations:

Bearer

path Parameters

code

required

string

Codigo do ponto de coleta

Responses

Response samples

200
400
404

Content type

application/json

{"id": 0,
"name": "string",
"code": "string",
"corporateName": "string",
"corporateId": "string",
"router": "string",
"routerMode": "string",
"status": "ACTIVE"
}

Cria um novo ponto de coleta

Authorizations:

Bearer

Request Body schema: application/json

Cria um novo ponto de coleta

name	string Nome do ponto de coleta
code	string Codigo do ponto de coleta
cnpj	string <string> CNPJ da empresa
address	string Endereço do ponto de coleta
number	number Numero do endereço ponto de coleta
neighborhood	string Bairro do onde esta localizado o ponto de coleta
city	string Cidade do ponto de coleta
state	string Estado do ponto de coleta
zipCode	string <00000000> CEP do endereço do ponto de coleta
complement	string Complemento da localização
reference	string Usa uma referencia pra localizar o ponto de coleta
contactName	string Nome de contato
contactNumber	string <00000000000> Numero de contato

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"code": "string",
"cnpj": "00000000000000",
"address": "string",
"number": 0,
"neighborhood": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"complement": "string",
"reference": "string",
"contactName": "string",
"contactNumber": "string"
}

Response samples

201
400
422
500

Content type

application/json

{"success": true
}

Gestão de entregadores

Notificação de criação de entregador Webhook

Envio de notificação de cadastro de entregadores. Toda vez que houver um novo cadastro de entregador na plataforma, a requisição será disparada.

Request Body schema: application/json

id	integer Identificador do entregador
cpf	string CPF do entregador

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"cpf": "string"
}

Buscar entregador pelo id

Buscar entregador a partir do id único.

Authorizations:

Token

path Parameters

id

required

integer

Identificador do entregador

Responses

Response samples

200
404

Content type

application/json

{"id": 0,
"name": "string",
"cpf": "string",
"cnpj": "string",
"socialName": "string",
"email": "string",
"cellphoneDDD": "string",
"cellphone": "string",
"secondaryCellphoneDDD": "string",
"secondaryCellphone": "string",
"birthday": "2019-08-24",
"address": {"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"zipCode": "string"
},
"motherName": "string",
"gender": "string",
"pickupPoint": "string",
"corporate": {"cnpj": "string",
"name": "string",
"cnae": "string",
"status": "string"
},
"documents": [{"type": "string",
"url": "http://example.com",
"s3Key": "string",
"active": true
}
],
"vehicles": [{"licensePlate": "string",
"type": "string",
"manufacturer": "string",
"model": "string",
"year": 0,
"color": "string",
"document": {"type": "string",
"url": "http://example.com",
"s3Key": "string",
"active": true
},
"accessory": "string",
"accessoryVolumeCapacity": 0,
"cityLicensing": "string"
}
],
"activeVehicle": {"licensePlate": "string",
"type": "string",
"manufacturer": "string",
"model": "string",
"year": 0,
"color": "string"
},
"agreements": [{"ip": "192.168.0.1",
"platform": "string",
"platformVersion": "string",
"deviceManufacturer": "string",
"deviceModel": "string",
"latitude": 0,
"longitude": 0,
"dateCreated": "2019-08-24T14:15:22Z"
}
],
"verificationCode": "string",
"bankId": "string",
"bankName": "string",
"bankAgency": "string",
"bankAgencyDigit": "string",
"bankAccount": "string",
"bankAccountDigit": "string",
"bankAccountType": "string",
"bankAccountRelativeType": "string",
"bankAccountIsCorporate": true,
"dateCreated": "2019-08-24T14:15:22Z",
"status": "string",
"hasConfrontationTicketInProgress": true,
"driverLicenseData": {"driverLicenseNumber": "string",
"driverLicenseCategory": "string",
"driverLicenseState": "string",
"driverLicenseIssuerDate": "2019-08-24",
"driverLicenseDueDate": "2019-08-24"
},
"currentDate": "2019-08-24T14:15:22Z",
"serverTime": 0,
"carrierId": 0,
"logisticsCode": "string",
"logisticsCarrierName": "string",
"metadata": {"successfulExecutedRoutes": 0,
"recommendations": [{"origin": "string",
"score": 0,
"dateCreated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
]
}
}

Buscar entregador pelo cpf

Buscar entregador a partir do cpf.

Authorizations:

Token

path Parameters

cpf

required

string

cadastro de pessoa física do entregador

Responses

Response samples

200
404

Content type

application/json

{"id": 0,
"name": "string",
"cpf": "string",
"cnpj": "string",
"socialName": "string",
"email": "string",
"cellphoneDDD": "string",
"cellphone": "string",
"secondaryCellphoneDDD": "string",
"secondaryCellphone": "string",
"birthday": "2019-08-24",
"address": {"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"zipCode": "string"
},
"motherName": "string",
"gender": "string",
"pickupPoint": "string",
"corporate": {"cnpj": "string",
"name": "string",
"cnae": "string",
"status": "string"
},
"documents": [{"type": "string",
"url": "http://example.com",
"s3Key": "string",
"active": true
}
],
"vehicles": [{"licensePlate": "string",
"type": "string",
"manufacturer": "string",
"model": "string",
"year": 0,
"color": "string",
"document": {"type": "string",
"url": "http://example.com",
"s3Key": "string",
"active": true
},
"accessory": "string",
"accessoryVolumeCapacity": 0,
"cityLicensing": "string"
}
],
"activeVehicle": {"licensePlate": "string",
"type": "string",
"manufacturer": "string",
"model": "string",
"year": 0,
"color": "string"
},
"agreements": [{"ip": "192.168.0.1",
"platform": "string",
"platformVersion": "string",
"deviceManufacturer": "string",
"deviceModel": "string",
"latitude": 0,
"longitude": 0,
"dateCreated": "2019-08-24T14:15:22Z"
}
],
"verificationCode": "string",
"bankId": "string",
"bankName": "string",
"bankAgency": "string",
"bankAgencyDigit": "string",
"bankAccount": "string",
"bankAccountDigit": "string",
"bankAccountType": "string",
"bankAccountRelativeType": "string",
"bankAccountIsCorporate": true,
"dateCreated": "2019-08-24T14:15:22Z",
"status": "string",
"hasConfrontationTicketInProgress": true,
"driverLicenseData": {"driverLicenseNumber": "string",
"driverLicenseCategory": "string",
"driverLicenseState": "string",
"driverLicenseIssuerDate": "2019-08-24",
"driverLicenseDueDate": "2019-08-24"
},
"currentDate": "2019-08-24T14:15:22Z",
"serverTime": 0,
"carrierId": 0,
"logisticsCode": "string",
"logisticsCarrierName": "string",
"metadata": {"successfulExecutedRoutes": 0,
"recommendations": [{"origin": "string",
"score": 0,
"dateCreated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
]
}
}

Gestão de Transportadora

Cria e atualiza configuração de transportadora

Authorizations:

Bearer

Request Body schema: application/json

Cria e atualiza configuração de transportadora

cnpj required	string Código da transportadora (formato CNPJ)
name required	string Nome da transportadora
code required	string Código da integração da empresa com a transportadora

Responses

Request samples

Payload

Content type

application/json

{"cnpj": "00.000.000/0000-00",
"name": "Transportadora XPTO",
"code": "XPTO"
}

Gestão de risco

Validação de Risco

Recomendação de risco para entregador

Endpoint para fornecer recomendações de risco com base no CPF do entregador e na fonte de recomendação.

Authorizations:

Bearer

path Parameters

cpf required	string Example: 12445609922 CPF do entregador
source required	string Example: internal Fonte de recomendação (idwall, internal, etc.)

Request Body schema: application/json

origin	string Origem da recomendação (ex: idwall, etc.)
score	integer Pontuação do entregador (quanto maior o valor, menor o risco)
dateCreated	string <date-time> Data de criação da recomendação
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"origin": "string",
"score": 0,
"dateCreated": "2019-08-24T14:15:22Z",
"details": [{"group": "PHOTO_VERIFICATION",
"detail": "string"
}
]
}

Response samples

200
400
404

Content type

application/json

{"status": "success",
"message": "Recomendação de risco processada com sucesso"
}

Gestão de Ordem de Serviço

Gestão de Ordem de Serviço do Operador Logístico

Atualiza status da ordem de serviço

Authorizations:

Bearer

path Parameters

serviceId

required

string

Código do pedido.

Request Body schema: application/json

Atualização de status da ordem de serviço.

orderStatus required	string (LogisticsOperatorServiceOrderStatus) Enum: "WAITING_LOAD" "LOADED" "STARTED" "SUCCESS" "UNSUCCESS" Status `WAITING_LOAD` - Aguardando carregamento `LOADED` - Carregamento efetuado `STARTED` - Iniciado `SUCCESS` - Sucesso `UNSUCCESS` - Insucesso
changeReason	string Motivo da alteração
	object (GeoLocation)
	object (ExternalTransportFile)
	Array of objects (ServiceOrderConfirmationResource)
secureCode	string Código de segurança
packageCode	string Código do pacote
documentType	string Enum: "RG" "CPF" "DOC_DECLINED" Documento `RG` - RG `CPF` - CPF `DOC_DECLINED` - Não Informado
recipientName	string Nome do destinatário
additionalInfo	string Informações adicionais
document	string Documento
confirmationDate	string <yyyy-MM-dd'T'HH:mm:ss.SSS> Data da confirmação
customReasonName	string Nome customizado de reason
	object (ServiceOrderTimeInfo)
localTimezone	number Timezone
packageCodes	Array of strings Códigos dos pacotes

Responses

Request samples

Payload

Content type

application/json

{"orderStatus": "SUCCESS",
"changeReason": "Entregue no local",
"geoLocation": {"latitude": 37.4220936,
"longitude": -122.083922
},
"transportFile": {"id": "A000",
"deliverymanDoc": "00000000000",
"deliverymanLicensePlate": "AAA0000",
"deliverymanName": "Zé Maria"
},
"documentType": "CPF",
"document": "00000000000",
"recipientName": "Maria José",
"additionalInfo": "Informações adicionais",
"confirmationDate": "2025-04-10T07:42:30.123",
"resources": [{"type": "PLACE",
"url": "URL_PLACE"
},
{"type": "OTHER",
"url": "URL_OTHER"
}
]
}