...
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
Método | URL | Ambiente |
---|
POST | https://api-barramento.meuelevestage.com/order/cancelledItems | Homologação |
POST | https://api-barramento.meueleve.com.br/order/cancelledItems | Produçã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 :
...
Informações |
---|
title | Informaçõ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:
Campo | Valor |
---|
code | código do erro |
message | messagem do erro |
- orderKeyType: Deve respeita a tabela abaixo:
Enum | Valor |
---|
TABLE | TABLE |
CARD | CARD |
ORDERD_ID | ORDER_ID |
- orderKey: É o identificador do pedido:
Campo | Valor |
---|
orderKey | Código de identificação do pedido, sendo uma "string" |
...
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
...