Histórico da Página

...

3.1. Request - Corpo da requisição para retornar o consumo específico:

Essa requisição é enviada para obter detalhes sobre o consumo de um pedido específico, retornando as informações relevantes do consumo solicitado.

...

...

023.2. Request - Corpo da requisição para obter o status de múltiplos pedidos:

Essa requisição é utilizada para consultar o status atualizado de vários pedidos simultaneamente, retornando as informações detalhadas de cada pedido solicitado.

...

...

...

Informações sobre os retornos da API cancelledItems.

• orderKeyType: Deve respeita a tabela abaixo:

...

• orderKey: É o identificador do pedido:

...

Dicionário da Request

O endpoint Consumption retorna informações sobre o consumo, utilizando o como corpo da requisição a resposta do status code 226 do endpoint API Order Mesa - Get Consumption.

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:

• Estrutura Consumption (dentro de consumptions):

• Estrutura Consumption (dentro de items):

  Âncora
  table_items table_items

• Estrutura Consumption - items (dentro de options):

  Âncora
  table_options table_options

• Estrutura Consumption (dentro de otherFees):

  Âncora
  table_otherFees table_otherFees

• Estrutura Consumption (dentro de discounts):

  Âncora
  table_discounts table_discounts

• Estrutura Consumption (dentro de total):

  Âncora
  table_total table_total

• Estrutura Consumption (dentro de delevery):

  Âncora
  table_delivery table_delivery

...

Tabela de auxiliares e enumerações

• Estrutura Enumeração orderKeyType

  Âncora
  table_orderKeyType table_orderKeyType

• Estrutura Consumption (dentro de type):

  Âncora
  table_type table_type

• Estrutura Enumeração Consumption - items (dentro de unit):

  Âncora
  table_unit table_unit

• Estrutura Consumption - items (dentro de unitPrice):

  Âncora
  table_unitPrice table_unitPrice

• Estrutura Consumption - items (dentro de originalPrice):

  Âncora
  table_originalPrice table_originalPrice

• Estrutura Consumption - items (dentro de optionsPrice):

  Âncora
  table_optionsPrice table_optionsPrice

• Estrutura Consumption - items (dentro de totalPrice):

  Âncora
  table_totalPrice table_totalPrice

• Estrutura Enumeração Consumption - otherFees (dentro de type):

  Âncora
  table_OrderFeesType table_OrderFeesType

• Estrutura Enumeração Consumption - otherFees (dentro de receivedBy):

  Âncora
  table_receivedBy table_receivedBy

• Estrutura Enumeração Consumption - delivery (dentro de deliveredBy):

  Âncora
  table_deliveredBy table_deliveredBy

• Estrutura Consumption - otherFees (dentro de price):

  Âncora
  table_price table_price

• Estrutura Enumeração Consumption - discounts(dentro de sponsorshipValues):

  Âncora
  table_sponsorshipValues table_sponsorshipValues

• Estrutura Consumption - delivery (dentro de deliveryAddress):

  Âncora
  table_deliveryAddress table_deliveryAddress

• Estrutura Consumption - delivery - deliveryAddress (dentro de coordinates):

  Âncora
  table_coordinates table_coordinates

• Estrutura Consumption (dentro de takeout):

  Âncora
  table_takeout table_takeout

• Estrutura Enumeração Consumption - takeout (dentro de mode):

  Âncora
  table_takeout_mode table_takeout_mode

• Estrutura Consumption (dentro de table):

  Âncora
  table_table table_table

• Estrutura Consumption (dentro de card):

  Âncora
  table_card table_card

• Estrutura Error:

  Âncora
  table_error table_error

Código de erro

Mensagem de erro

...

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.

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

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "644a4d3c-6d2c-4154-a089-c1ab3fd89151",
	"orderKeyType": "String",
	"orderKey": [
		"06"
	],
	"consumption": [
		{
			"orderId": "542e6b3e-8e63-4498-bdc8-1e334a22012e",
			"type": "TABLE",
			"createdAt": "2024-02-08 10:12:05",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "251",
					"index": "331811",
					"name": "TESTE MYTAPP",
					"externalCode": "251",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "",
					"unitPrice": {
						"value": 99.9,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 99.9,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "NENHUM"
						}
					]
				}
			],
			"otherFees": [
				{
					"name": "Taxa de Serviço",
					"type": "SERVICE_FEE",
					"receivedBy": "MERCHANT",
					"receiverDocument": "",
					"price": {
						"value": 9.99,
						"currency": "R$"
					},
					"observation": ""
				}
			],
			"discounts": null,
			"total": {
				"items": 99.9,
				"otherFees": 9.99,
				"discount": 0,
				"orderAmount": 109.89
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": {
				"waiterCode": 9999,
				"tableNumber": 6,
				"chairNumber": 0
			},
			"card": null
		}
	]
}

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

...

024.2 - JSON enviando 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": "644a4d3c-6d2c-4154-a089-c1ab3fd89151",
	"orderKeyType": "String",
	"orderKey": [
		"06"
	],
	"consumption": [
		{
			"orderId": "542e6b3e-8e63-4498-bdc8-1e334a22012e",
			"type": "TABLE",
			"createdAt": "2024-02-08 10:12:05",
			"customerName": "TOTVS",
			"items": [
				{
					"id": "251",
					"index": "331811",
					"name": "TESTE MYTAPP",
					"externalCode": "251",
					"unit": "UNIT",
					"ean": "",
					"quantity": 1,
					"specialInstructions": "",
					"unitPrice": {
						"value": 99.9,
						"currency": "R$"
					},
					"optionsPrice": {
						"value": 0,
						"currency": "R$"
					},
					"totalPrice": {
						"value": 99.9,
						"currency": "R$"
					},
					"options": null,
					"productionPoint": [
						{
							"name": "NENHUM"
						}
					]
				}
			],
			"otherFees": [
				{
					"name": "Taxa de Serviço",
					"type": "SERVICE_FEE",
					"receivedBy": "MERCHANT",
					"receiverDocument": "",
					"price": {
						"value": 9.99,
						"currency": "R$"
					},
					"observation": ""
				}
			],
			"discounts": null,
			"total": {
				"items": 99.9,
				"otherFees": 9.99,
				"discount": 0,
				"orderAmount": 109.89
			},
			"delivery": null,
			"takeout": null,
			"indoor": null,
			"table": {
				"waiterCode": 9999,
				"tableNumber": 6,
				"chairNumber": 0
			},
			"card": null
		}
	]
}

...