Histórico da Página

...

3.1 - Request - Enviando a solicitação para o cancelamento de um pedido específico:

Ao fazer essa requisição, o sistema processa a solicitação de cancelamento do pedido indicado.

...

3.2 - Request - Ao reenviar a solicitação, a resposta retornada será a seguinte:

Após reenviar a requisição, você receberá uma resposta detalhando o status atualizado do processamento do pedido.

...

3.3 - Request - Ao enviar novamente a solicitação, o processamento será realizado conforme a seguinte resposta:

Reenviando a requisição, o sistema processará o pedido e retornará uma resposta que reflete o status do processamento realizado.

...

...

023.4 -  Request - Enviando o pedido para requisição do cancelamento de múltiplos pedidos:múltiplos pedidos:
Essa requisição é utilizada para solicitar o cancelamento de diversos pedidos simultaneamente, permitindo que o sistema processe e cancele cada pedido listado de forma eficiente.

{
  "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType": "TABLE",
  "orderKey": ["22", "23"]
}

...

3.5 - Request - Ao reenviar a solicitação, a resposta retornada será a seguinte:

Após reenviar a requisição, você receberá uma resposta detalhando o status atualizado do processamento do pedido.

{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order cancelled itens request already exists: TABLE_22,23"
		}
	]
}

...

3.6 - Request - Ao enviar novamente a solicitação, o processamento será realizado conforme a seguinte resposta:

Reenviando a requisição, o sistema processará o pedido e retornará uma resposta que reflete o status do processamento realizado.

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "TABLE",
	"orderKey": [
		"22",
		"23"
	],
	"lastestUpdatedStatus": "2024-07-17 16:18:40",
	"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"
		}
	]
}

...

Dicionário da Request

...

Informações

...

sobre os campos da API cancelledItems:

Neste exemplo, os dados retornados incluem:

• Estrutura Enumeração integrationHubServiceId:

...

...

orderKeyType: O tipo da chave do pedido, podendo ser um dos seguintes valores:

• Estrutura Enumeração orderKeyType:

...

...

...

...

...

...

• Estrutura Enumeração orderKey:

...

04. ERROS

Dicionário da Requisição:

• orderKeyType: Deve respeita a tabela abaixo:

...

Informações
title Informações dos dados retornados:
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.

...

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

...

Âncora
erros erros

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

• HTTP Status Code - 400 - Bad Request

  Âncora
  status_code_400 status_code_400

O código de status HTTP 400, conhecido como "Bad Request" (Requisição

...

O código de status HTTP 400, conhecido como "Bad Request" (Requisição Inválida), indica que o servidor não pôde processar a requisição do cliente devido a uma sintaxe inválida, estrutura malformada ou dados inválidos presentes na requisição.:

4.1

...

- Formato inválido do JSON esperado:

A requisição foi enviada com um JSON malformado ou inválido, o que impede o sistema de interpretá-la corretamente. Isso ocorre quando a estrutura JSON contém erros de sintaxe, como chaves ou colchetes incorretos.

Bloco de código
title JSON Inválido linenumbers true
{ "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b", "orderKeyType": "string", "orderKey": ["22"] }

Bloco de código
title JSON Resposta linenumbers true
{ "errors": [ { "key": "orderKeyType", "message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]" } ] }

...

4.2

...

- JSON enviado com a ausência de um ou mais campos obrigatórios:

Se a requisição estiver faltando um ou mais campos obrigatórios, o servidor responderá com um erro 400. Cada campo requerido deve estar presente para que a operação seja processada corretamente.

Bloco de código
title JSON Inválido linenumbers true
{ "integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56" }

Bloco de código
title JSON Resposta linenumbers true
{ "errors": [ { "key": "orderKeyType", "message": "body.orderKeyType is required" }, { "key": "orderKey", "message": "body.orderKey is required" } ] }

...

4.3 -  GUID incorreto:

O GUID (Identificador Globalmente Único) enviado na requisição está incorreto ou malformado, o que pode resultar em um erro.

...

Um GUID é uma sequência específica que deve seguir o padrão correto.

Bloco de código
title JSON com o GUID inválido linenumbers true
{ "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A", "orderKeyType": "TABLE", "orderKey": [] }

Bloco de código
title JSON Inválido GUID incorreto linenumbers true
{ "errors": [ { "key": "integrationHubServiceId", "message": "body.integrationHubServiceId must be a valid GUID" } ] }

...

] }

...

4.4 - Requisição enviada sem informar o orderKey corretamente:

Caso a requisição seja enviada sem o campo orderKey ou com o valor incorreto, o sistema não conseguirá identificar o pedido, resultando em um erro 400. O orderKey deve estar corretamente preenchido e de acordo com o orderKeyType informado.

Bloco de código
title JSON com sem informar o código da orderKey linenumbers true
{ "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222", "orderKeyType": "TABLE", "orderKey": [""] }

...