TOTVS Food Service

Páginas filhas
  • API Order Mesa - Get Cancelled Items

Versões comparadas

Versão antiga 3

changes.mady.by.user Cristiano da Silva Ferreira Mothe

Gravado em

comparado com

Nova versão 6

changes.mady.by.user Cristiano da Silva Ferreira Mothe

Gravado em

Chave

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

...

...

Este endpoint é utilizado para obter itens de cancelamento de pedidos por meio de integração do PDV, fornecendo um retorno em formato JSON com os itens cancelados.

...

Bloco de código
titleJSON de retorno de múltiplos pedidos
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "d5152936-5678-44ef-9d8e-e41462155a76",
	"orderKeyType": "TABLE",
	"orderKey": [
		"2",
		"5"
	],
	"lastestUpdatedStatus": "2024-08-16 09:28:06",
	"items": [
		{
			"id": "2",
			"index": "2",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-08-16 09:26:56",
			"cancellationReason": " 55596;",
			"tableCardNumber": "2",
			"productionPoint": "NENHUM"
		},
		{
			"id": "5",
			"index": "5",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-08-16 09:27:09",
			"cancellationReason": " 55596;",
			"tableCardNumber": "5",
			"productionPoint": "NENHUM"
		}
	]
}
Informações
titleNota:

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
Informações
titleNota:

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 de integração.
  • orderKeyType: O tipo da chave do pedido (neste caso, "TABLE").
  • orderKey: Uma lista de identificadores de pedidos (neste caso, números 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:

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

orderKey: é o código do pedido

Dica
titleObservação:

Para o correto funcionamento desse endpoint, o respectivo pedido deverá ter sido previamente cancelado no PDV para a API retornar a resposta do pedido cancelado



...

04. ERROS

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

...