Histórico da Página

...

02. ENDPOINT
Âncora
endpoint
endpoint

Método	URL	Ambiente
POST	https://api-barramento.meuelevestage.com/order/getStatus	Homologação
POST	https://api-barramento.meueleve.com/order/getStatus	Produção

...

03. EXEMPLO DE UTILIZAÇÃO
Âncora
utilizar
utilizar

013.1 - Request - Retornar o status de múltiplos pedidos:

Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido. Retornar todos os estados dos pedidos:

Âncora

	todos_status
	todos_status

Bloco de código

title	JSON Para retornar o status de todos os pedidos
linenumbers	true

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

Bloco de códigonote

title	Resposta do JSON da requisição
linenumbers	true
Nota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

...

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

Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código

title	JSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumbers	true

{
	"errors": {
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": [],
	"lastestUpdatedStatus": "2024-09-12 11:30:10",
	"items": [
		{
			"idkey": "ad976378-8823-48d3-9cd1-62d68cf3be77",
"orderKeyType_orderKey",
			"statusmessage": "Order status request already exists: CARD_"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

...

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

Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código

title	Resposta do JSON da requisição
linenumbers	true

{
	"success": true,
	"error{
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "1"
		},
		{
			"id": "2160c838-97d0-432f-a43a-dce087150d49",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTimeintegrationHubServiceId": null"7056c970-cb11-400f-9d4f-9f30253f3b0b",
			"cancellationReasonorderKeyType": null"CARD",
		"orderKey": [],
	"tableCardNumberlastestUpdatedStatus": "340"
		},2024-09-12 11:30:10",
	"items": [
		{
			"id": "b17fd862ad976378-c06d8823-4bce48d3-9f119cd1-358a2be0466862d68cf3be77",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "3701"
		},
		{
			"id": "5b8d7e5c2160c838-f87e97d0-40ac432f-91b7a43a-726da529fc88dce087150d49",
			"status": {
				"code": 504505,
				"description": "OPENTABLE_IN_TABLEUSE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "4040340"
		}
	]
}

...

Bloco de código

title	JSON Para retornar o status de um pedido específico
linenumbers	true

{
  "integrationHubServiceId,
		{
			"id": "7056c970b17fd862-cb11c06d-400f4bce-9d4f9f11-9f30253f3b0b358a2be04668",
  "orderKeyType			"status": "CARD",
  "orderKey{
				"code": 504,
				"description": ["40OPEN_TABLE"]
}

Nota

title	Nota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

Bloco de código

title	JSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumbers	true

{
	"errors": [
		{			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"keytableCardNumber": "orderKeyType_orderKey",370"
		},
		{
			"messageid": "Order status request already exists: CARD_40"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

Bloco de código

title	JSON de resposta do retorno de um pedido
linenumbers	true

{
	"success": true,
	"error5b8d7e5c-f87e-40ac-91b7-726da529fc88",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"integrationHubServiceIdtableCardNumber": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": ["40"],
	"lastestUpdatedStatus": "2024-06-28 09:04:06",
	"items": [
		{
			"id": "50425147-5d06-4b87-a05b-4586f2dccc71",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "40"
		}
	]
}4040"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

3.4 - Request - Obter detalhes de um pedido específico:

Essa requisição é utilizada para buscar informações detalhadas sobre um pedido específico:

Âncora

	detalhes_pedido_especifico
	detalhes_pedido_especifico

Bloco de código

title	JSON Para retornar o status de um pedido específico
linenumbers	true

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

Nota

title	Nota: HTTP Status Code = 226 IM Used202 Accepted

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

...

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

Ao reenviar a requisição, você receberá uma resposta contendo o status atualizado e os detalhes do pedido.03. Retornar o status de múltiplos pedidos: Âncoramultiplosmultiplos

Bloco de código

title	JSON Para retornar múltiplos pedidosde resposta do retorno de um pedido específico HTTP Status Code = 208
linenumbers	true

{
  	"integrationHubServiceIderrors": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType[
		{
			"key": "TABLEorderKeyType_orderKey",
  "orderKey			"message": ["40", "20"]
}"Order status request already exists: CARD_40"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

...

3.6 - Request - Reenvio da solicitação, resposta de processamento:

Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento.

Bloco de código

title	JSON de resposta do retorno de um pedido
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": ["40"],
	"

Bloco de código

title	JSON de retorno de múltiplos pedidos
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": [
		"40",
		"20"
	],
	"lastestUpdatedStatus": "2024-0906-1228 1109:5604:0906",
	"items": [
		{
			"id": "2160c83850425147-97d05d06-432f4b87-a43aa05b-dce087150d494586f2dccc71",
			"status": {
				"code": 504505,
				"description": "OPENTABLE_IN_TABLEUSE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "34040"
		},
		{
			"id": "360",
			"status": {
				"code": 412,
				"description": "NOT_FOUND"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": null
		}
	]
}]
}

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

3.7 - Request - Retornar o status de múltiplos pedidos:

Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido:

Âncora

	multiplos
	multiplos

Bloco de código

title	JSON Para retornar múltiplos pedidos
linenumbers	true

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

Nota

title	Nota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

...

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

Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código

title	JSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumbers	true

{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: CARD_40, 20"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

...

3.6 - Request - Reenvio da solicitação, resposta de processamento:

Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento:

Bloco de código

title	JSON de retorno de múltiplos pedidos
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": [
		"40",
		"20"
	],
	"lastestUpdatedStatus": "2024-09-12 11:56:09",
	"items": [
		{
			"id": "2160c838-97d0-432f-a43a-dce087150d49",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "340"
		},
		{
			"id": "360",
			"status": {
				"code": 412,
				"description": "NOT_FOUND"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": null
		}
	]
}

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

Dicionário de Requisição

Essa requisição permite consultar o status atualizado de um pedido, retornando informações detalhadas sobre cada item associado ao pedido e possíveis erros ocorridos durante o processo. A integração é identificada de forma única através da integrationHubServiceId

Detalhamento dos campos da requisição:

Campo	Valor	Descrição
integrationHubServiceId	string	Chave de identificação da integração no hub
orderKeyType	enum "TABLE", "CARD", "ORDER_ID"	Tipo de chave do pedido, que pode ser mesa, cartão ou ID do pedido
orderKey	string	Identificador do pedido, de acordo com o tipo definido em orderKeyType

Enumerações do campo orderKeyType:

Enum	Descrição
TABLE	Identifica o pedido pelo número da mesa
CARD	Identifica o pedido pelo número do cartão
ORDER_ID	Identifica o pedido por um ID exclusivo do pedido

...

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

Bloco de código

title	JSON Inválido
linenumbers	true

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

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

Bloco de código

title	JSON Inválido
linenumbers	true

{
    "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b"
}

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

Bloco de código

title	JSON com o GUID inválido
linenumbers	true

{
    "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3bAA",
	  "orderKeyType": "CARD",
	  "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.04. Enviando uma requisição sem informar o código da orderKey corretamente

Bloco de código

title	JSON com sem informar o código da orderKey
linenumbers	true

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

...

Páginas filhas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
utilizar
utilizar

04. ERROS
Âncora
erros
erros

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

02. ENDPOINT Âncoraendpointendpoint

03. EXEMPLO DE UTILIZAÇÃO Âncorautilizarutilizar

04. ERROS Âncoraerroserros

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
utilizar
utilizar

04. ERROS
Âncora
erros
erros