CONTEÚDO
Este endpoint é utilizado para obter informações detalhadas sobre os pedidos, fornecendo um retorno em formato JSON com diversos atributos relevantes. Ao enviar uma solicitação no formato especificado, como nos exemplos abaixo, o endpoint processa a requisição e retorna um conjunto de dados que inclui o status mais recente do pedido, a identificação do serviço, a chave do pedido e detalhes específicos de cada item relacionado ao pedido.
Obtenha o status atribuído a um ou mais pedidos utilizando o parâmetro orderKeyType, que pode ser ORDER_ID, TABLE ou CARD.
orderKeyType = ORDER_ID, é obrigatório informar pelo menos um pedido.orderKeyType = TABLE ou CARD, quando o parâmetro orderKey não for informado, serão retornados todos os status de tabelas ou cartões abertos.| Método | URL | Ambiente |
|---|---|---|
| POST | https://api-barramento.meuelevestage.com/order/getStatus | Homologação |
| POST | https://api-barramento.meueleve.com/order/getStatus | Produção |
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.
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": []
} |
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.
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: CARD_"
}
]
}
|
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.
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": [],
"lastestUpdatedStatus": "2024-09-12 11:30:10",
"items": [
{
"id": "ad976378-8823-48d3-9cd1-62d68cf3be77",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "1"
},
{
"id": "2160c838-97d0-432f-a43a-dce087150d49",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "340"
},
{
"id": "b17fd862-c06d-4bce-9f11-358a2be04668",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "370"
},
{
"id": "5b8d7e5c-f87e-40ac-91b7-726da529fc88",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "4040"
}
]
} |
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:
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["40"]
} |
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.
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: CARD_40"
}
]
}
|
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.
{
"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": "40"
}
]
} |
A solicitação 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:
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40", "20"]
} |
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.
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: CARD_40, 20"
}
]
}
|
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:
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": [
"40",
"20"
],
"lastestUpdatedStatus": "2024-09-12 11:56:09",
"items": [
{
"id": "2160c838-97d0-432f-a43a-dce087150d49",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "340"
},
{
"id": "360",
"status": {
"code": 412,
"description": "NOT_FOUND"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": null
}
]
} |
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 |
Campos marcaos com o * (asteristico) o seu preenchimento é 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.
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 incorretos.
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "string",
"orderKey": ["string"]
} |
{
"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 corretamente.
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b"
} |
{
"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.
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3bAA",
"orderKeyType": "CARD",
"orderKey": []
} |
{
"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.
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": [""]
} |
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
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/getStatuS |
{
"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": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["5"]
} |
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
IntegrationHubId incorreto ou inválido |
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.
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. |
O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["5"]
} |
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"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"
}
]
} |
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |