CONTEÚDO - NÃO MEXE API
...
Esta documentação tem como finalidade demonstrar o formato JSON para envio de requisições de pedidos com vários itens na API Order Cartão Consumo, utilizando o endpoint newOrder.
...
...
| Âncora | ||||
|---|---|---|---|---|
|
2.1. Request Vários Itens:
01. Corpo da requisição para envio de vários itens no mesmo pedido:
...
| 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:
...
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
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 | ||
|---|---|---|
|
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
"type": "CARD",
"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": 1,
"specialInstructions": "Teste",
"unitPrice": {
"value": 69.90,
"currency": "R$"
},
"optionsPrice": {
"value": 1.00,
"currency": "R$"
},
"totalPrice": {
"value": 69.90,
"currency": "R$"
}
},
{
"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$"
}
}
],
"otherFees": [],
"discounts": [],
"total": {
"items": 102.89,
"otherFees": 38.99,
"discount": 0.00,
"orderAmount": 141.88,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": null,
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": null,
"card": {
"waiterCode": 9999,
"cardNumber": 29,
"deliveryTableNumber": 29
}
}
} |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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 corretamente.
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"data": {
"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
"type": "CARD",
"displayId": "8",
"createdAt": "2024-06-24T17:35:00",
"orderTiming": "2024-06-24T17:40:24",
"preparationStartDateTime": "2024-06-24T18:00:00",
"items": [
{
"id": "2",
"index": "2",
"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$"
}
},
{
"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$"
}
}
],
"otherFees": [],
"discounts": [],
"total": {
"items": 102.89,
"otherFees": 38.99,
"discount": 0.00,
"orderAmount": 141.88,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": null,
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": null,
"card": {
"waiterCode": 9999,
"cardNumber": 29,
"deliveryTableNumber": 29
}
}
} |
...
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 |
...
| Dica | ||
|---|---|---|
| ||
Para obter detalhes técnicos sobre o envio de requisições ao endpoint |
| Dica | ||
|---|---|---|
| ||
Para obter detalhes técnicos sobre o envio de requisições ao endpoint |
| Dica | ||
|---|---|---|
| ||
Para obter detalhes técnicos sobre o envio de requisições ao endpoint |
...
...
| Âncora | ||||
|---|---|---|---|---|
|
| New Order |
|---|
| Cartão - Item com Valor Integral |
|---|
| New Order Cartão - |
| Itens Fracionando |
|---|
| Templatedocumentos |
|---|
