Histórico da Página

...

02. ENDPOINT
Âncora
endpoint
endpoint

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

...

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

013.1 - Request - Retornar todos os status dos consumos:

Âncora

	todos_status
	todos_status

Ao fazer essa requisição, o sistema processa a solicitação para obter o status dos consumos indicados, retornando as informações de cada consumo solicitado.

Bloco de código

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

{
  "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
  "orderKeyType": "CARD",
  "orderKey": []
}

Bloco de códigonote

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

O seu pedido foi aceite, mas ainda não foi processado, aguarde alguns instantes e contacte a mesma morada para obter o consumo solicitado.

...

3.2- Request - Ao reenviar a solicitação, a resposta retornada será a seguinte:
Após reenviar a requisição para o mesmo endpoint, o sistema retornará uma resposta detalhando o status atualizado dos consumos solicitados.

Bloco de código

title	Resposta do JSON da requisição
linenumbers	true

{
	"success": true,
	"{
	"success": true,
	"error": null,
	"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
	"orderKeyType": "CARD",
	"orderKey": [],
	"consumption": [
		{
			"orderId": "ad976378-8823-48d3-9cd1-62d68cf3be77",
			"type": "CARD",
			"createdAt": "2024-09-09 12:33:52",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "181",
					"index": "181",
					"name": "A FRANCESA",
					"externalCode": "1",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "TESTE",
					"unitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "COZINHA"
						}
					]
				},
				{
					"id": "1",
					"index": "1",
					"name": "MARACUJA",
					"externalCode": "58",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "TESTE",
					"unitPrice": {
						"value": 61,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 61,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "NENHUM"
						}
					]
				}
			],
			"otherFees": [
				{
					"name": "Taxa de Serviço",
					"type": "SERVICE_FEE",
					"receivedBy": "MERCHANT",
					"receiverDocument": "",
					"price": {
						"value": 13.09,
						"currency": "R$"
					},
					"observation": ""
				}
			],
			"discounts": null,
			"total": {
				"items": 130.9,
				"otherFees": 13.09,
				"discount": 0,
				"orderAmount": 143.99
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": null,
			"card": {
				"waiterCode": 9999,
				"cardNumber": 1,
				"deliveryTableNumber": 326
			}
		},
		{
			"orderId": "2160c838-97d0-432f-a43a-dce087150d49",
			"type": "CARD",
			"createdAt": "2024-09-09 14:57:36",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "200",
					"index": "20",
					"name": "A FRANCESA",
					"externalCode": "1",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "TESTE",
					"unitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "COZINHA"
						}
					]
				}
			],
			"otherFees": [
				{
					"name": "Taxa de Serviço",
					"type": "SERVICE_FEE",
					"receivedBy": "MERCHANT",
					"receiverDocument": "",
					"price": {
						"value": 6.99,
						"currency": "R$"
					},
					"observation": ""
				}
			],
			"discounts": null,
			"total": {
				"items": 69.9,
				"otherFees": 6.99,
				"discount": 0,
				"orderAmount": 76.89
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": null,
			"card": {
				"waiterCode": 9999,
				"cardNumber": 340,
				"deliveryTableNumber": 340
			}
		},
		{
			"orderId": "5b8d7e5c-f87e-40ac-91b7-726da529fc88",
			"type": "CARD",
			"createdAt": "2024-09-09 14:39:39",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "1",
					"index": "332003",
					"name": "A FRANCESA",
					"externalCode": "1",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "",
					"unitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "COZINHA"
						}
					]
				}
			],
			"otherFees": [
				{
					"name": "Taxa de Serviço",
					"type": "SERVICE_FEE",
					"receivedBy": "MERCHANT",
					"receiverDocument": "",
					"price": {
						"value": 6.99,
						"currency": "R$"
					},
					"observation": ""
				}
			],
			"discounts": null,
			"total": {
				"items": 69.9,
				"otherFees": 6.99,
				"discount": 0,
				"orderAmount": 76.89
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": null,
			"card": {
				"waiterCode": 9999,
				"cardNumber": 4040,
				"deliveryTableNumber": 0
			}
		}
	]
}

Nota

title	Nota: HTTP Status Code = 226 IM Used

Sua solicitação foi retornada com sucesso.

...

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

Ao fazer essa requisição, o sistema processa a solicitação e retorna os detalhes completos 02. Obter detalhes de um consumo específico, incluindo todas as informações relevantes sobre o pedido consumido

:

Âncora

	detalhes_pedido_especifico
	detalhes_pedido_especifico

...

Nota

title	Nota: HTTP Status Code = 202 Accepted

A solicitação foi aceitaO seu pedido foi aceite, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço processado, aguarde alguns instantes e contacte a mesma morada para obter o status do consumo solicitado.

