Páginas filhas
  • API Order Mesa - Cancelled Items

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

O endpoint CancelledItems da API Order Mesa é utilizado para envio do resultado da solicitação de itens cancelados de pedido através do Ponto de Vendas (PDV). Este endpoint recebe o mesmo corpo da resposta obtida pelo endpoint GetCancelledItems -   API Order Mesa - Get Cancelled Items


...

02. ENDPOINT
Âncora
endpoint
endpoint


MétodoURLAmbiente
POSThttps://api-barramento.meuelevestage.com/order/cancelledItemsHomologação
POSThttps://api-barramento.meueleve.com.br/order/cancelledItemsProdução


...

03. EXEMPLO DE UTILIZAÇÃO

01 - Request. Corpo da requisição de um pedido especifico cancelado no PDV especifico, para obter se os itens cancelados foram enviados com sucesso :

Âncora
todos_status
todos_status

...

Informações
titleInformações dos campos:

Neste exemplo, os dados retornados incluem:

  • success: Indica se a operação foi bem-sucedida.
  • error: Contém informações sobre erros, se houver.
  • integrationHubServiceId: Chave de identificação de integração.
  • orderKeyType: O tipo da chave do pedido (neste caso, "TABLE") que podem ser [ TABLE, CARD, ORDER_ID ].
  • orderKey: Uma lista de identificadores de pedidos (neste caso, número de mesa).
  • lastestUpdatedStatus: A data e hora da última atualização do status dos pedidos.
  • items: Uma lista de itens cancelados, onde cada item inclui:
    • id: O identificador do item. Alterar - Identificador do produto no lançamento
    • index: O índice do item.  Alterar - Identificador do produto no lançamento
    • name: O nome do item.
    • externalCode: O código externo do item. Alterar - O código do Produto no PDV integrado
    • quantity: A quantidade do item cancelado.
    • cancellationAgent: O operador que realizou o cancelamento.
    • cancellationDateTime: Data e hora do cancelamento.
    • cancellationReason: O motivo do cancelamento.
    • tableCardNumber: O número da mesa ou do cartão associado ao item cancelado.
    • productionPoint: O ponto de produção associado ao item.

...

Informações sobre os retornos da API cancelledItems.

  • error: O erro é necessário quando o sucesso é falso. Deve retornar caso haja o seguinte:
CampoValor
codecódigo do erro
messagemessagem do erro


  • orderKeyType: Deve respeita a tabela abaixo:
EnumValor
TABLETABLE
CARDCARD
ORDERD_IDORDER_ID


  • orderKey: É o identificador do pedido:
CampoValor
orderKeyCódigo de identificação do pedido, sendo uma "string"


...

04. ERROS
Âncora
erros
erros

A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:

...