Pular para o conteúdo

Solicitar cancelamento

Requisição

Host: Keeta.

CampoObrig.Descrição
reasonsimTexto livre
codesimVer Códigos de cancelamento (v1.0.7+) no Guia de Desenvolvimento
modesimAUTO ou MANUAL
outOfStockItems[]nãoItens sem estoque
invalidItems[]nãoItens inexistentes; com OUTDATED_MENU, são desativados no cardápio. Informe os IDs dos itens na Keeta
{ "reason": "Acabou o pão de queijo", "code": "UNAVAILABLE_ITEM", "mode": "MANUAL", "outOfStockItems": ["PDV-1002"] }

202 → espere CANCELLATION_REQUESTED e, se aceito, CANCELLED.

Segurança
OAuth2(Escopos obrigatórios: od.all) and Sig
Caminho
orderIdstringobrigatório

The unique identifier of the order. The order ID is generated by Keeta.

Corpoapplication/jsonobrigatório
reasonstringobrigatório

Campo de texto livre que informa o motivo do cancelamento.

codestringobrigatório

Explanation: The enumeration values have been updated. The old values are: INSUFFICIENT-DISHES, SUSPENSION OF OF BUSINESS, INSUFICS-MANPOWER, THE. Although the new enumeration value maintains compatibility with the old enumeration value, we strongly recommend using the new enumeration value. If you are using an old value, please update it as soon as possible. Thank you for your cooperation.

Enum:"SYSTEMIC_ISSUES""DUPLICATE_APPLICATION""UNAVAILABLE_ITEM""RESTAURANT_WITHOUT_DELIVERY_PERSON""OUTDATED_MENU""ORDER_OUTSIDE_THE_DELIVERY_AREA""BLOCKED_CUSTOMER""OUTSIDE_DELIVERY_HOURS""INTERNAL_DIFFICULTIES_OF_THE_RESTAURANT""RISK_AREA"
modestringobrigatório

Indica se a solicitação de cancelamento foi feita por processo automático ou manual no Software Service.

Enum:"AUTO""MANUAL"
outOfStockItemsArray of strings, <= 100 items

Itens que não estão no estoque do merchant.

invalidItemsArray of strings, <= 100 items

Itens que não existem no estoque do merchant.

Quando code for OUTDATED_MENU, os itens listados em invalidItems serão desativados. Informe os IDs dos itens na Keeta.

curl -i -X POST \
  'https://open.mykeeta.com/api/open/opendelivery/v1/orders/{orderId}/requestCancellation' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-App-Signature: YOUR_API_KEY_HERE' \
  -d '{
    "reason": "string",
    "code": "SYSTEMIC_ISSUES",
    "mode": "AUTO",
    "outOfStockItems": [
      "string"
    ],
    "invalidItems": [
      "string"
    ]
  }'

Respostas

Request has been accepted for processing.

Resposta
Nenhum conteúdo