TOTVS Food Service

Páginas filhas
  • API Order Mesa - Cancelled Items

Versões comparadas

Versão antiga 7

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

comparado com

Nova versão 8

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

Chave

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

...

MétodoURL
POSThttps://api-barramento.meuelevestage.com/order/cancelledItenscancelledItems


...

03. EXEMPLO DE UTILIZAÇÃO

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

Âncora
todos_status
todos_status

...

Nota
titleNota: HTTP Status Code = 226 IM Used

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.


...

02. Request. Corpo da requisição de múltiplos cancelamentosvários pedidos cancelados no PDV especifico, para obter se os itens cancelados foram enviados com sucesso :

Âncora
multiplos
multiplos

Bloco de código
titleCorpo da requisição no JSON
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "d01ea5cd-7952-4b77-b0ae-ed93aa32e832",
	"orderKeyType": "TABLE",
	"orderKey": [
		"22",
		"23"
	],
	"lastestUpdatedStatus": "2024-07-18 09:48:03",
	"items": [
		{
			"id": "39735945",
			"index": "5",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-07-17 14:19:33",
			"cancellationReason": " 55596;",
			"tableCardNumber": "22",
			"productionPoint": "NENHUM"
		},
		{
			"id": "3973594011",
			"index": "19",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-07-17 16:04:27",
			"cancellationReason": " 55596;",
			"tableCardNumber": "23",
			"productionPoint": "NENHUM"
		}
	]
}
Dica
titleDicaRequest

O corpo da requisição enviada request preenchida, deverá ser obrigatóriamente o é o mesmo que o corpo da resposta obtida do response obtido através do endpoint GetCancelledItems



integrationHubServiceId: é um código da integração da loja com o Integration Hub

orderKey: é o código do pedido
Informações
titleNotaInformaçõ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: O identificador do serviço 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.
    • index: O índice do item.
    • name: O nome do item.
    • externalCode: O código externo do item.
    • quantity: A quantidade do item cancelado.
    • cancellationAgent: O agente 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
titleInformação:


Dicionário de Retorno


Informações sobre os retornos da API cancelledItems.

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


...

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:

...