CONTEÚDO
...
Âncora | ||||
---|---|---|---|---|
|
Método | URL | Ambiente |
---|---|---|
POST | https://api-barramento.meuelevestage.com/order/getStatus | Homologação |
POST | https://api-barramento.meueleve.com/order/getStatus | Produção |
...
...
Âncora | ||||
---|---|---|---|---|
|
3.1 - Request - Retornar o status de múltiplos pedidos:
Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido.01. Retornar todos os estados dos pedidos:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b", "orderKeyType": "TABLECARD", "orderKey": [] } |
Bloco de códigonote | |||||
---|---|---|---|---|---|
| |||||
A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
...
3.2 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors{ "success": true, "error": null, "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b", "orderKeyType": "TABLE", "orderKey": [], "lastestUpdatedStatus": "2024-07-03 17:18:42", "items": [ { "idkey": "fd8654cf-ca3d-440c-b34e-c7936cbbd1fdorderKeyType_orderKey", "statusmessage": "Order status request already exists: CARD_" } ] } |
Nota | ||
---|---|---|
| ||
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
...
3.3 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success": true, "error": null, "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b", "orderKeyType": "CARD", "orderKey": [], "lastestUpdatedStatus": "2024-09-12 11:30:10", "items": [{ "code": 506, "description": "CLOSED_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "1" }, { "id": "f08549f8-c82f-4d29-8955-25bc9f15c84a", "status": { "code": 506, "description": "CLOSED_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "2" }, { "id": "d19436e4ad976378-99da8823-459348d3-a92a9cd1-46125f076e1262d68cf3be77", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "31" }, { "id": "05bc94782160c838-60cc97d0-43b3432f-87bba43a-6f9a1d0cf295dce087150d49", "status": { "code": 504505, "description": "OPENTABLE_TABLEIN_USE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "4340" }, { "id": "3b35ffe5b17fd862-b48dc06d-4a664bce-b5bf9f11-c6e2c5b82d8a358a2be04668", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "5370" }, { "id": "86ebfa7f5b8d7e5c-db95f87e-42ad40ac-baf091b7-b2a5e0865c74726da529fc88", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "64040" }, { "id": "64fe9584-8c9e-4587-8733-ae86ae9a8721", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "7" }, { "id": "9dc5de7e-88f8-467f-bd85-bd3126db9160", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "8" }, { "id": "60efbaa6-fbca-41ca-a03e-70986b1b6957", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "9" }, { "id": "f6b6f8dc-e674-465e-b949-5d5851beb1b2", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "10" }, { "id": "5ad276aa-27f1-41c4-8e66-136c052dcedf", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "11" }, { "id": "693abccf-b584-4e40-83df-266e0d4a787e", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "12" }, { "id": "2214be25-c48b-4917-b375-ebee2b5534d8", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "13" }, { "id": "745f28a5-b6e0-43eb-9e86-32e6fe68174b", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "17" }, { "id": "db5b9ae2-7111-4310-866b-5eb66a63bdbb", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "18" }, { "id": "406a2a14-ac79-422a-b667-769fa1d2a9a0", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "19" }, { "id": "3a18df72-bd49-4184-aeec-bc3d499bf4ba", "status": { "code": 506, "description": "CLOSED_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "20" }, { "id": "2442a7dc-257d-4c01-8b42-55c9ada53420", "status": { "code": 506, "description": "CLOSED_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "21" } ] } |
...
]
} |
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
3.4 - Request - Obter detalhes de um pedido específico:
Essa requisição é utilizada para buscar informações detalhadas sobre um pedido específico:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["40"]
} |
Nota | ||
---|---|---|
| ||
A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
...
3.5 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, você receberá uma resposta contendo o status atualizado e os detalhes do pedido.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: CARD_40"
}
]
}
|
Nota | ||
---|---|---|
| ||
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
...
3.6 - Request - Reenvio da solicitação, resposta de processamento:
Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["40"],
"lastestUpdatedStatus": "2024-06-28 09:04:06",
"items": [
{
"id": "50425147-5d06-4b87-a05b-4586f2dccc71",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": " |
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40"]
} |
Nota | ||
---|---|---|
| ||
A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "orderKeyType_orderKey", "message": "Order status request already exists: TABLE_40" } ] } |
Nota | ||
---|---|---|
| ||
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
3.7 - Request - Retornar o status de múltiplos pedidos:
Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success": true, "error": null, "integrationHubServiceId": "1853f0ab7056c970-faf7cb11-47d6400f-a193-610b20807143", "orderKeyType": "TABLE", "orderKey": [ "40" ], "lastestUpdatedStatus": "2024-06-28 09:04:06", "items": [ { "id": "50425147-5d06-4b87-a05b-4586f2dccc71", "status": { "code": 505, "description": "TABLE_IN_USE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "409d4f-9f30253f3b0b", "orderKeyType": "TABLE", "orderKey": ["40", "20"] } |
Nota | ||
---|---|---|
| ||
A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
...
3.5 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: CARD_40, 20"
}
]
} |
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
title | JSON Para retornar múltiplos pedidos |
---|---|
linenumbers | true |
...
|
Nota | ||
---|---|---|
| ||
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
...
3.6 - Request - Reenvio da solicitação, resposta de processamento:
Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento:
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success": true, "error": null, "integrationHubServiceId": "647469f87056c970-b31bcb11-4fae400f-ba339d4f-99e04def555b9f30253f3b0b", "orderKeyType": "TABLECARD", "orderKey": [ "1840", "1920" ], "lastestUpdatedStatus": "2024-0609-2812 0911:1356:4609", "items": [ { "id": "8c3752a12160c838-ae1597d0-42a1432f-bafba43a-189ca95f0211dce087150d49", "status": { "code": 505504, "description": "OPEN_TABLE_IN_USE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "18340" }, { "id": "5ebf990f-9075-462c-b675-a8c57a350d61360", "status": { "code": 504412, "description": "OPENNOT_TABLEFOUND" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumberdeliveryDateTime": "19" } ] } |
Informações | ||
---|---|---|
| ||
Neste exemplo, os dados retornados incluem:
|
Informações | ||
---|---|---|
| ||
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
...
null,
"cancellationReason": null,
"tableCardNumber": null
}
]
} |
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
Dicionário de Requisição
Essa requisição permite consultar o status atualizado de um pedido, retornando informações detalhadas sobre cada item associado ao pedido e possíveis erros ocorridos durante o processo. A integração é identificada de forma única através da integrationHubServiceId
Campo | Valor | Descrição |
---|---|---|
integrationHubServiceId * | string | Chave de identificação da integração no hub |
orderKeyType * | enum "TABLE", "CARD", "ORDER_ID" | Tipo de chave do pedido, que pode ser mesa, cartão ou ID do pedido |
orderKey | string | Identificador do pedido, de acordo com o tipo definido em orderKeyType |
orderKeyType
:Enum | Descrição |
---|---|
TABLE | Identifica o pedido pelo número da mesa |
CARD | Identifica o pedido pelo número do cartão |
ORDER_ID | Identifica o pedido por um ID exclusivo do pedido |
Dica | ||
---|---|---|
| ||
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
...
Â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.
4.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 incorretos01. Formando inválido do JSON esperado.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "393d95727056c970-2ec9cb11-4cda400f-9ad39d4f-5b69e02c988d9f30253f3b0b", "orderKeyType": "string", "orderKey": ["string"] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "orderKeyType", "message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]" } ] } |
...
4.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 | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "a5c4e1357056c970-aacdcb11-49c1400f-b0519d4f-160a78a83b569f30253f3b0b" } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "orderKeyType", "message": "body.orderKeyType is required" }, { "key": "orderKey", "message": "body.orderKey is required" } ] } |
...
4.3 - GUID incorreto:
O GUID (Identificador Globalmente Único) enviado na requisição está incorreto ou malformado, o que pode resultar em um erro. Um GUID é uma sequência específica que deve seguir o padrão correto.03. GUID incorreto
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "9a1cf3267056c970-c962cb11-456f400f-8c499d4f-c1bb2f340fc6A9f30253f3bAA", "orderKeyType": "TABLECARD", "orderKey": [] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "integrationHubServiceId", "message": "body.integrationHubServiceId must be a valid GUID" } ] } |
...
4.4 - Requisição enviada sem informar o orderKey
corretamente:
Caso a requisição seja enviada sem o campo orderKey
ou com o valor incorreto, o sistema não conseguirá identificar o pedido, resultando em um erro 400. O orderKey
deve estar corretamente preenchido e de acordo com o orderKeyType
informado.04. Enviando uma requisição sem informar o código da orderKey corretamente
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "808c143d7056c970-d6d4cb11-4b95400f-8c379d4f-efa3a934f2229f30253f3b0b", "orderKeyType": "TABLECARD", "orderKey": [""] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": 0, "message": "body.orderKey[0] is not allowed to be empty" } ] } |
...
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/getStatuS |
...
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.
...
title | Integration Hub Code Inválido |
---|---|
linenumbers | true |
...
o integrationHubId
está incorreto ou inválido.
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 |
...
7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["5"]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
"orderKeyType": "TABLE",
"orderKey": []
} | ||||
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 |
...
Âncora | ||||
---|---|---|---|---|
|
O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), alguma regra para atendimento de sua solicitação não foi atendida, analise o corpo da declaração para saber os motivos.
Nota | ||
---|---|---|
| ||
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. |
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "7d7d205b7056c970-83bacb11-47c5400f-91ba9d4f-e4f32a2bbd9e9f30253f3b0b", "orderKeyType": "TABLECARD", "orderKey": ["5"] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success": true, "error": null, "integrationHubServiceId": "7d7d205b7056c970-83bacb11-47c5400f-91ba9d4f-e4f32a2bbd9e9f30253f3b0b", "orderKeyType": "TABLECARD", "orderKey": [ "5" ], "lastestUpdatedStatus": "2024-07-02 18:54:28", "items": [ { "id": "de9fd388-c223-4325-a64d-08889250f839", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "5" } ] } |
Nota | ||
---|---|---|
| ||
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
Âncora | ||||
---|---|---|---|---|
|
API Order |
---|
Cartão - New Order |
---|
API Order |
Cartão - Get Consumption |
---|
API Order |
Cartão - Consumption |
---|
API Order |
Cartão - Payment |
---|
API Order |
Cartão - Get Cancelled Items |
---|
API Order |
Cartão - |
---|
Cancelled Items |
---|
API Order |
Cartão - |
---|
Status |
---|
Templatedocumentos |
---|