CONTEÚDO
...
Âncora | ||||
---|---|---|---|---|
|
Este endpoint é utilizado no PDV para o status do pedidos solicitado pelo o endpointg GerOrderStatus
- `https://api-barramento.meuelevestage.com/order/getStatus`, fornecendo um retorno em formato JSON com diversos atributos relevantes. Ao enviar um pedido no formato especificado, como nos exemplos abaixo. O endpoint processa a solicitação e retorna um conjunto de dados que inclui o status mais recente do pedido, a identificação do serviço, a chave do pedido e detalhes específicos de cada item relacionado ao pedido.
...
Âncora | ||||
---|---|---|---|---|
|
Método | URL |
---|---|
POST | https://api-barramento.meuelevestage.com/order/status |
...
01. Retornar todos os estados dos pedidos:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": [],
"lastestUpdatedStatus": "2024-07-03 17:18:42",
"items": [
{
"id": "fd8654cf-ca3d-440c-b34e-c7936cbbd1fd",
"status": {
"code": 506,
"description": "CLOSED_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "1"
},
{
"id": "f08549f8-c82f-4d29-8955-25bc9f15c84a",
"status": {
"code": 506,
"description": "CLOSED_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "2"
},
{
"id": "d19436e4-99da-4593-a92a-46125f076e12",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "3"
},
{
"id": "05bc9478-60cc-43b3-87bb-6f9a1d0cf295",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "4"
},
{
"id": "3b35ffe5-b48d-4a66-b5bf-c6e2c5b82d8a",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "5"
},
{
"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": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "7"
},
{
"id": "9dc5de7e-88f8-467f-bd85-bd3126db9160",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "8"
},
{
"id": "60efbaa6-fbca-41ca-a03e-70986b1b6957",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "9"
},
{
"id": "f6b6f8dc-e674-465e-b949-5d5851beb1b2",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "10"
},
{
"id": "5ad276aa-27f1-41c4-8e66-136c052dcedf",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "11"
},
{
"id": "693abccf-b584-4e40-83df-266e0d4a787e",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "12"
},
{
"id": "2214be25-c48b-4917-b375-ebee2b5534d8",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"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"
}
]
} |
...
02. Obter detalhes de um pedido específico:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40"]
} |
Nota | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status request already exists: TABLE_40"
}
]
}
|
Nota | ||
---|---|---|
| ||
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": "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 | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
04. Retornar o status de múltiplos pedidos:
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": ["40", "20"]
} |
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"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:
|
Informações | ||
---|---|---|
| ||
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
...
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
Âncora | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "393d9572-2ec9-4cda-9ad3-5b69e02c988d",
"orderKeyType": "string",
"orderKey": ["string"]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
...
03. GUID incorreto
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
"orderKeyType": "TABLE",
"orderKey": [""]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
Nota | ||
---|---|---|
| ||
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. |
...
Âncora | ||||
---|---|---|---|---|
|
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 | ||
---|---|---|
| ||
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. |
...
Âncora | ||||
---|---|---|---|---|
|
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor entendeu a requisição do cliente, mas está se recusando a cumpri-la. Isso geralmente ocorre quando o cliente não possui permissões adequadas para acessar o recurso solicitado, mesmo que as credenciais de autenticação tenham sido fornecidas corretamente.
Bloco de código | ||
---|---|---|
| ||
https://api-barramento.meuelevestage.com/order/getStatuS |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"message": "Missing Authentication Token"
} |
Nota | ||
---|---|---|
| ||
O cliente não incluiu um token de autenticação válido no cabeçalho da requisição. |
...
Âncora | ||||
---|---|---|---|---|
|
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 URL fornecido está incorreto, o recurso foi removido permanentemente ou não está disponível no momento da requisição.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
Nota | ||
---|---|---|
| ||
Uma ou mais informações enviadas não puderam ser encontradas. |
...
Âncora | ||||
---|---|---|---|---|
|
O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
"orderKeyType": "TABLE",
"orderKey": []
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"message": "NOT_FOUND",
"code": 412
} |
Nota | ||
---|---|---|
| ||
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. |
...
Âncora | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"success": true,
"error": null,
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"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 | ||
---|---|---|
| ||
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
Âncora | ||||
---|---|---|---|---|
|
Esse endpoint serve para informar os status dos pedidos
...
Templatedocumentos |
---|