CONTEÚDO
Este endpoint é utilizado para envio de requisição para novos pedidos na API Order mesa via barrament.
| Método | URL |
|---|---|
| POST | https://api-barramento.meuelevestage.com/order/newOrder |
01. Corpo da requisição de envio de novo pedidos inteiro:
{
"integrationHubServiceId":"933aadb4-c33b-40b8-8285-bf1e575d8b38",
"data":{
"id":"9ec389e5-7582-4768-875b-ee7c309aa34f",
"type":"TABLE",
"displayId":"29",
"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":"3973594021",
"index":"21",
"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.00,
"otherFees":0,
"discount":0.00,
"orderAmount":61.00,
"additionalFees":0,
"deliveryFee":0
},
"payments":{
"prepaid":0.0,
"pending":0.0,
"methods":[
{
"value":61.00,
"currency":"BRL",
"type":"PREPAID",
"method":"credit",
"methodInfo":"Visa",
"changeFor":0.0
}
]
},
"delivery":null,
"extraInfo":"Teste",
"schedule":null,
"indoor":null,
"takeout":null,
"table":{
"waiterCode":"9999",
"tableNumber":"29",
"chairNumber":"1"
},
"card":null
}
} |
Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status. |
JSON de RequestOrderNewOrder Este JSON é utilizado para enviar informações de um novo pedido, incluindo detalhes do pedido, itens, cliente, pagamentos e outras taxas associadas. Ele serve como um formato padronizado para criar pedidos através de um sistema de integração. Campos:integrationHubServiceId (string, obrigatório)
data (objeto, obrigatório)
merchant (objeto, obrigatório)
items (array de objetos, obrigatório)
|
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
Para obter detalhes técnicos sobre como realizar uma requisição à |
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": "9b6f45cb-effb-4b0c-b782-f934b45c109e",
"data": {
"id": "80137319-c82d-499c-af0f-00118ec06f91",
"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": {
"prepaid": 0.0,
"pending": 0.0,
"methods": [
{
"value": 61.0,
"currency": "BRL",
"type": "PREPAID",
"method": "credit",
"methodInfo": "Visa",
"changeFor": 0.0
}
]
},
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": {
"waiterCode": "9999",
"tableNumber": "54",
"chairNumber": "1"
},
"card": null
}
} |
{
"errors": [
{
"key": "displayId",
"message": "body.data.displayId must be a string"
}
]
} |
02. JSON enviando faltando um ou mais campos.
{
"integrationHubServiceId": "6e7d1a42-9d59-4dd8-9976-8d8edc2a106a",
"data": {
"id": "f1bddb3f-63c4-4b2f-be53-e4527275ad9d",
"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$"
},
"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": {
"prepaid": 0.0,
"pending": 0.0,
"methods": [
{
"value": 61.0,
"currency": "BRL",
"type": "PREPAID",
"method": "credit",
"methodInfo": "Visa",
"changeFor": 0.0
}
]
},
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": {
"waiterCode": "9999",
"tableNumber": "54",
"chairNumber": "1"
},
"card": null
}
} |
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
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 não entendeu a requisição do cliente por está tentando acessar uma URL incorreta
https://api-barramento.meuelevestage.com/order/paymentS |
{
"message": "Missing Authentication Token"
} |
O cliente não enviou uma requisição para a |
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.
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a681A",
"data": {
"id": "f1bddb3f-63c4-4b2f-be53-e4527275ad9d",
"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": {
"prepaid": 0.0,
"pending": 0.0,
"methods": [
{
"value": 61.0,
"currency": "BRL",
"type": "PREPAID",
"method": "credit",
"methodInfo": "Visa",
"changeFor": 0.0
}
]
},
"delivery": null,
"extraInfo": "Teste",
"schedule": null,
"indoor": null,
"takeout": null,
"table": {
"waiterCode": "9999",
"tableNumber": "54",
"chairNumber": "1"
},
"card": null
}
} |
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"3fea8768-bbd9-454b-9e7b-40841e9a681A\" not found or disabled"
}
]
} |
IntegrationHubId incorreto ou inválido |
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. |