...

3.5 - Request - Reenviando a solicitação para obter os detalhes de um consumo:

Ao reenviar a requisição para o mesmo endpoint, o sistema retornará as informações atualizadas sobre o consumo solicitado, refletindo seu status mais recente.

Bloco de código

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

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

Nota

title	Nota: HTTP Status Code = 208 Already Reported

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

...

3.6 - Request - Solicitação de processamento para obter detalhes específicos do consumo:

Reenviando a requisição, o sistema processará o pedido de forma detalhada e retornará as informações completas sobre o consumo, conforme os dados disponíveis no momento.

Bloco de código

linenumbers
title	JSON de resposta do retorno de um consumo

Bloco de código

title	JSON de resposta do retorno de um consumo
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
	"orderKeyType": "CARD",
	"orderKey": [
		"340"
	],
	"consumption": [
		{
			"orderId": "2160c838-97d0-432f-a43a-dce087150d49",
			"type": "CARD",
			"createdAt": "2024-09-09 14:57:36",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "200",
					"index": "20",
					"name": "A FRANCESA",
					"externalCode": "1",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "TESTE",
					"unitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "COZINHA"
						}
					]
				}
			],
			"otherFees": [
				{
					"name": "Taxa de Serviço",
					"type": "SERVICE_FEE",
					"receivedBy": "MERCHANT",
					"receiverDocument": "",
					"price": {
						"value": 6.99,
						"currency": "R$"
					},
					"observation": ""
				}
			],
			"discounts": null,
			"total": {
				"items": 69.9,
				"otherFees": 6.99,
				"discount": 0,
				"orderAmount": 76.89
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": null,
			"card": {
				"waiterCode": 9999,
				"cardNumber": 340,
				"deliveryTableNumber": 340
			}
		}
	]
}

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

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

Âncora

	multiplos
	multiplos

Ao realizar essa requisição, o sistema processa a solicitação e fornece o status atualizado de vários pedidos ao mesmo tempo, incluindo informações detalhadas sobre cada um deles.

Bloco de código

title	JSON Para retornar múltiplos consumos
linenumbers	true

{
  "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
  "orderKeyType": "CARD",
  "orderKey": ["340", "350"]
}

Bloco de códigonote

title	Nota: HTTP Status Code = 202 Accepted

O seu pedido foi aceite, mas ainda não foi processado, aguarde alguns instantes e contacte a mesma morada para obter o consumo solicitado.

...

3.8 - Request - Reenviando a solicitação para obter o status de múltiplos pedidos:

Ao reenviar a requisição, o sistema retornará as informações atualizadas sobre o status dos pedidos solicitados, refletindo quaisquer alterações desde a última consulta.

Bloco de código

title	JSON de resposta do retorno de um consumo específico HTTP Status Code = 208JSON de retorno de múltiplos consumos
linenumbers	true

