...
...
02. ENDPOINT
Método | URL |
---|
POST | https://api-barramento.meuelevestage.com/order/getCancelledItens |
...
03. EXEMPLO DE UTILIZAÇÃO
01. Retornar todos os estados dos pedidos: Enviando o pedido para requisição do cancelamento de um pedido especifico:
Bloco de código |
---|
title | JSON Para retornar o status de todos os pedidosCorpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["22"]
} |
...
Bloco de código |
---|
title | JSON de resposta do retorno de um pedido específico - 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 | Resposta do JSON da requisição 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. Obter detalhes de um pedido específico Enviando o pedido para requisição do cancelamento de múltiplos pedidos:
Âncora |
---|
| detalhes_pedido_especifico |
---|
| detalhes_pedido_especifico |
---|
|
Bloco de código |
---|
title | JSON Para retornar o status de um pedido específicoCorpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["22", "23"]
} |
...
Bloco de código |
---|
title | JSON de resposta do retorno de um pedido específico - 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ódigonote |
---|
|
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. |
|
{
"success": true,
" |
Bloco de código |
---|
title | JSON de resposta do retorno de um pedido |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "1853f0ab7056c970-faf7cb11-47d6400f-a1939d4f-610b208071439f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": [
"22",
"4023"
],
"lastestUpdatedStatus": "2024-0607-2817 0916:0418:0640",
"items": [
{
"id": "50425147-5d06-4b87-a05b-4586f2dccc7139735945",
"statusindex": {"5",
"codename": 505"MARACUJA",
"descriptionexternalCode": "TABLE_IN_USE58",
}"quantity": 1,
"deliveryAgentcancellationAgent": null"ALBINO",
"deliveryDateTimecancellationDateTime": null"2024-07-17 14:19:33",
"cancellationReason": null" 55596;",
"tableCardNumber": "22",
"productionPoint": "40NENHUM"
},
]
} |
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 Para retornar múltiplos pedidos |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40", "20"]
} |
Bloco de código |
---|
title | JSON de retorno de múltiplos pedidos |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "647469f8-b31b-4fae-ba33-99e04def555b",
"orderKeyType": "TABLE",
"orderKey": [
"18",
"19"
],
"lastestUpdatedStatus": "2024-06-28 09:13:46",
"items": [
{
"id": "8c3752a1-ae15-42a1-bafb-189ca95f0211",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "18"
},
{
"id": "5ebf990f-9075-462c-b675-a8c57a350d61",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "19"
}
]
} |
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 : A chave do pedido, que pode ser uma lista de identificadores.lastestUpdatedStatus : A data e hora da última atualização do status do pedido.items : Uma lista de itens relacionados ao pedido, onde cada item inclui:id : O identificador do item.status : O status atual do item, incluindo um código e uma descrição.deliveryAgent : Informações sobre o agente de entrega, se aplicável.deliveryDateTime : Data e hora de entrega, se aplicável.cancellationReason : Motivo do cancelamento, se aplicável.tableCardNumber : O número da mesa associada ao pedido.
|
Informações |
---|
|
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
...
{
"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 |
---|
|
|
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 |
...
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
...
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": "393d9572-2ec9-4cda-9ad3-5b69e02c988d",
"orderKeyType": "string",
"orderKey": ["string"]
} |
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": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "string",
{
"integrationHubServiceIdorderKey": "a5c4e135-aacd-49c1-b051-160a78a83b56"["22"]
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must is required"
},
{
"key": "orderKey",
"message": "body.orderKey is requiredbe one of [ORDER_ID, TABLE, CARD]"
}
]
} |
...
03. GUID incorreto 02. JSON enviando faltando um ou mais campos.
Bloco de código |
---|
title | JSON com o GUID inválidoInválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
"orderKeyType": "TABLE",
"orderKeyintegrationHubServiceId": []"a5c4e135-aacd-49c1-b051-160a78a83b56"
} |
Bloco de código |
---|
title | JSON Inválido GUID incorretoResposta |
---|
linenumbers | true |
---|
|
{
"errors": [[
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "integrationHubServiceIdorderKey",
"message": "body.orderKey is required"
}
]
} |
...
03. GUID incorreto
Bloco de código |
---|
title | JSON com o GUID inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId must be a valid GUID"
}
]
} |
04. Enviando uma requisição sem informar o código da orderKey corretamente
": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código |
---|
title | JSON Inválido GUID incorreto |
---|
|
Bloco de código |
---|
title | JSON com sem informar o código da orderKey |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId "errors": [
{
"key": "808c143d-d6d4-4b95-8c37-efa3a934f222integrationHubServiceId",
"orderKeyTypemessage": "TABLE",
"orderKey": [""]
}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 Response com sem informar o código da orderKey |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
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. |
...
"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 = 401 Unauthorized400 Bad Request |
---|
|
A solicitação é inválida e não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente. |
...
- HTTP Status Code 403 401 - ForbiddenUnauthorized403403
O código de status HTTP 403401, conhecido como "Forbidden" (Proibido), indica 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 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/getStatuS |
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. |
, 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 - ForbiddenHTTP Status Code 404 - Not Found
Âncora |
---|
| status_code_404403 |
---|
| status_code_404403 |
---|
|
O código de status HTTP 404403, conhecido como "Not FoundForbidden" (Não EncontradoProibido), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId
está incorreto ou inválido.entendeu a requisição do cliente por está tentando acessar uma URL
incorreta
Bloco de código |
---|
title | Integration Hub Code Inválido |
---|
linenumbers | true |
---|
URL enviada incorreda |
|
https://api-barramento.meuelevestage.com/order/getCancelledItensS{
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | JSON Response para URL incorreta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
}
"message": "Missing Authentication Token"
} |
Nota |
---|
title | Nota: HTTP Status Code = 404 403 - Not FoundForbidden |
---|
|
O cliente não enviou uma requisição para a URL incorreta.IntegrationHubId incorreto ou inválido |
...
- HTTP Status Code 412 404 - Precondition FailedNot Found412412
O código de status HTTP 412404, conhecido como "Precondition FailedNot Found" (Pré-condição FalhouNão Encontrado), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição. encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId
está incorreto ou inválido.
Bloco de código |
---|
title | JSON Integration Hub Code Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "8f7949c3f1b874af-cdd696ab-4db04535-8746aac3-369e651026b425118fe586cc",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | HTTP Status Code 412 = Precpndition FailedJSON Response |
---|
linenumbers | true |
---|
|
{
"message": "NOT_FOUND",
"code": 412"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 412 Precondition Failed404 - Not Found |
---|
|
IntegrationHubId incorreto ou inválidoAlguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos. |
...
- HTTP Status Code 429 - Too Many Requests
Âncora |
---|
| status_code_429 |
---|
| status_code_429 |
---|
|
...
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": "7d7d205b5ffec6b8-83ba1c55-47c54a7d-91ba985f-e4f32a2bbd9e12d13685b553",
"orderKeyType": "TABLE",
"orderKey": [
"522"
],
"lastestUpdatedStatus": "2024-07-0217 1817:5408:2845",
"items": [
{
"id": "de9fd388-c223-4325-a64d-08889250f839"39735945",
"index": "5",
"name": "MARACUJA",
"statusexternalCode": {"58",
"codequantity": 5041,
"descriptioncancellationAgent": "OPEN_TABLE"
}ALBINO",
"deliveryAgentcancellationDateTime": null"2024-07-17 14:19:33",
"deliveryDateTimecancellationReason": null" 55596;",
"cancellationReasontableCardNumber": null"22",
"tableCardNumberproductionPoint": "5NENHUM"
}
]
} |
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