Histórico da Página

CONTEÚDO

• Visão Geral
• Endpoint
• Exemplo de Utilização
  • Retornar todos os status dos consumos
  • Cancelamento de um pedido especifico
  • Cancelamento de múltiplos pedidosObter detalhes de um consumo específico
• 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.

...

...

02. ENDPOINT

Âncora
endpoint endpoint

...

...

03. EXEMPLO DE UTILIZAÇÃO

Âncora
utilizar utilizar

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.

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

...

3.4 -  Request - Enviando o pedido para requisição do cancelamento de 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": "1853f0ab7056c970-faf7cb11-47d6400f-a1939d4f-610b208071439f30253f3b0b",
	"orderKeyType": "TABLE",
	"orderKey": [
		"22",
		"4023"
	],
	"lastestUpdatedStatus": "2024-0607-2817 0916:0418:0640",
	"items": [
		{
			"id": "50425147-5d06-4b87-a05b-4586f2dccc7139735945",
			"statusindex": {"5",
				"codename": 505"MARACUJA",
				"descriptionexternalCode": "TABLE_IN_USE58",
			}"quantity": 1,
			"deliveryAgentcancellationAgent": null"ALBINO",
			"deliveryDateTimecancellationDateTime": null "2024-07-17 14:19:33",
			"cancellationReason": " null55596;",
			"tableCardNumber": "4022",
			"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:

• Estrutura Enumeração integrationHubServiceId:

• Estrutura Enumeração orderKeyType:

...

04. ERROS

Âncora
erros erros

...

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

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "647469f8-b31b-4fae-ba33-99e04def555b",
	"orderKeyType": "TABLE",
	"orderKey": [
		"18",
		"19"
	],
	"lastestUpdatedStatus": "2024-06-28 09:13:46",
	"items": [
		{
			"id": "8c3752a1-ae15-42a1-bafb-189ca95f0211",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "18"
		},
		{
			"id": "5ebf990f-9075-462c-b675-a8c57a350d61",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "19"
		}
	]
}

...

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:

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

{
    "integrationHubServiceId": "393d95727056c970-2ec9cb11-4cda400f-9ad39d4f-5b69e02c988d9f30253f3b0b",
	  "orderKeyType": "string",
	   "orderKey": ["string22"]
}

{
	"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.02. JSON enviando faltando um ou mais campos.

{
    "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.03. GUID incorreto 

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

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

...

04. Enviando uma requisição 4.4 - Requisição enviada sem informar o código da  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.

{
	"errors": [
		{
			"key    "integrationHubServiceId": 0,
			"message": "body.orderKey[0] is not allowed to be empty"
		}
	]
}

...

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

{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}

...

• HTTP Status Code 403 401 - ForbiddenUnauthorized

  Âncora
  status_code_

  403

  401 status_code_

  403

  401

   

O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL incorreta

https://api-barramento.meuelevestage.com/order/getStatuS

...

...

401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

...

• HTTP Status Code 404 403 - Not FoundForbidden

  Âncora
  status_code_404403 status_code_404403

O código de status HTTP 404403, conhecido como "Not FoundForbidden" (Não EncontradoProibido), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId  está incorreto ou inválido.entendeu a requisição do cliente por está tentando acessar uma URL incorreta

https://api-barramento.meuelevestage.com/order/getCancelledItensS

{
    "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	  "orderKeyType": "TABLE",
	  "orderKey": ["5"]
}

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
		}
	]
}

...

 "Missing Authentication Token"
}

...

• HTTP Status Code 404 - Not Found

  Âncora
  status_code_404 status_code_404

O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId  está incorreto ou inválido.

{
    "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	  "orderKeyType": "TABLE",
	  "orderKey": ["5"]
}

{
    "integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
	  "orderKeyType	"errors": [
		{
			"key": "TABLEintegrationHubServiceId",
			  "orderKeymessage": []
}

{
	"message": "NOT_FOUND",
	"code": 412 "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
		}
	]
}

...

• HTTP Status Code 429 - Too Many Requests

  Âncora
  status_code_429 status_code_429

...

{
    "integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
	  "orderKeyType": "TABLE",
		  "orderKey": ["5"]
}

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7d7d205b5ffec6b8-83ba1c55-47c54a7d-91ba985f-e4f32a2bbd9e12d13685b553",
	"orderKeyType": "TABLE",
	"orderKey": [
		"522"
	],
	"lastestUpdatedStatus": "2024-07-0217 1817:5408:2845",
	"items": [
		{
			"id": "de9fd388-c223-4325-a64d-08889250f83939735945",
			"index": "5",
			"statusname": {"MARACUJA",
			"externalCode": "58",
			"codequantity": 5041,
				"descriptioncancellationAgent": "OPEN_TABLE"
			}ALBINO",
			"deliveryAgentcancellationDateTime": null"2024-07-17 14:19:33",
			"deliveryDateTimecancellationReason": " null55596;",
			"cancellationReasontableCardNumber": null"22",
			"tableCardNumberproductionPoint": "5NENHUM"
		}
	]
}

05. LINKS