Histórico da Página
...
info| Dica | ||
|---|---|---|
| ||
O corpo da request preenchida, deverá ser obrigatóriamente o é o mesmo que o corpo do response obtido através do endpoint |
Dicionário de Request
...
Informações
...
Neste exemplo, os dados retornados incluem:
sobre o campos da request da API cancelledItems, é utilizada para retornar os dados do(s) pedido(s) cancelado(s).
- Detalhamento dos campos da requisição:
...
| Campo | Valor | Descrição |
|---|---|---|
| success | boolean |
| Indica se a operação foi bem-sucedida |
...
| error |
...
| objeto | Contém informações sobre erros, se houver |
...
| integrationHubServiceId |
...
| string | Chave de identificação de integração |
...
| orderKeyType |
...
| "TABLE", "CARD", "ORDER_ID" | Tipo da chave do pedido (neste caso |
...
| "TABLE" |
...
| , "CARD |
...
| " ou "ORDER_ID |
...
| ") |
| orderKey |
...
| array | Lista de identificadores de pedidos ( |
...
| números de mesa, cartão, ou ID de pedido) |
...
| lastestUpdatedStatus |
...
| string (data e hora) | Data e hora da última atualização do status dos pedidos |
...
| items |
...
| array | Lista de itens cancelados |
- Detalhamento dos campos da lista de itens cancelados
...
- :
...
| Campo | Valor | Descrição |
|---|---|---|
| id | string |
| Identificador do produto no lançamento. |
| index |
...
| string | Posição do produto no lançamento. | |
| name |
...
| string | Nome do item/produto. | |
| externalCode |
...
| string | Código do produto no PDV integrado. | |
| quantity |
...
| número | Quantidade do item cancelado. | |
| cancellationAgent |
...
| string | Operador responsável pelo cancelamento. | |
| cancellationDateTime |
...
| string (data e hora) | Data e hora do cancelamento. | |
| cancellationReason |
...
| string | Motivo do cancelamento. | |
| tableCardNumber |
...
| string | Número da mesa ou |
...
| cartão associado ao item cancelado |
...
| productionPoint |
...
| string | Ponto de produção |
...
| relacionado ao item |
...
Dicionário de Retorno
...
- Exemplo de retorno em caso de erro:
| Enum | Valor | Descrição |
|---|
- error: O erro é necessário quando o sucesso é falso. Deve retornar caso haja o seguinte:
CampoValor
message
| code | código do erro |
- orderKey: É o identificador do pedido:
CampoValororderKeyCódigo de identificação do pedido, sendo uma "string
| Identifica o código do erro | |
| message | messagem do erro |
- orderKeyType: Deve respeita a tabela abaixo:
...
| Descrição detalhada do erro ocorrido, ex: "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]" |
...
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:
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas