CONTEÚDO
01. VISÃO GERAL
Este endpoint é utilizado para obter itens de cancelamento de pedidos por meio de integração do PDV, fornecendo um retorno em formato JSON com os itens cancelados.
Obtenha os itens cancelados atribuídos a um ou mais pedidos utilizando o parâmetro orderKeyType, que pode ser ORDER_ID, TABLE ou CARD.
- Para
orderKeyType = ORDER_ID, é obrigatório informar pelo menos um pedido. - Para
orderKeyType = TABLE ou CARD, quando o parâmetro orderKey não for informado, serão retornados todos os itens cancelados de mesas abertas ou cartões.
02. ENDPOINT
| Método | URL |
|---|
| POST | https://api-barramento.meuelevestage.com/order/getCancelledItens |
03. EXEMPLO DE UTILIZAÇÃO
01. Enviando o pedido para requisição do cancelamento de um pedido especifico: 
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": ["40"]
} |
A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order cancelled itens request already exists: CARD_40"
}
]
} |
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
{
"success": true,
"error": null,
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": [
"40"
],
"lastestUpdatedStatus": "2024-09-10 14:37:14",
"items": [
{
"id": "71",
"index": "332018",
"name": "ALPES SUICOS ZERO",
"externalCode": "71",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-09-10 14:36:29",
"cancellationReason": " 55596;",
"tableCardNumber": "340",
"productionPoint": "NENHUM"
}
]
} |
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
02. Enviando o pedido para requisição do cancelamento de múltiplos pedidos:
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": ["22", "23"]
} |
A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order cancelled itens request already exists: TABLE_22,23"
}
]
} |
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado. |
{
"success": true,
"error": null,
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": [
"22",
"23"
],
"lastestUpdatedStatus": "2024-07-17 16:18:40",
"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"
},
{
"id": "3973594011",
"index": "19",
"name": "MARACUJA",
"externalCode": "58",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-07-17 16:04:27",
"cancellationReason": " 55596;",
"tableCardNumber": "23",
"productionPoint": "NENHUM"
}
]
} |
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
{
"success": true,
"error": null,
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": [
"2",
"5"
],
"lastestUpdatedStatus": "2024-08-16 09:28:06",
"items": [
{
"id": "2",
"index": "2",
"name": "MARACUJA",
"externalCode": "58",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-08-16 09:26:56",
"cancellationReason": " 55596;",
"tableCardNumber": "2",
"productionPoint": "NENHUM"
},
{
"id": "5",
"index": "5",
"name": "MARACUJA",
"externalCode": "58",
"quantity": 1,
"cancellationAgent": "ALBINO",
"cancellationDateTime": "2024-08-16 09:27:09",
"cancellationReason": " 55596;",
"tableCardNumber": "5",
"productionPoint": "NENHUM"
}
]
} |
Para o correto funcionamento desse endpoint, o respectivo pedido deverá ter sido previamente cancelado no PDV para a API retornar a resposta do pedido cancelado |
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
- HTTP Status Code - 400 - Bad Request
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.
01. Formando inválido do JSON esperado.
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "string",
"orderKey": ["22"]
} |
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
02. JSON enviando faltando um ou mais campos.
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e"
} |
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
03. GUID incorreto
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850A",
"orderKeyType": "CARD",
"orderKey": []
} |
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "body.integrationHubServiceId must be a valid GUID"
}
]
} |
04. Enviando uma requisição sem informar o código da orderKey corretamente
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": [""]
} |
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente. |
- HTTP Status Code 401 - Unauthorized
O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.
A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente. |
- HTTP Status Code 403 - Forbidden
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL incorreta
https://api-barramento.meuelevestage.com/order/getCancelledItensS |
{
"message": "Missing Authentication Token"
} |
O cliente não enviou uma requisição para a URL incorreta. |
- HTTP Status Code 404 - Not Found
O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId está incorreto ou inválido.
{
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"orderKeyType": "CARD",
"orderKey": ["5"]
} |
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
IntegrationHubId incorreto ou inválido |
- HTTP Status Code 429 - Too Many Requests
O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.
{
"integrationHubServiceId": "05a7718d-00ff-4c79-b726-2ce19025850e",
"orderKeyType": "CARD",
"orderKey": ["5"]
} |
{
"success": true,
"error": null,
"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
"orderKeyType": "CARD",
"orderKey": [
"22"
],
"lastestUpdatedStatus": "2024-07-17 17:08:45",
"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"
}
]
} |
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
05. LINKS
