...
Ao fazer essa requisição, o sistema processa a solicitação de cancelamento do pedido indicado.
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["22"]
} |
...
Informações sobre os campos da API cancelledItems:
- integrationHubServiceId: É a identificação da integraçãoEstrutura Enumeração integrationHubServiceId:
Campo | Valor | Descrição |
---|
integrationHubServiceId |
Código de identificação do pedido, sendo uma "string" sendo um UUID* | string | Chave de identificação de integração que é utilizada para identificar de forma única a integração dentro do hub |
orderKeyType |
...
| enum | Tipo de chave de pedido (veja tabela orderKeyType) |
orderKey | array | Solicitar chave de pedido de itens cancelados. Uma lista que contém os identificadores dos pedidos, conforme especificado no campo orderKeyType |
- Estrutura Enumeração orderKeyType:
Enum | Valor | Descrição |
---|
TABLE | TABLE |
...
Enum | Valor | Descrição |
---|
TABLE | TABLE | Chave que representa o número da mesa |
CARD | CARD | Chave que representa um cartão |
ORDERD_ID | ORDER_ID | Chave que representa o identificador do pedido |
- orderKey - É o identificador do pedido:
...
Dica |
---|
|
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
...
04. ERROS
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 |
---|
title | JSON Inválido |
---|
linenumbers |
---|
|
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "string",
"orderKey": ["22"]
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
...
4.2 . JSON enviando faltando - 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.
Bloco de código |
---|
|
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
...
4.3 . GUID incorreto - 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.
Bloco de código |
---|
title | JSON com o GUID inválido |
---|
linenumbers | true |
---|
|
Bloco de código |
---|
title | JSON com o GUID inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código |
---|
title | JSON Inválido GUID incorreto |
---|
linenumbers | true |
---|
|
{
"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 |
---|
title | JSON com sem informar o código da orderKey |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
"orderKeyType": "TABLE",
"orderKey": [""]
} |
...