CONTEÚDO
- Visão Geral
- Endpoint
- Exemplo de Utilização
- Erros
- Links
01. VISÃO GERAL
...
Esse endpoint serve para retornar os itens cancelados.
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:
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["22"]
} |
Nota |
---|
title | Nota: HTTP Status Code = 202 Accepted |
---|
|
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. |
...
Bloco de código |
---|
title | JSON de resposta do retorno - HTTP Status Code = 208 |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order cancelled itens request already exists: TABLE_22,23"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 208 Already Reported |
---|
|
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. |
...
Bloco de código |
---|
title | JSON de resposta do retorno - Status Code = 226 |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": [
"22"
],
"lastestUpdatedStatus": "2024-07-17 14:21:24",
"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"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 226 IM Used |
---|
|
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:
Âncora |
---|
| detalhes_pedido_especifico |
---|
| detalhes_pedido_especifico |
---|
|
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["22", "23"]
} |
Nota |
---|
title | Nota: HTTP Status Code = 202 Accepted |
---|
|
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. |
...
Bloco de código |
---|
title | JSON de resposta do retorno - HTTP Status Code = 208 |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order cancelled itens request already exists: TABLE_22,23"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 208 Already Reported |
---|
|
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. |
...
Bloco de código |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"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"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 226 IM Used |
---|
|
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
Bloco de código |
---|
title | JSON de retorno de múltiplos pedidos |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "d5152936-5678-44ef-9d8e-e41462155a76",
"orderKeyType": "TABLE",
"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"
}
]
} |
Informações |
---|
|
Neste exemplo, os dados retornados incluem: - success: Indica se a operação foi bem-sucedida.
- error: Contém informações sobre erros, se houver.
- integrationHubServiceId: O identificador do serviço de integração.
- orderKeyType: O tipo da chave do pedido (neste caso, "TABLE").
- orderKey: Uma lista de identificadores de pedidos (neste caso, números de mesa).
- lastestUpdatedStatus: A data e hora da última atualização do status dos pedidos.
- items: Uma lista de itens cancelados, onde cada item inclui:
- id: O identificador do item.
- index: O índice do item.
- name: O nome do item.
- externalCode: O código externo do item.
- quantity: A quantidade do item cancelado.
- cancellationAgent: O agente que realizou o cancelamento.
- cancellationDateTime: Data e hora do cancelamento.
- cancellationReason: O motivo do cancelamento.
- tableCardNumber: O número da mesa ou do cartão associado ao item cancelado.
- productionPoint: O ponto de produção associado ao item.
|
Informações |
---|
|
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
Dica |
---|
|
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
Âncora |
---|
| status_code_400 |
---|
| status_code_400 |
---|
|
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.
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "string",
"orderKey": ["22"]
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
...
02. JSON enviando faltando um ou mais campos.
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
...
03. GUID incorreto
Bloco de código |
---|
title | JSON com o GUID inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código |
---|
title | JSON Inválido GUID incorreto |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "body.integrationHubServiceId must be a valid GUID"
}
]
} |
...
04. Enviando uma requisição sem informar o código da orderKey corretamente
Bloco de código |
---|
title | JSON com sem informar o código da orderKey |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
"orderKeyType": "TABLE",
"orderKey": [""]
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 400 Bad Request |
---|
|
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
Âncora |
---|
| status_code_401 |
---|
| status_code_401 |
---|
|
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.
Nota |
---|
title | Nota: HTTP Status Code = 401 Unauthorized |
---|
|
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
Âncora |
---|
| status_code_403 |
---|
| status_code_403 |
---|
|
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
Bloco de código |
---|
title | URL enviada incorreda |
---|
|
https://api-barramento.meuelevestage.com/order/getCancelledItensS |
Bloco de código |
---|
title | JSON Response para URL incorreta |
---|
linenumbers | true |
---|
|
{
"message": "Missing Authentication Token"
} |
Nota |
---|
title | Nota: HTTP Status Code = 403 - Forbidden |
---|
|
O cliente não enviou uma requisição para a URL incorreta. |
...
- HTTP Status Code 404 - Not Found
Âncora |
---|
| status_code_404 |
---|
| status_code_404 |
---|
|
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.
Bloco de código |
---|
title | Integration Hub Code Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 404 - Not Found |
---|
|
IntegrationHubId incorreto ou inválido |
...
- HTTP Status Code 429 - Too Many Requests
Âncora |
---|
| status_code_429 |
---|
| status_code_429 |
---|
|
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.
Bloco de código |
---|
title | JSON da requisição |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | Resposta da última execução |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
"orderKeyType": "TABLE",
"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"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 429 - Too Many Requests |
---|
|
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
05. LINKS
...