...
- Detalhamento dos campos da requisição:
| 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 |
| true | A operação foi concluída com sucesso e o status dos pedidos será retornado |
| false | A operação falhou, com detalhes fornecidos no campo error |
| lastestUpdatedStatus * | string |
(data e hora) | Data e hora da última atualização do status dos pedidos |
| orderKey * | array | Lista de identificadores dos pedidos (neste caso, o número da mesa) |
| orderKeyType |
enum "TABLE", "CARD", "ORDER_ID"| * | enum | Tipo de chave do pedido, que pode ser mesa, cartão ou ID do pedido |
| items * | array | Lista de itens associados ao pedido, detalhando o status de cada item |
- Itens associados detalhados:
| Campo | Valor | Descrição |
|---|
| id * | string | Identificador do item dentro do pedido |
| status * | objeto | Objeto contendo informações detalhadas sobre o status do item |
| status.code | number | Código representando o status atual do item |
| status.description | string | Descrição do status atual do item |
| deliveryAgent | string | Agente responsável pela entrega (obrigatório para pedidos de entrega) |
| deliveryDateTime | string |
(data e hora) | Data e hora em que a entrega foi realizada (obrigatório para pedidos de entrega) |
| cancellationReason | string | Motivo do cancelamento do item (se o item foi cancelado) |
- Estrutura do Enum Items - Status
| Campo | Valor | Descrição |
|---|
| code * | number | Código do status |
| description * | string | Descrição do status |
- Erro (quando
success é false):
| Campo | Valor | Descrição |
|---|
| code * | código do erro | Identifica o tipo de erro ocorrido |
| message * | mensagem descritiva | Detalha a falha e fornece mais informações sobre o erro |
| 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:
...
