...
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
Informações | ||
---|---|---|
| ||
Os dados retornados pela resposta incluem:
|
...
Dicionário de RetornoDicioná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 |
success | boolean | Indica se a operação foi bem-sucedida |
lastestUpdatedStatus | string (data e hora) | Data e hora da última atualização do status do pedido |
orderKey | string | Identificador do pedido, de acordo com o tipo definido em orderKeyType |
orderKeyType | "TABLE", "CARD", "ORDER_ID" | Tipo de chave do pedido, que pode ser mesa, cartão ou ID do pedido |
items | array | Lista de itens relacionados ao pedido, detalhando o status de cada item |
...
orderKeyType
:Enum | Descrição |
---|---|
TABLE | Representa um número de mesa |
CARD | Representa um cartão |
ORDER_ID | Representa um identificador único do pedido |
...
...
Âncora | ||||
---|---|---|---|---|
|
...
Quando a requisição for reenviada, o sistema processará a solicitação e retornará uma resposta com o status atualizado, juntamente com os detalhes de cada pedido solicitado. Isso garante que qualquer modificação ou atualização recente seja refletida na resposta.
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 -Formando 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 | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "393d9572-2ec9-4cda-9ad3-5b69e02c988d", "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 4.2 - JSON enviando 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": "a5c4e135-aacd-49c1-b051-160a78a83b56" } |
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.4.3 - GUID incorreto
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A", "orderKeyType": "TABLE", "orderKey": [] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "integrationHubServiceId", "message": "body.integrationHubServiceId must be a valid GUID" } ] } |
...
4.4 - Enviando uma requisição sem informar o código da orderKey corretamente 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.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222", "orderKeyType": "TABLE", "orderKey": [""] } |
...