CONTEÚDO
Este endpoint é utilizado para obter informações detalhadas sobre consumo, fornecendo um retorno em formato JSON com diversos atributos relevantes. Ao enviar uma solicitação conforme especificado nos exemplos abaixo, o endpoint processa a requisição e retorna um conjunto de dados que inclui o status mais recente do consumo.
Obtenha o consumo atribuído a um ou mais pedidos utilizando o parâmetro orderKeyType, que pode ser ORDER_ID, TABLE ou CARD.
orderKeyType = ORDER_ID, é obrigatório informar pelo menos um pedido.orderKeyType = TABLE ou CARD, quando o parâmetro orderKey não for informado, serão retornados todos os status de tabelas ou cartões abertos.| Método | URL |
|---|---|
| POST | https://api-barramento.meuelevestage.com/order/getConsumption |
01. Retornar todos os status dos consumos:
{
"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
"orderKeyType": "TABLE",
"orderKey": []
} |
{
"success":true,
"error":null,
"integrationHubServiceId":"ea2aecdb-7a37-449f-99e1-aa1346b09524",
"orderKeyType":"TABLE",
"orderKey":[
"06",
"10",
"19"
],
"consumption":[
{
"orderId":"7cf20761-adc7-4a79-98c3-2259dd2b2856",
"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
},
{
"orderId":"244e2bc1-b7ef-4260-bbf5-49251bdc5f0f",
"type":"TABLE",
"createdAt":"2024-02-08 10:45:02",
"customerName":"TOTVS",
"items":[
{
"id":"1",
"index":"331820",
"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"
}
]
},
{
"id":"4",
"index":"331821",
"name":"AVELA",
"externalCode":"4",
"unit":"UNIT",
"ean":"",
"quantity":1,
"specialInstructions":"",
"unitPrice":{
"value":37.99,
"currency":"R$"
},
"optionsPrice":{
"value":0,
"currency":"R$"
},
"totalPrice":{
"value":37.99,
"currency":"R$"
},
"options":null,
"productionPoint":[
{
"name":"COZINHA"
}
]
}
],
"otherFees":[
{
"name":"Taxa de Serviço",
"type":"SERVICE_FEE",
"receivedBy":"MERCHANT",
"receiverDocument":"",
"price":{
"value":10.78,
"currency":"R$"
},
"observation":""
}
],
"discounts":null,
"total":{
"items":107.89,
"otherFees":10.78,
"discount":0,
"orderAmount":118.67
},
"delivery":null,
"takeout":null,
"indoor":null,
"table":{
"waiterCode":1,
"tableNumber":10,
"chairNumber":0
},
"card":null
},
{
"orderId":"b6017f3d-e680-4840-b69f-d2b573d4f8c0",
"type":"TABLE",
"createdAt":"2024-02-25 14:01:50",
"customerName":"TOTVS",
"items":[
{
"id":"5",
"index":"331838",
"name":"BRIGADEIRO COM BABA DE MOCA",
"externalCode":"5",
"unit":"UNIT",
"ean":"",
"quantity":2,
"specialInstructions":"",
"unitPrice":{
"value":29.99,
"currency":"R$"
},
"optionsPrice":{
"value":0,
"currency":"R$"
},
"totalPrice":{
"value":30.2,
"currency":"R$"
},
"options":null,
"productionPoint":[
{
"name":"COZINHA"
}
]
},
{
"id":"6",
"index":"331839",
"name":"BRIGADEIRO 2",
"externalCode":"6",
"unit":"UNIT",
"ean":"",
"quantity":2,
"specialInstructions":"",
"unitPrice":{
"value":63,
"currency":"R$"
},
"optionsPrice":{
"value":0,
"currency":"R$"
},
"totalPrice":{
"value":63.42,
"currency":"R$"
},
"options":null,
"productionPoint":[
{
"name":"COZINHA"
}
]
},
{
"id":"5",
"index":"331841",
"name":"BRIGADEIRO COM BABA DE MOCA",
"externalCode":"5",
"unit":"UNIT",
"ean":"",
"quantity":1,
"specialInstructions":"",
"unitPrice":{
"value":29.99,
"currency":"R$"
},
"optionsPrice":{
"value":0,
"currency":"R$"
},
"totalPrice":{
"value":15.11,
"currency":"R$"
},
"options":null,
"productionPoint":[
{
"name":"COZINHA"
}
]
},
{
"id":"6",
"index":"331842",
"name":"BRIGADEIRO 2",
"externalCode":"6",
"unit":"UNIT",
"ean":"",
"quantity":1,
"specialInstructions":"",
"unitPrice":{
"value":63,
"currency":"R$"
},
"optionsPrice":{
"value":0,
"currency":"R$"
},
"totalPrice":{
"value":31.7,
"currency":"R$"
},
"options":null,
"productionPoint":[
{
"name":"COZINHA"
}
]
}
],
"otherFees":[
{
"name":"Taxa de Serviço",
"type":"SERVICE_FEE",
"receivedBy":"MERCHANT",
"receiverDocument":"",
"price":{
"value":14.04,
"currency":"R$"
},
"observation":""
}
],
"discounts":null,
"total":{
"items":140.43,
"otherFees":14.04,
"discount":0,
"orderAmount":154.47
},
"delivery":null,
"takeout":null,
"indoor":null,
"table":{
"waiterCode":9999,
"tableNumber":19,
"chairNumber":0
},
"card":null
}
]
} |
02. Obter detalhes de um consumo específico:
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40"]
} |
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 consumo solicitado. |
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order consumption request already exists: TABLE_40"
}
]
}
|
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 consumo solicitado. |
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40"],
"consumption": [
{
"orderId": "d8ef12c3-ce5f-4bfa-b1d2-ebde107a2f02",
"type": "TABLE",
"createdAt": "2024-06-28 17:27:20",
"customerName": "TOTVS",
"items": [
{
"id": "39735945",
"index": "4",
"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": 6.1,
"currency": "R$"
},
"observation": ""
}
],
"discounts": [],
"total": {
"items": 61,
"otherFees": 6.1,
"discount": 0,
"orderAmount": 67.1
},
"delivery": null,
"takeout": null,
"indoor": null,
"table": {
"waiterCode": 9999,
"tableNumber": 40,
"chairNumber": 0
},
"card": null
}
]
} |
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
04. Retornar o status de múltiplos pedidos:
{
"integrationHubServiceId": "ab70a3ce-915b-42ee-9d7f-049d36e26eca",
"orderKeyType": "TABLE",
"orderKey": ["20", "40"]
} |
{
"success": true,
"error": null,
"integrationHubServiceId": "ab70a3ce-915b-42ee-9d7f-049d36e26eca",
"orderKeyType": "TABLE",
"orderKey": [
"20",
"40"
],
"consumption": [
{
"orderId": "2299a4af-2363-4aa8-803b-b95f7d8e8a7b",
"type": "TABLE",
"createdAt": "2024-06-28 17:27:20",
"customerName": "TOTVS",
"items": [
{
"id": "39735945",
"index": "4",
"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": 6.1,
"currency": "R$"
},
"observation": ""
}
],
"discounts": [],
"total": {
"items": 61,
"otherFees": 6.1,
"discount": 0,
"orderAmount": 67.1
},
"delivery": null,
"takeout": null,
"indoor": null,
"table": {
"waiterCode": 9999,
"tableNumber": 20,
"chairNumber": 0
},
"card": null
}
]
} |
Neste exemplo, os dados retornados incluem:
|
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.
{
"integrationHubServiceId": "a9cad639-5775-4f8a-917b-2ae0f2d284d8",
"orderKeyType": "string",
"orderKey": ["string"]
} |
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
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"
}
]
} |
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 sem informar o código da orderKey corretamente
{
"integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
"orderKeyType": "TABLE",
"orderKey": [""]
} |
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente. |
O código de status HTTP 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.
A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente. |
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor entendeu a requisição do cliente, mas está se recusando a cumpri-la. Isso geralmente ocorre quando o cliente não possui permissões adequadas para acessar o recurso solicitado, mesmo que as credenciais de autenticação tenham sido fornecidas corretamente.
https://api-barramento.meuelevestage.com/order/getConsumptions |
{
"message": "Missing Authentication Token"
} |
O cliente enviou a URL incorreta para solicitação da requisição. |
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 URL fornecido está incorreto, o recurso foi removido permanentemente ou não está disponível no momento da requisição.
{
"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"
}
]
} |
Uma ou mais informações enviadas não puderam ser encontradas. |
O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição.
{
"integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
"orderKeyType": "TABLE",
"orderKey": []
} |
{
"message": "NOT_FOUND",
"code": 412
} |
Alguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos. |
O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.
{
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": ["20", "40"]
} |
{
"success": true,
"error": null,
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": [
"20",
"40"
],
"consumption": [
{
"orderId": "f5fee4b4-c13f-482d-8e98-0dd840629e02",
"type": "TABLE",
"createdAt": "2024-06-28 17:27:20",
"customerName": "TOTVS",
"items": [
{
"id": "39735945",
"index": "4",
"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": 6.1,
"currency": "R$"
},
"observation": ""
}
],
"discounts": [],
"total": {
"items": 61,
"otherFees": 6.1,
"discount": 0,
"orderAmount": 67.1
},
"delivery": null,
"takeout": null,
"indoor": null,
"table": {
"waiterCode": 9999,
"tableNumber": 20,
"chairNumber": 0
},
"card": null
}
]
} |
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
| API Order Mesa - New Order |
|---|
| API Order Mesa - Get Status |
| API Order Mesa - Status |
| API Order Mesa - Consumption |
| API Order Mesa - Payment |
| API Order Mesa - Get Cancelled Items |
| API Order Mesa - Cancelled Items |