Host: Keeta. Pré-requisito: lojas registradas com PUT /v1/merchantOnboarding.
| Parâmetro | Onde | Descrição |
|---|---|---|
x-polling-merchants | header (array) | IDs dos merchants no seu sistema a consultar (os mesmos do onboarding) |
eventType | query (array) | Filtra tipos; os demais são confirmados automaticamente e omitidos. Omita ou envie com valor — nunca vazio |
Resposta 200 — lista de eventos:
| Campo | Tipo | Descrição |
|---|---|---|
eventId | string | ID único do evento |
eventType | string | Ver Tipos de evento no Guia de Desenvolvimento |
orderId | string | ID do pedido (gerado pela Keeta) |
orderURL | string | URL dos detalhes do pedido |
createdAt | string | Data/hora UTC, ISO 8601 |
sourceAppId | string | App Keeta de origem (útil para hubs) |
virtualBrand | string | ID alternativo do merchant (ex.: dark kitchen com várias marcas) |
metadata | string (JSON) | Presente em alguns eventos (CANCELLED, USER_REFUND_REQUEST, PICKUP_ONGOING, RECOMMENDED_PREPARATION_START) |
Respostas: 200, 204, 400, 401, 403, 503.
Desired event types. All other events not selected by group will be automatically acknowledged and omitted from the response. Must either be omitted or non-empty.
Event Types definitions:
CREATED: Order created.CONFIRMED: Order confirmed.READY_FOR_PICKUP: Order ready for pickup by the customer or delivery person.DISPATCHED: Order went out for delivery.PICKED_UP: Order has been picked up by customer. Since there is currently no self-pickup scenario, the PICKED_UP event will not be received.DELIVERED: Order has been delivered to customer.CONCLUDED: Order completed.CANCELLATION_REQUESTED: Sent by the Software Service to Keeta.CANCELLED: When the order is actually cancelled.USER_REFUND_REQUEST: Sent by Keeta to the Software Service.REFUNDED: Sent by Keeta to the Software Service.REFUND_FAILED: Sent by Keeta to the Software Service.RECOMMENDED_PREPARATION_START: Sent by Keeta to notify the merchant to begin kitchen preparation immediately.
- https://open.mykeeta.com/api/open/opendeliveryhttps://open.mykeeta.com/api/open/opendelivery/v1/events:polling
curl -i -X GET \
'https://open.mykeeta.com/api/open/opendelivery/v1/events:polling?eventType=CREATED,CANCELLED,CONCLUDED' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'X-App-Signature: YOUR_API_KEY_HERE' \
-H 'x-polling-merchants: 22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824'Successful returns list of polled events .
Tipo do evento. Consulte a definição de cada tipo em Eventos de pedidos.
AppId da Keeta que originou o pedido. Ajuda aplicações que atuam como Hub e intermediam as solicitações entre a Keeta e o Software Service.
[ { "eventId": "string", "eventType": "CREATED", "orderId": "string", "orderURL": "http://example.com", "createdAt": "2019-08-24T14:15:22Z", "sourceAppId": "string", "virtualBrand": "string" } ]