Download OpenAPI specification:Download
Está API tem como objetivo, disponibilizar as informações dos nossos parceiros, tais como pedidos, catalogo de produtos entre outros
Com este método, será possível realizar a autenticação na API utilizando protocolo OAuth2. Com isso retornará um access_token que irá dar permissão de acesso a API.
grant_type required | string Example: grant_type=client_credentials Deverá sempre ser utilizado |
scope required | string Example: scope=orders/read Atualmente temos somente o |
client_id required | string O id do cliente. |
client_secret required | string A secret do cliente. |
Com este método é possível, recuperar os detalhes do pedido, dado o seu número na plataforma Zé Delivery. Atenção: as informações sensíveis do cliente não estarão disponíveis para todos os parceiros pois dependem de alinhamentos legais entre o Zé Delivery e o Parceiro.
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
{- "displayId": "123457890",
- "status": "CREATED",
- "type": "DELIVERY",
- "createdAt": "2021-09-15T19:51:57.851343",
- "merchant": {
- "id": 12345
}, - "items": [
- {
- "id": 12345,
- "index": 3,
- "name": "Refrigerante de Limão 2L",
- "externalCode": "12345",
- "unit": "UNIT",
- "quantity": 1,
- "unitPrice": {
- "value": "10.00",
- "currency": "BRL"
}, - "totalPrice": {
- "value": "10.00",
- "currency": "BRL"
}
}
], - "otherFees": [
- {
- "name": "Frete",
- "type": "DELIVERY_FEE",
- "receivedBy": "MERCHANT",
- "price": {
- "value": "10.00",
- "currency": "BRL"
}
}
], - "discounts": [
- {
- "amount": {
- "value": "10.00",
- "currency": "BRL"
}, - "target": "CART"
}
], - "total": {
- "itemsPrice": {
- "value": "10.00",
- "currency": "BRL"
}, - "otherFees": {
- "value": "10.00",
- "currency": "BRL"
}, - "discount": {
- "value": "10.00",
- "currency": "BRL"
}, - "orderAmount": {
- "value": "10.00",
- "currency": "BRL"
}, - "change": {
- "value": "10.00",
- "currency": "BRL"
}
}, - "payments": {
- "methods": [
- {
- "value": 10,
- "currency": "BRL",
- "type": "PENDING",
- "method": "CASH"
}
]
}, - "customer": {
- "phone": {
- "number": "5511912345678"
}, - "name": "Maria",
- "documentNumber": "12345678901",
- "email": "email@email.com"
}, - "delivery": {
- "deliveredBy": "MERCHANT",
- "pickupCode": "YXTOJMSDIX",
- "deliveryAddress": {
- "country": "Brazil",
- "streetName": "Rua Estados Unidos",
- "formattedAddress": "Rua Estados Unidos, 99 - São Paulo - SP",
- "streetNumber": "99",
- "city": "São Paulo",
- "postalCode": "01234578",
- "coordinates": {
- "latitude": -41.485,
- "longitude": -39.485
}, - "neighborhood": "Jardim das Orquídeas",
- "state": "SP",
- "complement": "AP 123"
}
}, - "takeout": {
- "mode": "`DEFAULT`",
- "takeoutDateTime": "2021-09-15T19:51:57.851343"
}, - "extraInfo": "Trazer bem gelada",
- "statusHistory": [
- {
- "createdAt": "2021-09-15T19:51:57.851343",
- "status": "CREATED"
}
]
}
Com este método é possível aceitar um pedido, dado o número do pedido
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
reason | string Campo livre para informações sobre a confirmação do pedido |
orderExternalCode | string Código externo do pedido que pode ser usada como referência |
createdAt | string Data e hora da criação do pedido |
preparationTime | number Indica o tempo de preparação do pedido em minutos |
{- "reason": "string",
- "orderExternalCode": "string",
- "createdAt": "2021-09-15T19:51:57.851343",
- "preparationTime": 0
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível solicitar, dado o número do pedido, que este seja cancelado ou rejeitado
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
code | string Enum: "SYSTEMIC_ISSUES" "DUPLICATE_APPLICATION" "UNAVAILABLE_ITEM" "RESTAURANT_WITHOUT_DELIVERY_PERSON" "ORDER_OUTSIDE_THE_DELIVERY_AREA" "BLOCKED_CUSTOMER" "INTERNAL_DIFFICULTIES_OF_THE_RESTAURANT" "RISK_AREA" "DELIVERY_PROBLEM" Os códigos de razão de cancelamento, |
{- "code": "UNAVAILABLE_ITEM"
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível, recuperar os eventos dos pedidos, desde em andamento até concluído.
eventType | Array of strings (OrderStatusEnum) Items Enum: "CREATED" "CONFIRMED" "DISPATCHED" "CANCELLED" "CONCLUDED" Example: eventType=CREATED Status dos eventos do pedido |
x-polling-merchants required | array Example: 123,1234 Os ids dos estabelecimentos requirido. |
Authorization required | string token de autenticação para acessar o recurso |
[- {
- "eventId": "3e7224ac-bec0-4fe1-88d1-6348c8149c44",
- "orderId": 123456789,
- "eventType": "CREATED",
- "sourceAppId": "",
- "createdAt": "2021-09-15T19:51:57.851343"
}
]
Com este método é possível, remover os eventos que já foram consumidos, desta forma eles não retornarão mais na rota de polling.
Authorization required | string token de autenticação para acessar o recurso |
id | string O número do evento na plataforma |
orderId | number O número do pedido na plataforma |
eventType | string (OrderStatusEnum) Enum: "CREATED" "CONFIRMED" "DISPATCHED" "CANCELLED" "CONCLUDED" Os status possíveis do pedido, |
[- {
- "id": "3e7224ac-bec0-4fe1-88d1-6348c8149c44",
- "orderId": 123456789,
- "eventType": "CREATED"
}
]
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível abrir e fechar loja, dado o id do estabelecimento e razao.
merchantId required | string Example: 1234 O id do estabelecimento |
Authorization required | string token de autenticação para acessar o recurso |
operation required | string Enum: "CLOSED" "AVAILABLE" Closed para fechar estabelecimento, e avaiable para abrir |
reason | string Razao pela qual esta realizando operaçao. Campo obrigatorio quando for operação closed |
{- "operation": "AVAILABLE",
- "reason": "INTERNET"
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível, atualizar a disponibilidade de um produto, dado o id do estabelecimento e um identificador do produto.
merchantId required | string Example: 1234 O id do estabelecimento |
Authorization required | string token de autenticação para acessar o recurso |
productId | integer O identificador do produto na plataforma Zé Delivery. |
externalProductId | string O identificador do produto em plataforma de terceiros. |
available | boolean A disponibilidade do produto |
{- "productId": "1234",
- "externalProductId": "1234",
- "available": true
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível, recuperar os detalhes de entrega do pedido, dado o seu número na plataforma Zé Delivery.
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
{- "orderDisplayId": "123457890",
- "customerName": "Maria",
- "deliveryMan": {
- "email": "Maria@ze.delivery"
}, - "merchant": {
- "id": "Maria@ze.delivery"
}, - "deliveryPrice": {
- "price": {
- "value": 10,
- "currency": "BRL"
}
}
}
Com este método é possível informar que o pedido chegou ao destino
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
email required | string E-mail do entregador |
{- "email": "string"
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método o pedido informado será finalizado e dado como entregue.
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
email required | string E-mail do entregador |
lat | number Latitude da posição do entregador |
long | number Longitude da posição do entregador |
{- "email": "string",
- "lat": 0,
- "long": 0
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível informar que o entregador pegou o pedido
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
email required | string E-mail do entregador |
{- "email": "string"
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível que o entregador cancele o pedido
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
email required | string E-mail do entregador |
reason required | string Enum: "SYSTEMIC_ISSUES" "RISK_AREA" "NOT_FOUND" "PAYMENT_ISSUE" "INCORRECT" "OTHERS" Os códigos de razão de cancelamento, |
{- "email": "string",
- "reason": "RISK_AREA"
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}
Com este método é possível informar coleta de pedido pelo entregador e o início da entrega
orderNumber required | string >= 9 Example: 123456789 O número do pedido na plataforma Zé Delivery |
Authorization required | string token de autenticação para acessar o recurso |
email required | string E-mail do entregador |
{- "email": "string"
}
{- "code": "string",
- "title": "string",
- "type": "string",
- "messages": [
- "string"
]
}