CONTEÚDO
01. VISÃO GERAL
Esta documentação tem como finalidade demonstrar o formato do JSON para envio de requisição de pedidos com valor integração na API Order Mesa, no endpoint newOrder para itens com valor integral, adicionais e desconto.
...
02.
...
EXEMPLO DE UTILIZAÇÃO
01. Corpo da requisição de envio de novo pedidos inteiro:
2.1 - Request Itens com Valor Integral Adicionais e Descontos:
Ao enviar a requisição para este endpoint, o sistema processa a criação de um novo pedido, incluindo itens de valor integral
| Bloco de código |
|---|
| title | JSON para pedido com |
|---|
|
| Bloco de código |
|---|
| title | JSON para pedido com inteiro |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "de703e24-3c8f-441a-aacd-17ac766206a9",
"type": "TABLE",
"displayId": "2",
"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": "4",
"index": "4",
"name": "A FRANCESA",
"externalCode": "1",
"unit": "UN",
"quantity": 1,
"specialInstructions": "Teste",
"unitPrice": {
"value": 69.90,
"currency": "R$"
},
"optionsPrice": {
"value": 1.00,
"currency": "R$"
},
"totalPrice": {
"value": 69.90,
"currency": "R$"
},
"options": [
{
"index": "5",
"id": "5",
"name": "COMPOSICAO A",
"externalCode": "201",
"unit": "UN",
"quantity": 1,
"unitPrice": {
"value": 1.00,
"currency": "R$"
},
"originalPrice": {
"value": 1.00,
"currency": "R$"
},
"totalPrice": {
"value": 1.00,
"currency": "R$"
},
"productionPoint": "Teste"
}
]
}
],
"otherFees": [],
"discounts": [
{
"value": 10.00,
"target": "ITEM",
"targetId": "4",
"sponsorshipValues": [
{
"name": "MARKETPLACE",
"value": 0
}
]
}
],
"total": {
"items": 60.90,
"otherFees": 0.00,
"discount": 10.00,
"orderAmount": 60.90,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": {null,
"prepaiddelivery": 0.0null,
"pendingextraInfo": 0.0"Teste",
"methodsschedule": [
{null,
"valueindoor": 60.90null,
"currencytakeout": "BRL"null,
"typetable": "PREPAID",{
"methodwaiterCode": "credit9999",
"methodInfotableNumber": "Visa2",
"changeForchairNumber": 0.0"1"
}
]
},
"deliverycard": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": {
"waiterCode": "9999",
"tableNumber": "2",
"chairNumber": "1"
},
"card": null
}
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 200 OK |
|---|
|
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 |
|---|
| title | Nota: HTTP Status Code = 200 OK |
|---|
|
Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status. |
...
03. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
- HTTP Status Code - 400 - Bad Request
| Âncora |
|---|
| status_code_400 |
|---|
| status_code_400 |
|---|
|
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.
3.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 |
|---|
| title | JSON Inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "b1e26dd8-0a1b-486e-bf62-65e80ddce2f4",
"type": "TABLE",
"displayId": 55,
"createdAt": "2024-06-24T17: |
...
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 |
|---|
| title | JSON Inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "b1e26dd8-0a1b-486e-bf62-65e80ddce2f4",
"type": "TABLE",
"displayId": 55,
"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": "54",
"index": "54",
"name": "MARACUJA",
"externalCode": "58",
"unit": "UN",
"quantity": 1.0,
"specialInstructions": "Teste",
"unitPrice": {
"value": 61.00,
"currency": "R$"
},
"optionsPrice": {
"value": 0.0,
"currency": "R$"
},
"totalPrice": {
"value": 61.00,
"currency": "R$"
}
}
],
"otherFees": [],
"total": {
"items": 61.0,
"otherFees": 0,
"discount": 0.0,
"orderAmount": 61.0,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": {null,
"prepaiddelivery": 0.0null,
"pendingextraInfo": 0.0"Teste",
"methodsschedule": [null,
{
"indoor": null,
"valuetakeout": 61.0null,
"currencytable": "BRL",
{
"typewaiterCode": "PREPAID9999",
"methodtableNumber": "credit54",
"methodInfochairNumber": "Visa1",
},
"changeForcard": 0.0null
}
]
},
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": {
"waiterCode": "9999",
"tableNumber": "54",
"chairNumber": "1"
},
"card": null
}
} |
| Bloco de código |
|---|
| title | JSON Resposta |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": "displayId",
"message": "body.data.displayId must be a string"
}
]
} |
| Bloco de código |
|---|
| title | JSON Resposta |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": "displayId",
"message": "body.data.displayId must be a string"
}
]
} |
...
3.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 corretamente02. JSON enviando faltando um ou mais campos.
| Bloco de código |
|---|
| title | JSON Inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "fa3a2d45-3a29-4136-95e7-692d93db8b2b",
"type": "TABLE",
"displayId": "55",
"createdAt": "2024-06-24T17:35:00",
"orderTiming": "2024-06-24T17:40:24",
"preparationStartDateTime": "2024-06-24T18:00:00",
"items": [
{
"id": "54",
"index": "54",
"name": "MARACUJA",
"externalCode": "58",
"unit": "UN",
"quantity": 1.0,
"specialInstructions": "Teste",
"unitPrice": {
"value": 61.00,
"currency": "R$"
}{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "fa3a2d45-3a29-4136-95e7-692d93db8b2b",
"type": "TABLE",
"displayId": "55",
"createdAt": "2024-06-24T17:35:00",
"orderTiming": "2024-06-24T17:40:24",
"preparationStartDateTime": "2024-06-24T18:00:00",
"items": [
{
"id": "54",
"index": "54",
"name": "MARACUJA",
"externalCode": "58",
"optionsPriceunit": {"UN",
"valuequantity": 01.0,
"currencyspecialInstructions": "R$"
}Teste",
"totalPriceunitPrice": {
"value": 61.00,
"currency": "R$"
}
}
],
"otherFees": [],
},
"totaloptionsPrice": {
"itemsvalue": 610.0,
"otherFeescurrency": 0"R$"
},
"discounttotalPrice": 0.0,{
"orderAmountvalue": 61.000,
"additionalFeescurrency": 0,"R$"
"deliveryFee": 0
},
"payments": {}
"prepaid": 0.0],
"pendingotherFees": 0.0[],
"methodstotal": [
{
"valueitems": 61.0,
"currencyotherFees": "BRL"0,
"typediscount": "PREPAID"0.0,
"methodorderAmount": "credit"61.0,
"methodInfoadditionalFees": "Visa"0,
"changeFordeliveryFee": 0.0
},
]
}"payments": null,
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": {
"waiterCode": "9999",
"tableNumber": "54",
"chairNumber": "1"
},
"card": null
}
} |
...
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 |
|---|
| title | URL enviada incorreda |
|---|
|
https://api-barramento.meuelevestage.com/order/newOrderS |
...
| Dica |
|---|
|
Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral acesse a documentação clicando aqui. |
| Dica |
|---|
|
Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral, adicionais acesse a documentação clicando aqui. |
| Dica |
|---|
|
Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral, adicionais, descontos e taxa acesse a documentação clicando aqui. |
...
...
04. LINKS
