CONTEÚDO
...
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....
Âncora | ||||
---|---|---|---|---|
|
Método | URL | Ambiente |
---|---|---|
POST | https://api-barramento.meuelevestage.com/order/getConsumption | Homologação |
POST | https://api-barramento.meueleve.com/order/getConsumption | Produção |
...
...
Âncora | ||||
---|---|---|---|---|
|
3.1 - Request - 01. Retornar todos os status dos consumos:
Âncora | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58", "orderKeyType": "CARD", "orderKey": [] } |
Bloco de códigonote | |||||
---|---|---|---|---|---|
| |||||
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 | ||||
---|---|---|---|---|
| ||||
{ "success"{ "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 | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58", "orderKeyType": "TABLECARD", "orderKey": ["40"] } |
Nota | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "orderKeyType_orderKey", "message": "Order consumption request already exists: TABLECARD_40" } ] } |
Nota | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
Bloco de código | ||||
| ||||
{ "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 | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58", "orderKeyType": "TABLECARD", "orderKey": ["340", "350"] } |
Bloco de códigonote | |||||
---|---|---|---|---|---|
| |||||
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 | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "success": true, "error": null, "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58", "orderKeyType": "CARD", "orderKey": [ "340", "350" ], "consumption": [ { "orderIdkey": "2160c838-97d0-432f-a43a-dce087150d49orderKeyType_orderKey", "typemessage": "Order consumption request already exists: CARD_340, 350" } ] } |
Nota | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
{ "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", "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": "1fbcd589-1bbd-472c-a28d-6b1164282964", "type": "CARD", "createdAt": "2024-09-09 15:27:18", "customerName": "TOTVS", "items": [ { "id": "201", "index": "201", "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": 350, "deliveryTableNumber": 340 } "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.
Campo | Valor | Descrição |
---|---|---|
integrationHubServiceId * | string | Identificador único da integração |
orderKeyType * | string | Tipo de chave do pedido |
orderKey | string | Chave do pedido correspondente |
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 |
Dica | ||
---|---|---|
| ||
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
...
Âncora | ||||
---|---|---|---|---|
|
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.Formando 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 incorretos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
"orderKeyType": "string",
"orderKey": ["string"]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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 camposcampos 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 | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58" } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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 | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686eAA", "orderKeyType": "TABLECARD", "orderKey": [] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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 | ||||||
---|---|---|---|---|---|---|
| {
"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
"orderKeyType": "TABLE",
"
| ": [""]
}|||||
Bloco de código | ||||||
| ||||||
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
Nota | ||
---|---|---|
| ||
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. |
...
{
"integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58",
"orderKeyType": "CARD",
"orderKey": [""]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
Nota | ||
---|---|---|
| ||
A solicitação é inválida e não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente. |
...
Âncora | ||
---|---|---|
|
|
|
O código de status HTTP 403401, conhecido como "ForbiddenUnauthorized" (ProibidoNã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 do cliente, mas está se recusando recusa a cumpriautorizá-la. Isso geralmente ocorre quando o cliente enviou a URL incorreta para a requisição.
Bloco de código | ||
---|---|---|
| ||
https://api-barramento.meuelevestage.com/order/getConsumptionS |
...
title | JSON Response para URL incorreta |
---|---|
linenumbers | true |
...
, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.
Nota | ||
---|---|---|
| ||
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 novamenteO cliente enviou a URL incorreta para solicitação da requisição. |
...
Âncora | ||||
---|---|---|---|---|
|
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álidoentendeu a requisição do cliente, mas está se recusando a cumpri-la. Isso geralmente ocorre quando o cliente enviou a URL incorreta para a requisição.
Bloco de código | |||||
---|---|---|---|---|---|
| |||||
https://api-barramento.meuelevestage.com/order/getConsumptionS{ "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc", "orderKeyType": "TABLE", "orderKey": ["350"] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "integrationHubServiceId", "message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled" } ]Missing Authentication Token" } |
Nota | ||
---|---|---|
| ||
O cliente enviou a URL incorreta para solicitação da requisiçãoUma ou mais informações enviadas não puderam ser encontradas. |
...
Âncora | ||
---|---|---|
|
|
|
O código de status HTTP 412404, conhecido como "Precondition FailedNot Found" (Pré-condição FalhouNão Encontrado), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição. encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId
está incorreto ou inválido.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "8f7949c3f1b874af-cdd696ab-4db04535-8746aac3-369e651026b425118fe586cc", "orderKeyType": "TABLECARD", "orderKey": ["350"] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "message"errors": [ { "key": "NOT_FOUNDintegrationHubServiceId", "codemessage": 412 } | ||||
Nota | ||||
| ||||
"Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
Nota | ||
---|---|---|
| ||
Uma ou mais informações enviadas não puderam ser encontradas. |
...
Âncora | ||||
---|---|---|---|---|
|
Alguma regra para atendimento de sua solicitação não foi atendida, analise o corpo da declaração para saber os motivos.
...
Âncora | ||||
---|---|---|---|---|
|
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "66ca34be-a568-4444-a78d-098a68686e58", "orderKeyType": "TABLECARD", "orderKey": ["340", "350"] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success": true, "error": null, "integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e", "orderKeyType": "TABLECARD", "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 } ] } |
Nota | ||
---|---|---|
| ||
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
Âncora | ||||
---|---|---|---|---|
|
API Order |
---|
Cartão - New |
---|
Order |
---|
API Order Cartão - |
---|
Consumption |
---|
API Order |
Cartão - |
---|
Payment |
---|
API Order |
Cartão - |
---|
Get Cancelled Items |
---|
API Order |
Cartão - |
---|
Cancelled Items |
---|
API Order |
Cartão - Get |
---|
Status |
---|
API Order |
Cartão - |
---|
Status |
---|
Templatedocumentos |
---|