Consigo integrar a OlaClick com outros sistemas?

Sim, é perfeitamente possível! A OlaClick oferece uma API (Interface de Programação de Aplicações) que funciona como uma "ponte" de comunicação, permitindo que diferentes sistemas de software interajam entre si de forma automática e segura.

Esta documentação descreve como os parceiros podem se integrar ao sistema de pedidos da OlaClick para receber e gerenciar pedidos de entrega.

Introdução

A integração de parceiros permite que sistemas externos recebam notificações em tempo real sobre novos pedidos e atualizações de status via webhooks.

Autenticação

Todas as requisições para a API devem incluir a seguinte chave no cabeçalho (header):

x-api-key: Sua chave de API fornecida pela OlaClick.

Webhooks

Para começar a receber pedidos, você deve fornecer uma URL de Webhook. A OlaClick enviará uma requisição POST para esta URL sempre que um pedido for criado ou atualizado.

Exemplo de Payload (JSON) do Webhook:

JSON

{   "order_id": "string",   "store_id": "string",   "status": "string",   "customer": {     "name": "string",     "phone": "string",     "address": {       "street": "string",       "city": "string",       "coordinates": {         "lat": "number",         "lng": "number"       }     }   },   "items": [     {       "name": "string",       "quantity": "number",       "price": "number",       "modifiers": []     }   ],   "total": "number",   "payment_method": "string" }

Ciclo de Vida do Pedido e Status

O parceiro deve lidar com os seguintes status:

CREATED (CRIADO): O pedido foi recebido pelo sistema OlaClick.
CONFIRMED (CONFIRMADO): O restaurante aceitou o pedido.
READY (PRONTO): O pedido está pronto para ser retirado. Este é o gatilho comum para despachar a logística.
IN_TRANSIT (EM TRÂNSITO): O entregador retirou o pedido e está a caminho.
DELIVERED (ENTREGUE): O pedido foi entregue com sucesso ao cliente.
CANCELLED (CANCELADO): O pedido foi cancelado pelo restaurante ou pelo cliente.

Endpoints da API

1. Obter Detalhes do Pedido

GET /v1/orders/{order_id}

Retorna as informações completas de um pedido específico.

2. Atualizar Status do Pedido

PATCH /v1/orders/{order_id}/status

Permite que o parceiro atualize o status do pedido (ex: mudar de READY para IN_TRANSIT).

Exemplo de Corpo da Requisição (JSON):