Histórico da Página
CONTEÚDO
01. VISÃO GERALÂncora ver_geral ver_geral
| ver_geral | |
| ver_geral |
Este endpoint é utilizado para envio de requisição para novos pedidos na API Order mesa via barramento. Para envio de requisições para pedidos em geral para Mesa. Onde o consumo será realizado no local.
...
02. ENDPOINTÂncora endpoint endpoint
| endpoint | |
| endpoint |
...
| Método | URL |
|---|---|
| POST | https://api-barramento.meuelevestage.com/order/newOrder |
...
03. EXEMPLO DE UTILIZAÇÃOÂncora utilizar utilizar
| utilizar | |
| utilizar |
Corpo da requisição de envio de novo:
| Informações | ||
|---|---|---|
| ||
JSON de RequestOrderNewOrder Este JSON é utilizado para enviar informações de criar 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:integrationHubServiceIdpassando informações detalhadas sobre o pedido, como identificação da integração, tipos de pedido, origem do pedido, e eventos associados. Ele é composto pelos seguintes campos:
merchant (objeto, obrigatório)
items (array de objetos, obrigatório)
|
...
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.
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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": {
"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
}
} |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "displayId",
"message": "body.data.displayId must be a string"
}
]
} |
02. JSON enviando faltando um ou mais campos.
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "299f76ba-3ac3-4cc1-abaf-fac5a2510d8c",
"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$"
},
"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
}
} |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "merchant",
"message": "body.data.merchant is required"
}
]
} |
| 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. |
...
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 |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"message": "Missing Authentication Token"
} |
| Nota | ||
|---|---|---|
| ||
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.
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
"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
}
} |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
| Nota | ||
|---|---|---|
| ||
| IntegrationHubId incorreto ou inválido |
| 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 |
...
...
04. LINKSÂncora links links
| links | |
| links |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas