Histórico da Página
...
3.1. Request - Corpo da requisição para retornar o consumo específico:
Essa requisição é enviada para obter detalhes sobre o consumo de um pedido específico, retornando as informações relevantes do consumo solicitado.
| Âncora | ||||
|---|---|---|---|---|
|
...
| Nota | ||
|---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
023.2. Request - Corpo da requisição para obter o status de múltiplos pedidos:
Essa requisição é utilizada para consultar o status atualizado de vários pedidos simultaneamente, retornando as informações detalhadas de cada pedido solicitado.
| Âncora | ||||
|---|---|---|---|---|
|
...
| Dica | ||
|---|---|---|
| ||
O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint |
Dicionário da Request
Informações sobre os retornos da API cancelledItems.
- orderKeyType: Deve respeita a tabela abaixo:
O endpoint Consumption retorna informações sobre o consumo, utilizando o como corpo da requisição a resposta do status code 226 do endpoint API Order Mesa - Get Consumption
- Estrutura OrderConsumption:
| Campo | Valor | Descrição |
|---|---|---|
| integrationHubServiceId | string | Chave de identificação única da integração no hub |
| orderKeyType | enum | Tipo de chave usada para identificar o pedido. Enum: OrderKeyType (veja tabela abaixo) |
| orderKey | string | Chave correspondente ao tipo selecionado em orderKeyType |
| success | boolean | Indica se a operação foi bem-sucedida |
| consumptions | array | Lista de itens consumidos relacionados ao pedido (veja tabela de consumptions). |
| error | object | Informações sobre o erro, presente quando success for false (veja tabela de error). |
- Estrutura Consumption (dentro de
consumptions):
Campo | Valor | Descrição |
|---|---|---|
| type | enum | Tipo do consumo |
| createdAt | string (data e hora) | Data e hora da criação do pedidos |
| customerName | string | Nome do cliente |
| items | array | Itens do pedido, onde cada item inclui: |
| otherFees | array | Lista de outras taxas aplicáveis (veja tabela de OtherFees) |
| discounts | array | Lista de descontos aplicáveis (veja tabela de Discounts) |
| delivery | array | Informações sobre entregas (veja tabela de OrderTypeDelivery) |
| takeout | array | Informações sobre pedidos para retirada (veja tabela de OrderTypeTakeout) |
| table | array | Informações sobre pedidos em mesa (veja tabela de OrderTypeTable) |
| card | array | Informações sobre pedidos por cartão (veja tabela de OrderTypeCard) |
- Enumerações para orderKeyType:
Enum | Descrição |
|---|---|
| TABLE | Identifica o pedido pelo número da mesa |
| CARD | Identifica o pedido pelo número do cartão |
| ORDER_ID | Identifica o pedido por um ID exclusivo |
- 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 |
- Estrutura OrderItems (dentro de
items):
Campo | Valor | Descrição |
|---|---|---|
| id | string | Identificador único do item |
| index | string | Posição do item (opcional) |
| name | string | Nome do produto |
| externalCode | string | Código externo do produto (opcional) |
| unit | string | Unidade de medida do item |
| ean | string | Código de barras EAN do item (opcional) |
| quantity | number | Quantidade de itens |
| specialInstructions | string | Instruções especiais sobre o item (opcional) |
| unitPrice | number | Preço por unidade, considerando 4 casas decimais |
| originalPrice | number | Preço original antes de descontos |
| originalPrice | number | Código da moeda ISO 4217 |
| optionsPrice | number | Preço total das opções associadas ao item |
| totalPrice | number | Preço total do item |
| options | array | Extras opcionais escolhidos pelo consumidor. Cada opção inclui: |
| productionPoint | string | Ponto de produção associado ao item |
- Estrutura OrderItemsOptions (dentro de
options):
Campo | Valor | Descrição |
|---|---|---|
| id | string | Identificador único da opção |
| name | string | Nome da opção |
| unit | number | Unidade de medida da opção |
| quantity | number | Quantidade de itens opcionais |
- orderKey: É o identificador do pedido:
...
Import HTML Content
Visão Geral
Conteúdo das Ferramentas