...
3.1 - Request - Enviando a solicitação para o cancelamento de um pedido específico:
Ao fazer essa requisição, o sistema processa a solicitação de cancelamento do pedido indicado.
...
3.2 - Request - Ao reenviar a solicitação, a resposta retornada será a seguinte:
Após reenviar a requisição, você receberá uma resposta detalhando o status atualizado do processamento do pedido.
...
3.3 - Request - Ao enviar novamente a solicitação, o processamento será realizado conforme a seguinte resposta:
Reenviando a requisição, o sistema processará o pedido e retornará uma resposta que reflete o status do processamento realizado.
...
| Nota | ||
|---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
023.4 - Request - Enviando o pedido para requisição do cancelamento de múltiplos pedidos:múltiplos pedidos:
Essa requisição é utilizada para solicitar o cancelamento de diversos pedidos simultaneamente, permitindo que o sistema processe e cancele cada pedido listado de forma eficiente.
| Âncora | ||||
|---|---|---|---|---|
| ||||
| Âncora | ||||
|
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["22", "23"]
} |
| 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 retornada será a seguinte:
Após reenviar a requisição, você receberá uma resposta detalhando o status atualizado do processamento do pedido.
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
| Bloco de código | ||||
| ||||
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order cancelled itens request already exists: TABLE_22,23"
}
]
} |
| 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 - Ao enviar novamente a solicitação, o processamento será realizado conforme a seguinte resposta:
Reenviando a requisição, o sistema processará o pedido e retornará uma resposta que reflete o status do processamento realizado.
| Bloco de código | ||
|---|---|---|
| ||
{
| ||
| Bloco de código | ||
| ||
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": [
"22",
"23"
],
"lastestUpdatedStatus": "2024-07-17 16:18:40",
"items": [
{
"id": "39735945",
"index": "5",
"name": "MARACUJA",
"externalCode": "58",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-07-17 14:19:33",
"cancellationReason": " 55596;",
"tableCardNumber": "22",
"productionPoint": "NENHUM"
},
{
"id": "3973594011",
"index": "19",
"name": "MARACUJA",
"externalCode": "58",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-07-17 16:04:27",
"cancellationReason": " 55596;",
"tableCardNumber": "23",
"productionPoint": "NENHUM"
}
]
} |
| Nota | ||
|---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
Dicionário da Request
...
Informações
...
sobre os campos
...
Neste exemplo, os dados retornados incluem:
da API cancelledItems:
...
| Campo | Valor | Descrição |
|---|---|---|
| integrationHubServiceId | Código de identificação do pedido, sendo uma "string" sendo um UUID |
| Chave de identificação de integração que é utilizada para identificar de forma única |
...
orderKeyType: O tipo da chave do pedido, podendo ser um dos seguintes valores:
...
orderKey: Uma lista que contém os identificadores dos pedidos, conforme especificado no campo orderKeyType.
| a integração dentro do hub |
Dicionário de Retorno
Informações sobre os retornos da API cancelledItems.
| 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 |
| Campo | Valor | Descrição |
|---|---|---|
| orderKey | Código de identificação do pedido, sendo uma "string" | Uma lista que contém os identificadores dos pedidos, conforme especificado no campo orderKeyType |
...
| Âncora | ||||
|---|---|---|---|---|
|
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
...
