Ações de pedidos

Cada ação é um POST sem corpo em /merchant/v3/orders/{orderId}/<ação>, com exceção do cancelamento e do rastreio. Todas exigem o token no header Authorization.

Ação	Endpoint	Quando usar
Confirmar	`confirm`	A loja aceitou o pedido.
Preparando	`preparing`	A loja começou o preparo. Opcional.
Pronto para retirada	`readyForPickup`	O pedido está pronto. Obrigatório em `TAKEOUT` e `INDOOR`.
Retirado	`pickedUp`	O cliente retirou o pedido (`TAKEOUT`).
Despachar	`dispatch`	O pedido saiu para entrega. Obrigatório em `DELIVERY`.
Entregue	`delivered`	O pedido chegou ao cliente. Fecha o ciclo.
Cancelar	`requestCancellation`	A loja não vai atender o pedido.
Rastreio	`tracking`	Informar entregador, veículo, ETA e localização.

Respostas

Status	Quando
`202 Accepted`	A ação foi aceita. O corpo traz o `id` do pedido.
`422 Unprocessable Content`	O pedido não está num estado que aceita a ação, por exemplo despachar um pedido já cancelado. Veja o ciclo de vida.

202 Accepted

{ "id": "67983761-a469-422c-af8e-b168f1e5ce19" }

Confirmar um pedido

Depois de buscar um pedido com evento CREATED, confirme-o quando a loja aceitar.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/confirm' \
  --header 'Authorization: Bearer {token}'

await fetch(`https://api.deliveryvip.com.br/merchant/v3/orders/${orderId}/confirm`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
})

requests.post(
    f"https://api.deliveryvip.com.br/merchant/v3/orders/{order_id}/confirm",
    headers={"Authorization": f"Bearer {token}"},
)

As demais ações sem corpo seguem exatamente o mesmo formato: troque confirm pelo endpoint da ação.

Preparando um pedido

Depois de confirmar, sinalize que a loja começou a preparar o pedido.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/preparing' \
  --header 'Authorization: Bearer {token}'

Pronto para pegar um pedido

O pedido está pronto para o cliente retirar ou para o entregador buscar. Obrigatório para pedidos TAKEOUT e INDOOR.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/readyForPickup' \
  --header 'Authorization: Bearer {token}'

Pedido retirado pelo cliente

Em pedidos TAKEOUT, informe quando o cliente retirar o pedido no estabelecimento.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/pickedUp' \
  --header 'Authorization: Bearer {token}'

Despachar um pedido

O pedido saiu para entrega. Obrigatório para pedidos DELIVERY.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/dispatch' \
  --header 'Authorization: Bearer {token}'

Pedido entregue

O pedido chegou ao cliente. Use esta ação para fechar o ciclo de vida do pedido.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/delivered' \
  --header 'Authorization: Bearer {token}'

Requisitar cancelamento de um pedido

Quando a loja não vai atender o pedido, por exemplo por falta de item ou fora da área de entrega. O pedido é cancelado na hora e gera o evento CANCELLED. A resposta é 200 OK com o id do pedido.

string

Motivo padronizado: SYSTEMIC_ISSUES, DUPLICATE_APPLICATION, UNAVAILABLE_ITEM, RESTAURANT_WITHOUT_DELIVERY_MAN, OUTDATED_MENU, ORDER_OUTSIDE_THE_DELIVERY_AREA, BLOCKED_CUSTOMER, OUTSIDE_DELIVERY_HOURS, INTERNAL_DIFFICULTIES_OF_THE_RESTAURANT ou RISK_AREA.

string

Descrição livre do motivo.

string

AUTO ou MANUAL.

string[]

Itens em falta.

string[]

Itens inválidos.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/requestCancellation' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "UNAVAILABLE_ITEM",
    "reason": "Produto esgotado",
    "mode": "MANUAL"
  }'

Aceitar cancelamento de um pedido

POST /merchant/v3/orders/{orderId}/acceptCancellation e POST /merchant/v3/orders/{orderId}/denyCancellation existem por compatibilidade com a especificação Open Delivery e respondem 200 OK. Hoje a DeliveryVip não emite pedidos de cancelamento para o seu sistema responder (veja os eventos previstos na especificação), então você não precisa chamá-los.

Tracking

