...
02. ENDPOINT
Método | URL |
---|
POST | https://api-barramento.meuelevestage.com/order/getStatus |
...
03. EXEMPLO DE UTILIZAÇÃO
01. Retornar todos os estados dos pedidos:
Bloco de código |
---|
title | JSON Para retornar o status de todos os pedidos |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLECARD",
"orderKey": []
} |
Bloco de código |
---|
title | Resposta do JSON da requisição |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLECARD",
"orderKey": [],
"lastestUpdatedStatus": "2024-0709-0312 1711:1830:4210",
"items": [
{
"id": "fd8654cfad976378-ca3d8823-440c48d3-b34e9cd1-c7936cbbd1fd62d68cf3be77",
"status": {
"code": 506504,
"description": "CLOSEDOPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "1"
},
{
"id": "f08549f82160c838-c82f97d0-4d29432f-8955a43a-25bc9f15c84adce087150d49",
"status": {
"code": 506505,
"description": "CLOSEDTABLE_IN_TABLEUSE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "2340"
},
{
"id": "d19436e4b17fd862-99dac06d-45934bce-a92a9f11-46125f076e12358a2be04668",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "3370"
},
{
"id": "05bc94785b8d7e5c-60ccf87e-43b340ac-87bb91b7-6f9a1d0cf295726da529fc88",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "44040"
},
{
"id
]
} |
...
02. Obter detalhes de um pedido específico:
Âncora |
---|
| detalhes_pedido_especifico |
---|
| detalhes_pedido_especifico |
---|
|
Bloco de código |
---|
title | JSON Para retornar o status de um pedido específico |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "3b35ffe57056c970-b48dcb11-4a66400f-b5bf9d4f-c6e2c5b82d8a9f30253f3b0b",
"status "orderKeyType": {
"code": 504,
"description"CARD",
"orderKey": ["OPEN_TABLE40"]
},
"deliveryAgent": null,
"deliveryDateTime": null,} |
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 de um pedido específico HTTP Status Code = 208 |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"cancellationReasonkey": null"orderKeyType_orderKey",
"tableCardNumbermessage": "5Order status request already exists: CARD_40"
},
]
}
|
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 de um pedido |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": [
"40"
],
"lastestUpdatedStatus": "2024-06-28 09:04:06",
"items": [
{
"id": "50425147-5d06-4b87-a05b-4586f2dccc71 {
"id": "86ebfa7f-db95-42ad-baf0-b2a5e0865c74",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "6"
},
{
"id": "64fe9584-8c9e-4587-8733-ae86ae9a8721",
"status": {
"code": 504505,
"description": "OPENTABLE_IN_TABLEUSE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "740"
},
{
"id": "9dc5de7e-88f8-467f-bd85-bd3126db9160",
"status": {
"code": 504,
"description": "OPEN_]
} |
Nota |
---|
title | Nota: HTTP Status Code = 226 IM Used |
---|
|
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
03. Retornar o status de múltiplos pedidos:
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"TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReasonintegrationHubServiceId": null"7056c970-cb11-400f-9d4f-9f30253f3b0b",
"tableCardNumberorderKeyType": "8CARD"
},
{
"idorderKey": "60efbaa6-fbca-41ca-a03e-70986b1b6957[
"40",
"status20": {
],
"codelastestUpdatedStatus": "2024-09-12 11:56:09",
"items": [
{
"id": "2160c838-97d0-432f-a43a-dce087150d49",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "9340"
},
{
"id": "f6b6f8dc-e674-465e-b949-5d5851beb1b2360",
"status": {
"code": 504412,
"description": "OPENNOT_TABLEFOUND"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "10"null
},
{
"id": "5ad276aa-27f1-41c4-8e66-136c052dcedf",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "11"
},]
} |
...
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": ["string"]
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"idkey": "693abccf-b584-4e40-83df-266e0d4a787eorderKeyType",
"statusmessage": {
"code": 504,
"description": "OPEN_TABLE"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"
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{ "deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumberkey": "12orderKeyType"
},
{
"idmessage": "2214be25-c48b-4917-b375-ebee2b5534d8",
"status": body.orderKeyType is required"
},
{
"codekey": 504"orderKey",
"descriptionmessage": "OPEN_TABLEbody.orderKey is required"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "13"
},
{
"id": "745f28a5-b6e0-43eb-9e86-32e6fe68174b",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "17"
},
{
"id": "db5b9ae2-7111-4310-866b-5eb66a63bdbb",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "18"
},
{
"id": "406a2a14-ac79-422a-b667-769fa1d2a9a0",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "19"
},
{
"id": "3a18df72-bd49-4184-aeec-bc3d499bf4ba",
"status": {
"code": 506,
"description": "CLOSED_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "20"
},
{
"id": "2442a7dc-257d-4c01-8b42-55c9ada53420",
"status": {
"code": 506,
"description": "CLOSED_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "21"
}
]
} |
...
Bloco de código |
---|
title | JSON Para retornar o status de um pedido específico |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40"]
} |
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 de um pedido específico HTTP Status Code = 208 |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: TABLE_40"
}
]
}
|
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 de um pedido |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "1853f0ab-faf7-47d6-a193-610b20807143",
"orderKeyType": "TABLE",
"orderKey": [
"40"
],
"lastestUpdatedStatus": "2024-06-28 09:04:06",
"items": [
{
"id": "50425147-5d06-4b87-a05b-4586f2dccc71",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "40"
}
]
} |
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:
...
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": "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": 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. |
...
...
03. GUID incorreto
Bloco de código |
---|
title | JSON com o GUID inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3bAA",
"orderKeyType": "CARD",
"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": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": [""]
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 401 Unauthorized400 Bad Request |
---|
|
A solicitação 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 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/getStatuS |
...
title | JSON Response para URL incorreta |
---|
linenumbers | true |
---|
...
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 = 403 - Forbidden401 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 novamenteO cliente não enviou uma requisição para a URL incorreta. |
...
- HTTP Status Code 404 403 - Not FoundForbidden
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.
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/getStatuS |
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 para URL incorreta |
---|
linenumbers | true |
---|
|
{
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "ProviderMissing 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 |
...
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": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código |
---|
title | HTTP Status Code 412 = Precpndition Failed |
---|
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 = 404 - Not Found |
---|
|
IntegrationHubId incorreto ou inválido |
...
- HTTP Status Code 412 - Precondition Failed
Âncora |
---|
| status_code_412 |
---|
| status_code_412 |
---|
|
O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), alguma regra para atendimento de sua solicitação não foi atendida, analise o corpo da declaração para saber os motivos.
Nota |
---|
title | Nota: HTTP Status Code = 412 Precondition Failed |
---|
|
Alguma 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. |
...
Bloco de código |
---|
title | JSON da requisição |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7d7d205b7056c970-83bacb11-47c5400f-91ba9d4f-e4f32a2bbd9e9f30253f3b0b",
"orderKeyType": "TABLECARD",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | Resposta da última execução |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7d7d205b7056c970-83bacb11-47c5400f-91ba9d4f-e4f32a2bbd9e9f30253f3b0b",
"orderKeyType": "TABLECARD",
"orderKey": [
"5"
],
"lastestUpdatedStatus": "2024-07-02 18:54:28",
"items": [
{
"id": "de9fd388-c223-4325-a64d-08889250f839",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "5"
}
]
} |
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