...
| Bloco de código |
|---|
| title | Corpo da requisição no JSON |
|---|
| linenumbers | true |
|---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "647469f8-b31b-4fae-ba33-99e04def555b",
"orderKeyType": "TABLE",
"orderKey": ["18"],
"lastestUpdatedStatus": "2024-06-28 09:13:46",
"items": [
{
"id": "8c3752a1-ae15-42a1-bafb-189ca95f0211",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "18"
},
{
"id": "5ebf990f-9075-462c-b675-a8c57a350d61",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "19"
}
]
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 226 IM Used |
|---|
|
Status enviado com sucesso. |
| Dica |
|---|
|
O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint GetOrderStatus. |
| Informações |
|---|
|
Neste exemplo, os dados retornados incluem: success: Indica se a operação foi bem-sucedida.error: Contém informações sobre erros, se houver.integrationHubServiceId: O identificador do serviço de integração.orderKeyType: O tipo da chave do pedido (neste caso, "TABLE").orderKey: A chave do pedido, que pode ser uma lista de identificadores.lastestUpdatedStatus: A data e hora da última atualização do status do pedido.items: Uma lista de itens relacionados ao pedido, onde cada item inclui:id: O identificador do item.status: O status atual do item, incluindo um código e uma descrição.deliveryAgent: Informações sobre o agente de entrega, se aplicável.deliveryDateTime: Data e hora de entrega, se aplicável.cancellationReason: Motivo do cancelamento, se aplicável.tableCardNumber: O número da mesa associada ao pedidoque o corpo da resposta obtida através do endpoint GetOrderStatus. |
Dicionário de Requisição
Essa requisição permite verificar o o status atualizado do(s) pedido(s), retornando informações de acordo com o corpo da response obtida atráves do endpoint getStatus.
...
- 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 | |
| status * | objeto | Objeto contendo informações detalhadas sobre o status |
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:
...