Envie dados de rastreio da entrega: o último status, problemas, veículo, previsão de chegada, entregador e localização. No acompanhamento do pedido, o cliente vê o link de rastreio e o painel da loja mostra cada atualização em tempo real. Os campos vão na raiz do corpo, como na especificação Open Delivery. Um corpo com campo desconhecido ou type fora da lista é recusado com 422.

O formato antigo, com os campos dentro de deliveryTrackingInfo, continua aceito por compatibilidade. Prefira os campos na raiz.

object

Último evento conhecido da entrega. Obrigatório quando não houver problem.

Mostrar propriedades

string

obrigatório

PICKUP_ONGOING, ARRIVED_AT_MERCHANT, ORDER_PICKED, DELIVERY_ONGOING, ARRIVED_AT_CUSTOMER, ORDER_DELIVERED ou CANCELLED.

string

Mensagem sobre o evento.

datetime

obrigatório

Data e hora do evento.

object

Último problema conhecido da entrega.

Mostrar propriedades

string

obrigatório

DELIVERYPERSON_OCCURRENCE, PAYMENT_PROBLEMS, WRONG_PRODUCT_OR_ITEM, ORDER_DELAYED, ORDER_DAMAGED_OR_VIOLATED, CUSTOMER_DID_NOT_PLACE_ORDER, CUSTOMER_ADDRESS_UNKNOWN, ORDER_MISSING_ITEMS, NOBODY_TO_RECEIVE, DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER, ORDER_DELIVERED_WITHOUT_PAYMENT ou FRAUD_OR_THEFT.

string

Mensagem sobre o problema.

datetime

obrigatório

Data e hora do problema.

object

Mostrar propriedades

string

obrigatório

MOTORBIKE_BAG, MOTORBIKE_BOX, CAR, BICYCLE, SCOOTER ou VUC.

string

Placa do veículo.

object

Mostrar propriedades

integer

Minutos até buscar o pedido.

datetime

Data e hora previstas para buscar o pedido.

integer

Minutos até entregar o pedido.

datetime

Data e hora previstas para a entrega.

datetime

Prazo máximo da entrega.

object

Mostrar propriedades

uuid

Identificação do entregador.

string

Nome do entregador.

uri

Foto do entregador.

object

Latitude, longitude e último endereço conhecido do entregador (lastAddress). Quando enviar lastAddress, inclua distanceToPickup, distanceToDelivery e timestamp.

string

Link de rastreio que o cliente vê no acompanhamento do pedido.

Exemplo completo

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}/tracking' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": {
    "type": "DELIVERY_ONGOING",
    "message": "Entregador a caminho",
    "datetime": "2019-08-24T14:15:22Z"
  },
  "vehicle": {
    "type": "MOTORBIKE_BAG",
    "licencePlate": "ABC1D23"
  },
  "eta": {
    "deliveryEtaInMinutes": 15,
    "deliveryEtaDatetime": "2019-08-24T14:30:22Z"
  },
  "deliveryPerson": {
    "name": "João",
    "pictureURL": "https://exemplo.com/joao.png"
  },
  "geoLocalization": {
    "latitude": -23.54809,
    "longitude": -46.63638,
    "lastAddress": {
      "country": "BR",
      "state": "BR-SP",
      "city": "São Paulo",
      "district": "Moema",
      "street": "Plaza Avenue",
      "postalCode": "20111-000",
      "distanceToPickup": "1200",
      "distanceToDelivery": "3400",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  },
  "externalTrackingURL": "https://exemplo.com/rastreio/123"
}'

Status da entrega no painel — O status da entrega no painel da loja

Visão geral

Pedidos

Catálogo

Indoor

Descontos

Ferramentas

Referência

Respostas

Confirmar um pedido

Preparando um pedido

Pronto para pegar um pedido

Pedido retirado pelo cliente

Despachar um pedido

Pedido entregue

Requisitar cancelamento de um pedido

Aceitar cancelamento de um pedido

Tracking

​Respostas

​Confirmar um pedido

​Preparando um pedido

​Pronto para pegar um pedido

​Pedido retirado pelo cliente

​Despachar um pedido

​Pedido entregue

​Requisitar cancelamento de um pedido

​Aceitar cancelamento de um pedido

​Tracking

Respostas

Confirmar um pedido

Preparando um pedido

Pronto para pegar um pedido

Pedido retirado pelo cliente

Despachar um pedido

Pedido entregue

Requisitar cancelamento de um pedido

Aceitar cancelamento de um pedido

Tracking