Histórico da Página

CONTEÚDO

• Visão Geral
• Endpoint
• Exemplo de Utilização
  • Cancelamento de um pedido especifico
  • Cancelamento de múltiplos pedidos
• Erros
  • HTTP Status Code 400 - Bad Request
  • HTTP Status Code 401 - Unauthorized
  • HTTP Status Code 403 - Forbidden
  • HTTP Status Code 404 - Not Found
  • HTTP Status Code 412 - Precondition Failed
  • HTTP Status Code 429 - Too Many Requests
• Links

...

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.

...

Obtenha os itens cancelados atribuídos a um ou mais pedidos utilizando o parâmetro orderKeyType, que pode ser ORDER_ID, TABLE ou CARD.

...

TABLEou CARD

...

.

...

02. ENDPOINT

Âncora
endpoint endpoint

03. EXEMPLO DE UTILIZAÇÃO

...

03. EXEMPLO DE UTILIZAÇÃO

Âncora
utilizar utilizar

3.1 - Request - Enviando a solicitação para o 01. Enviando o pedido para requisição do cancelamento de um pedido especifico: específico:

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

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

...

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.

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

...

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.

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

...

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"
		}
	]
}

04. ERROS

...

Dicionário da Request

Informações sobre os campos da API cancelledItems:

• Estrutura Enumeração integrationHubServiceId:

• Estrutura Enumeração orderKeyType:

• Estrutura Enumeração orderKey:

...

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:

...

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.:01. Formando inválido do JSON esperado

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.

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

{
	"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.

{
    "integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
}

{
	"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.

{
    "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

{
	"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.

{
    "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
	  "orderKeyType": "TABLE",
	  "orderKey": [""]
}

...

05. LINKS