{
	"successerrors": true,[
	"error": null,
	"integrationHubServiceId		{
			"key": "66ca34be-a568-4444-a78d-098a68686e58orderKeyType_orderKey",
			"orderKeyTypemessage": "Order consumption request already exists: CARD_340, 350"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 208 Already Reported

Seu pedido já foi enviado, aguarde alguns instantes e entre em contato com o mesmo endereço para obter o consumo solicitado.

...

3.9 - Request - Solicitação de processamento para o status de múltiplos pedidos:

Reenviando a requisição, o sistema processará o pedido e fornecerá uma resposta que detalha o status atual de todos os pedidos incluídos na solicitação.

Bloco de código

title	JSON de retorno de múltiplos consumos
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
	"orderKeyType": "CARD",
	"orderKey": [
		"340",
		"350"
	],
	"consumption": [
		{
			"orderId": "2160c838-97d0-432f-a43a-dce087150d49",
			"type": "CARD",
			"createdAt": "2024-09-09 14:57:36",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "200",
					"index": "20",
					"name": "A FRANCESA"CARD",
	"orderKey": [
		"340",
		"350"
	],
	"consumption": [
		{
			"orderId": "2160c838-97d0-432f-a43a-dce087150d49",
			"type": "CARD",
			"createdAt": "2024-09-09 14:57:36",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "200",
					"index": "20",
					"name": "A FRANCESA",
					"externalCode": "1",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "TESTE",
					"unitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsPriceexternalCode": {"1",
						"valueunit": 0"UNIT",
						"currencyean": "R$""",
					"quantity": 1,
					}"specialInstructions": "TESTE",
					"totalPriceunitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsoptionsPrice": null,{
						"productionPointvalue": [
						{
	0,
						"namecurrency": "COZINHAR$"
						},
					]
		"totalPrice": {
		}
			],
			"otherFeesvalue": [69.9,
				{
					"namecurrency": "Taxa de ServiçoR$",
					"type": "SERVICE_FEE"},
					"receivedByoptions": "MERCHANT"null,
					"receiverDocumentproductionPoint": "",[
					"price": 	{
						"value": 6.99,
						"currencyname": "R$COZINHA"
						},
					"observation": ""]
				}
			],
			"discountsotherFees": null,[
			"total": 	{
					"itemsname": 69.9 "Taxa de Serviço",
					"otherFeestype": 6.99"SERVICE_FEE",
					"discountreceivedBy": 0"MERCHANT",
					"orderAmountreceiverDocument": 76.89
"",
				},
	"price": {
						"deliveryvalue": null6.99,
						"takeoutcurrency": null"R$"
					},
					"indoorobservation": null""
				}
			],
			"tablediscounts": null,
			"cardtotal": {
				"waiterCodeitems": 999969.9,
				"cardNumberotherFees": 3406.99,
				"deliveryTableNumberdiscount": 3400,
			}
	"orderAmount": 76.89
			},
		{
			"orderIddelivery": "1fbcd589-1bbd-472c-a28d-6b1164282964"null,
			"typetakeout": "CARD"null,
			"createdAtindoor": "2024-09-09 15:27:18"null,
			"customerNametable": "TOTVS"null,
			"itemscard": [
				{
					"idwaiterCode": "201"9999,
					"indexcardNumber": "201"340,
					"namedeliveryTableNumber": "A FRANCESA"340
			}
		},
		{
			"externalCodeorderId": "11fbcd589-1bbd-472c-a28d-6b1164282964",
					"unittype": "UNITCARD",
					"eancreatedAt": "2024-09-09 15:27:18",
					"quantitycustomerName": 1"TOTVS",
					"specialInstructionsitems": "TESTE",[
					"unitPrice": {
						"valueid": 69.9"201",
						"currencyindex": "R$201",
					}"name": "A FRANCESA",
					"optionsPriceexternalCode": {"1",
						"valueunit": 0"UNIT",
						"currencyean": "R$""",
					"quantity": 1,
					}"specialInstructions": "TESTE",
					"totalPriceunitPrice": {
						"value": 69.9,
						"currency": "R$"
					},
					"optionsoptionsPrice": null,{
						"productionPointvalue": [
						{
	0,
						"namecurrency": "COZINHAR$"
						},
					]
		"totalPrice": {
		}
			],
			"otherFeesvalue": [69.9,
				{
					"namecurrency": "Taxa de ServiçoR$",
					"type": "SERVICE_FEE"},
					"receivedByoptions": "MERCHANT"null,
					"receiverDocumentproductionPoint": "",[
					"price": 	{
						"value": 6.99,
						"currencyname": "R$COZINHA"
						},
					"observation": ""]
				}
			],
			"discountsotherFees": null,[
			"total": 	{
					"itemsname": 69.9 "Taxa de Serviço",
					"otherFeestype": 6.99"SERVICE_FEE",
					"discountreceivedBy": 0"MERCHANT",
					"orderAmountreceiverDocument": 76.89
"",
				},
	"price": {
						"deliveryvalue": null6.99,
						"takeoutcurrency": null"R$"
					},
					"indoorobservation": null""
				}
			],
			"tablediscounts": null,
			"cardtotal": {
				"waiterCodeitems": 999969.9,
				"cardNumber": 350,
				"deliveryTableNumber": 340
			}
		}
	]
}otherFees": 6.99,
				"discount": 0,
				"orderAmount": 76.89
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": null,
			"card": {
				"waiterCode": 9999,
				"cardNumber": 350,
				"deliveryTableNumber": 340
			}
		}
	]
}

Dicionário de Requisição

O endpoint Consumption permite consultar os dados de consumo de uma mesa ou várias mesas. Ele retorna informações detalhadas sobre os itens pedidos, preços e outros dados relevantes, facilitando o gerenciamento dos consumos em ambientes de atendimento.

Estrutura OrderConsumption:

Campo	Valor	Descrição
integrationHubServiceId	string	Identificador único da integração
orderKeyType	string	Tipo de chave do pedido
orderKey	string	Chave do pedido correspondente

Enumerações para orderKeyType:

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

...

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.

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": "66ca34be-a568-4444-a78d-098a68686e58",
	  "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]"
		}
	]
}

...

024. JSON enviando 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": "66ca34be-a568-4444-a78d-098a68686e58"
}

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": "66ca34be-a568-4444-a78d-098a68686eAA",
	  "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": "66ca34be-a568-4444-a78d-098a68686e58",
	  "orderKeyType": "CARD",
	  "orderKey": [""]
}

...

Páginas filhas

Versões comparadas

Versão antiga 10

Nova versão 11

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 10

Nova versão 11

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