...
...
Esta documentação tem como finalidade demonstrar o formato JSON para envio de requisições de pedidos com vários itens, sendo um item com valor integral e outro fracionando, como valor fracionado, adicionais e desconto na API Order Mesa, utilizando o endpoint newOrder.
...
Âncora | ||||
---|---|---|---|---|
|
Método | URL |
---|---|
POST | https://api-barramento.meuelevestage.com/order/newOrder |
...
Âncora | ||||
---|---|---|---|---|
|
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812", "data": { "id": "29261444-5ff8-40b2-bce1-42848247d4a2", "type": "TABLE", "displayId": "8", "createdAt": "2024-06-24T17:35:00", "orderTiming": "2024-06-24T17:40:24", "preparationStartDateTime": "2024-06-24T18:00:00", "merchant": { "id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e", "name": "BOTECO DO ALBINO" }, "items": [ { "id": "2", "index": "2", "name": "A FRANCESA", "externalCode": "1", "unit": "UN", "quantity": 0.5, "specialInstructions": "Teste", "unitPrice": { "value": 69.90, "currency": "R$" }, "optionsPrice": { "value": 1.00, "currency": "R$" }, "totalPrice": { "value": 34.95, "currency": "R$" }, "options": [ { "index": "3", "id": "3", "name": "COMPOSICAO A", "externalCode": "201", "unit": "UN", "quantity": 1, "unitPrice": { "value": 1.00, "currency": "R$" }, "originalPrice": { "value": 1.00, "currency": "RS" }, "totalPrice": { "value": 1.0, "currency": "R$" }, "productionPoint": "Adicional Composicao A" } ] }, { "id": "4", "index": "4", "name": "AERADO", "externalCode": "2", "unit": "UN", "quantity": 1, "specialInstructions": "Teste", "unitPrice": { "value": 32.99, "currency": "R$" }, "optionsPrice": { "value": 37.99, "currency": "R$" }, "totalPrice": { "value": 32.99, "currency": "R$" }, "options": [ { "index": "5", "id": "5", "name": "AVELA", "externalCode": "4", "unit": "UN", "quantity": 1, "unitPrice": { "value": 37.99, "currency": "R$" }, "originalPrice": { "value": 37.99, "currency": "RS" }, "totalPrice": { "value": 37.99, "currency": "R$" }, "productionPoint": "Adicional Avela" } ] } ], "otherFees": [], "discounts": [ { "value": 1, "target": "ITEM", "targetId": "02", "sponsorshipValues": [ { "name": "MARKETPLACE", "value": 10.00 } ] } ], "total": { "items": 67.94, "otherFees": 38.99, "discount": 10.00, "orderAmount": 96.93, "additionalFees": 0, "deliveryFee": 0 }, "payments": {null "prepaiddelivery": 0.0null, "pendingextraInfo": 0.0"Teste", "methodsschedule": [null, {"indoor": null, "valuetakeout": 96null,93, "currencytable": "BRL",{ "typewaiterCode": "PREPAID96.93", "methodtableNumber": "credit8", "methodInfochairNumber": "Visa1", }, "changeForcard": 0.0null } ] }, "delivery": null, "extraInfo": "Teste", "schedule": null, "indoor": null, "takeout": null, "table": { "waiterCode": "96.93", "tableNumber": "8", "chairNumber": "1" }, "card": null } } |
Nota | ||
---|---|---|
| ||
Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status. |
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
...
} |
Nota | ||
---|---|---|
| ||
Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status. |
...
Âncora | ||||
---|---|---|---|---|
|
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
Âncora | ||||
---|---|---|---|---|
|
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.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
"type": "TABLE",
"displayId": 8,
"createdAt": "2024-06-24T17:35:00",
"orderTiming": "2024-06-24T17:40:24",
"preparationStartDateTime": "2024-06-24T18:00:00",
"merchant": {
|
...
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.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812", "data": { "id": "29261444c312d2ff-5ff81a8f-40b240ad-bce18eed-42848247d4a29ae9a908df6e", "typename": "TABLE"BOTECO DO ALBINO" }, "displayIditems": 8,[ { "createdAtid": "2024-06-24T17:35:002", "orderTimingindex": "2024-06-24T17:40:242", "preparationStartDateTimename": "2024-06-24T18:00:00A FRANCESA", "merchantexternalCode": {"1", "idunit": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6eUN", "namequantity": "BOTECO DO ALBINO"0.5, }, "itemsspecialInstructions": ["Teste", "unitPrice": { "idvalue": "2"69.90, "indexcurrency": "2"R$" }, "nameoptionsPrice": "A FRANCESA", { "externalCodevalue": "1".00, "unitcurrency": "UNR$", "quantity": 0.5}, "specialInstructionstotalPrice": "Teste", "unitPrice": { "value": 6934.9095, "currency": "R$" }, "optionsPriceoptions": [ { "valueindex": 1.00"3", "currencyid": "R$3", }, "totalPricename": { "COMPOSICAO A", "valueexternalCode": 34.95"201", "currencyunit": "R$UN", }, "optionsquantity": [ {1, "indexunitPrice": "3",{ "id": "3", "namevalue": "COMPOSICAO A"1.00, "externalCode": "201", "unitcurrency": "UNR$", "quantity": 1}, "unitPriceoriginalPrice": { "value": 1.00, "currency": "R$RS" }, "originalPricetotalPrice": { "value": 1.000, "currency": "RSR$" }, "totalPriceproductionPoint": { "value": 1.0, "currency": "R$" }, "productionPoint": "Adicional "Adicional Composicao A" } ] }, { "id": "4", "index": "4", "name": "AERADO", "externalCode": "2", "unit": "UN", "quantity": 1, "specialInstructions": "Teste", "unitPrice": { "value": 32.99, "currency": "R$" }, "optionsPrice": { "value": 37.99, "currency": "R$" }, "totalPrice": { "value": 32.99, "currency": "R$" }, "options": [ { "index": "5", "id": "5", "name": "AVELA", "externalCode": "4", "unit": "UN", "quantity": 1, "unitPrice": { "value": 37.99, "currency": "R$" }, "originalPrice": { "value": 37.99, "currency": "RS" }, "totalPrice": { "value": 37.99, "currency": "R$" }, "productionPoint": "Adicional Avela" } ] } ], "otherFees": [], "discounts": [ { "value": 1, "target": "ITEM", "targetId": "02", "sponsorshipValues": [ { "name": "MARKETPLACE", "value": 10.00 } ] } ], "total": { "items": 67.94, "otherFees": 38.99, "discount": 10.00, "orderAmount": 96.93, "additionalFees": 0, "deliveryFee": 0 }, "payments": {null, "prepaiddelivery": 0.0null, "pendingextraInfo": 0.0"Teste", "methodsschedule": [null, "indoor": null, {"takeout": null, "table": { "valuewaiterCode": "96,.93", "currencytableNumber": "BRL8", "typechairNumber": "PREPAID1", }, "methodcard": "credit",null } } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "methodInfokey": "VisadisplayId", "changeFormessage": 0.0 }"body.data.displayId must be a string" } ] } |
...
02. JSON enviando faltando um ou mais campos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812", "data": { "id": "29261444-5ff8-40b2-bce1-42848247d4a2" }, "delivery": null, "extraInfo": "Teste", "schedule": null, "indoortype": null"TABLE", "takeoutdisplayId": null"8", "tablecreatedAt": { "waiterCode": "96.93""2024-06-24T17:35:00", "tableNumberorderTiming": "82024-06-24T17:40:24", "chairNumberpreparationStartDateTime": "1" }2024-06-24T18:00:00",, "carditems": null } } | ||||
Bloco de código | ||||
| ||||
{ "errors": [ [ { "keyid": "displayId2", "messageindex": "body.data.displayId must be a string"2", } ] } |
02. JSON enviando faltando um ou mais campos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceIdname": "3fea8768-bbd9-454b-9e7b-40841e9a6812A FRANCESA", "data": { "idexternalCode": "29261444-5ff8-40b2-bce1-42848247d4a21", "typeunit": "TABLEUN", "displayIdquantity": "8"0.5, "createdAtspecialInstructions": "2024-06-24T17:35:00Teste", "orderTimingunitPrice": "2024-06-24T17:40:24", { "preparationStartDateTimevalue": "2024-06-24T18:00:00",, 69.90, "itemscurrency": ["R$" { }, "idoptionsPrice": "2",{ "indexvalue": "2"1.00, "namecurrency": "A FRANCESAR$", "externalCode": "1"}, "unittotalPrice": "UN",{ "quantityvalue": 034.595, "specialInstructionscurrency": "Teste"R$" }, "unitPriceoptions": {[ "value": 69.90,{ "currencyindex": "R$3", }, "optionsPriceid": {"3", "valuename": 1.00"COMPOSICAO A", "currencyexternalCode": "R$201", } "unit": "UN", "totalPrice "quantity": 1, "unitPrice": { "value": 341.9500, "currency": "R$" }, "optionsoriginalPrice": [{ { "value": 1.00, "indexcurrency": "3RS", "id": "3"}, "nametotalPrice": "COMPOSICAO A",{ "externalCodevalue": "201"1.0, "unitcurrency": "UNR$", "quantity": 1}, "unitPriceproductionPoint": { "Adicional Composicao A" } ] "value": 1.00}, { "currencyid": "R$4", }"index": "4", "originalPricename": { "AERADO", "valueexternalCode": 1.00"2", "currencyunit": "RSUN", }"quantity": 1, "specialInstructions": "Teste", "totalPriceunitPrice": { "value": 132.099, "currency": "R$" }, "productionPointoptionsPrice": "Adicional Composicao A"{ }"value": 37.99, ] "currency": "R$" }, "totalPrice": { "idvalue": "4"32.99, "indexcurrency": "4"R$" }, "nameoptions": "AERADO",[ "externalCode": "2", { "unitindex": "UN5", "quantityid": 1"5", "specialInstructionsname": "TesteAVELA", "unitPriceexternalCode": {"4", "valueunit": 32.99"UN", "currencyquantity": "R$"1, }, "optionsPriceunitPrice": { "value": 37.99, "currency": "R$" }, "totalPriceoriginalPrice": { "value": 3237.99, "currency": "R$RS" }, "optionstotalPrice": [{ { "indexvalue": "5"37.99, "idcurrency": "5R$", "name": "AVELA"}, "externalCodeproductionPoint": "4Adicional Avela", "unit": "UN",} ] } ], "quantityotherFees": 1[], "unitPricediscounts": {[ { "value": 37.991, "currencytarget": "R$ITEM", }"targetId": "02", "originalPricesponsorshipValues": [ { "valuename": 37.99"MARKETPLACE", "currencyvalue": "RS"10.00 },} ] } ], "totalPricetotal": { "items": 67.94, "valueotherFees": 3738.99, "currencydiscount": "R$"10.00, }"orderAmount": 96.93, "productionPointadditionalFees": "Adicional Avela"0, } ] "deliveryFee": 0 } ], "otherFeespayments": []null, "discountsdelivery": [ { null, "valueextraInfo": 1"Teste", "targetschedule": "ITEM"null, "targetIdindoor": "02"null, "sponsorshipValuestakeout": [null, "table": { "waiterCode": "96.93", "nametableNumber": "MARKETPLACE8", "valuechairNumber": 10.00 "1" }, ] } ], "total": "card": null } } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "itemskey": 67.94"merchant", "otherFeesmessage": 38.99, "discount": 10.00, "orderAmount": 96.93, "additionalFees": 0, "deliveryFee": 0 }, "payments": { "prepaid": 0.0, "pending": 0.0, "methods": [ { "value": 96,93, "currency": "BRL", "type": "PREPAID", "method": "credit", "methodInfo": "Visa", "changeFor": 0.0 } ] }, "delivery": null, "extraInfo": "Teste", "schedule": null, "indoor": null, "takeout": null, "table": { "waiterCode": "96.93", "tableNumber": "8", "chairNumber": "1" }, "card": null } } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "merchant",
"message": "body.data.merchant is required"
}
]
} |
...
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.
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 novamente. |
...
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL
incorreta
Bloco de código | ||
---|---|---|
| ||
https://api-barramento.meuelevestage.com/order/newOrderS |
...
title | JSON Response para URL incorreta |
---|---|
linenumbers | true |
...
"body.data.merchant is required"
}
]
} |
...
Âncora | ||||
---|---|---|---|---|
|
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.
Nota | ||
---|---|---|
| ||
O cliente não enviou uma requisição para a |
...
| |
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. |
...
Âncora | ||||
---|---|---|---|---|
|
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL
incorreta
Bloco de código | ||
---|---|---|
| ||
https://api-barramento.meuelevestage.com/order/newOrderS |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"message": "Missing Authentication Token"
} |
Nota | ||
---|---|---|
| ||
O cliente não enviou uma requisição para a |
...
Âncora | ||||
---|---|---|---|---|
|
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 integrationHubId
está incorreto ou inválido.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"data": {
"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
"type": "TABLE",
"displayId": "8",
"createdAt": "2024-06-24T17:35:00",
"orderTiming": "2024-06-24T17:40:24",
"preparationStartDateTime": "2024-06-24T18:00:00",
"merchant": {
"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
"name": "BOTECO DO ALBINO"
},
"items": [
{
"id": "2",
"index": "2",
"name": "A FRANCESA",
"externalCode": "1",
"unit": "UN",
"quantity": 0.5,
"specialInstructions": "Teste",
"unitPrice": {
"value": 69.90,
"currency": "R$"
},
"optionsPrice |
...
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 integrationHubId
está incorreto ou inválido.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc", "data": { "id": "29261444-5ff8-40b2-bce1-42848247d4a2", "type": "TABLE", "displayId": "8", "createdAt": "2024-06-24T17:35:00", "orderTiming": "2024-06-24T17:40:24", "preparationStartDateTime": "2024-06-24T18:00:00", "merchant": { "id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e", "name": "BOTECO DO ALBINO" }, "items": [ { "id": "2", "index": "2", "name": "A FRANCESA", "externalCode": "1", "unit": "UN", "quantity": 0.5, "specialInstructions": "Teste", "unitPrice": { "value": 69.90, "currency": "R$" }, "optionsPrice": { "value": 1.00, "currency": "R$" }, "totalPrice": { "value": 34.95, "currency": "R$" }, "options": [ { "index": "3", "id": "3", "name": "COMPOSICAO A", "externalCode": "201", "unit": "UN", "quantity": 1, "unitPrice": { "value": 1.00, "currency": "R$" }, "originalPricetotalPrice": { "value": 134.0095, "currency": "RSR$" }, "totalPriceoptions": [ { "valueindex": 1.0"3", "currencyid": "R$" }3", "productionPointname": "AdicionalCOMPOSICAO Composicao A", }"externalCode": "201", ] }"unit": "UN", { "idquantity": "4"1, "indexunitPrice": "4",{ "namevalue": "AERADO"1.00, "externalCodecurrency": "2"R$" }, "unitoriginalPrice": "UN", { "quantityvalue": 1.00, "specialInstructionscurrency": "Teste"RS" }, "unitPricetotalPrice": { "value": 321.990, "currency": "R$" }, "optionsPriceproductionPoint": {"Adicional Composicao A" } ] "value": 37.99}, { "currencyid": "R$4", }"index": "4", "totalPricename": {"AERADO", "valueexternalCode": 32.99"2", "currencyunit": "R$UN", }"quantity": 1, "optionsspecialInstructions": ["Teste", "unitPrice": { "indexvalue": "5"32.99, "idcurrency": "5R$", }, "nameoptionsPrice": "AVELA",{ "externalCodevalue": "4"37.99, "unitcurrency": "UNR$", "quantity": 1}, "unitPricetotalPrice": { "value": 3732.99, "currency": "R$" }, "originalPriceoptions": [ { "valueindex": 37.99"5", "currencyid": "RS" }5", "totalPricename": {"AVELA", "valueexternalCode": 37.99"4", "currencyunit": "R$UN", }"quantity": 1, "productionPointunitPrice": "Adicional Avela"{ } ]"value": 37.99, } ], "otherFeescurrency": []"R$" }, "discountsoriginalPrice": [{ { "value": 137.99, "targetcurrency": "ITEMRS", "targetId": "02" }, "sponsorshipValuestotalPrice": [{ { "value": 37.99, "namecurrency": "MARKETPLACE"R$" }, "valueproductionPoint": 10.00"Adicional Avela" } ] } ], "otherFees": [], "totaldiscounts": [ { "itemsvalue": 67.941, "otherFeestarget": 38.99"ITEM", "discounttargetId": 10.00"02", "orderAmountsponsorshipValues": 96.93,[ { "additionalFeesname": 0"MARKETPLACE", "deliveryFeevalue": 0 10.00 }, "payments": { ] "prepaid": 0.0,} "pending": 0.0], "methodstotal": [ { "valueitems": 9667.94,93, "currencyotherFees": "BRL"38.99, "typediscount": "PREPAID"10.00, "methodorderAmount": "credit"96.93, "methodInfoadditionalFees": "Visa"0, "changeFordeliveryFee": 0.0 }, ] }"payments": null, "delivery": null, "extraInfo": "Teste", "schedule": null, "indoor": null, "takeout": null, "table": { "waiterCode": "96.93", "tableNumber": "8", "chairNumber": "1" }, "card": null } } |
...
Dica | ||
---|---|---|
| ||
Para obter detalhes técnicos sobre o envio de requisições ao endpoint |
...
Âncora | ||||
---|---|---|---|---|
|
Templatedocumentos |
---|