...
| Método | URL | Ambiente |
|---|
| POST | https://api-barramento.meuelevestage.com/order/cancelledItems | Homologação |
| POST | https://api-barramento.meueleve.com.br/order/cancelledItems | Produção |
...
03. EXEMPLO DE UTILIZAÇÃO
3.1 - Envio da requisição para obter o status de um item cancelado no PDV:
Ao enviar a requisição para este endpoint, o sistema processa a solicitação e retorna o status atualizado de um item cancelado no PDV. O corpo da requisição deve conter os dados obtidos no endpoint getCancelledItems, e a resposta fornecerá as informações detalhadas sobre o cancelamento solicitado.
| Bloco de código |
|---|
| title | Corpo da requisição no JSON |
|---|
| linenumbers | true |
|---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
"orderKeyType": "TABLE",
"orderKey": ["22"],
"lastestUpdatedStatus": "2024-07-18 09:26:47",
"items": [
{
"id": "39735945",
"index": "5",
"name": "MARACUJA",
"externalCode": "58",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-07-17 14:19:33",
"cancellationReason": " 55596;",
"tableCardNumber": "22",
"productionPoint": "NENHUM"
}
]
} |
...
| Campo | Valor | Descrição |
|---|
| success * | boolean | Indica se a operação foi bem-sucedida |
| error | objeto | Contém informações sobre erros, se houver (veja na tabela de error) |
| integrationHubServiceId * | string | Chave de identificação de integração |
| orderKeyType * | enum | Tipo da chave do pedido (veja na tabela orderKeyType) |
| 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 |
...
- Estrutura cancelledItems (dentro de
item):
| 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 |
...
| Enum | Valor | Descrição |
|---|
| code * | código do erro | Identifica o código do erro |
| message * | messagem do erro | Descrição detalhada do erro ocorrido, ex: "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]" |
| 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:
...
