Histórico da Página
...
03. EXEMPLO DE UTILIZAÇÃOÂncora utilizar utilizar
| utilizar | |
| utilizar |
3.1 - Request - Obter detalhes de um pedido específico:
Essa requisição é utilizada para buscar informações detalhadas sobre um pedido específico:Âncora detalhes_pedido_especifico detalhes_pedido_especifico
...
3.2 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, você receberá uma resposta contendo o status atualizado e os detalhes do pedido.
...
3.3 - Request - Reenvio da solicitação, resposta de processamento:
Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento.
...
3.4 - Request - Retornar o status de múltiplos pedidos:
Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido
| Âncora | ||||
|---|---|---|---|---|
|
...
3.5 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.
...
3.6 - Request - Reenvio da solicitação, resposta de processamento:
Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento.
...
3.7 - Request - Retornar o status de múltiplos pedidos:
Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido.Âncora todos_status todos_status
...
3.8 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.
...
3.9 - Request - Ao reenviar a solicitação, a resposta será a seguinte:
Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.
...
| Informações | ||
|---|---|---|
| ||
Os dados retornados pela resposta incluem:
|
Dicionário de Retorno
Informações sobre os retornos da API cancelledItems.
- orderKeyType: Deve respeita a tabela abaixo:
...
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
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 |
| 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 |
- Detalhamento dos campos da lista de itens:
| Campo | Valor | Descrição |
|---|---|---|
| id | string | Identificador do item dentro do pedido |
| status | objeto | Status atual do item, incluindo detalhes adicionais sobre o progresso |
| deliveryAgent | string | Nome do agente responsável pela entrega (obrigatório se for do tipo delivery) |
| deliveryDateTime | string (data e hora) | Data e hora da entrega do pedido (obrigatório para pedidos do tipo delivery) |
| cancellationReason | string | Motivo do cancelamento do item ou do pedido, obrigatório em casos de cancelamento |
- Detalhamento do campo
error(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 |
- Valores possíveis para
orderKeyType:
| Enum | Descrição |
|---|---|
| TABLE | Representa um número de mesa |
| CARD | Representa um cartão |
| ORDER_ID | Representa um identificador único do pedido |
- orderKey: É o identificador do pedido:
...
04. ERROSÂncora erros erros
| erros | |
| 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.
014.1 - Formando inválido do JSON esperado.
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
...
024.2 - JSON enviando faltando um ou mais campos.
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
...
034.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"
}
]
} |
...
044. Enviando 4 - Enviando uma requisição sem informar o código da orderKey corretamente
...
Import HTML Content
Visão Geral
Conteúdo das Ferramentas