...
O endpoint Get Status da API Order Mesa é utilizado para o envio do resultado da solicitação de status dos pedidos do Ponto de Venda (PDV). Este endpoint recebe o mesmo corpo de requisição utilizado pelo endpoint GetOrderStatus
- API Order Mesa Cartão - Get Status
...
Âncora | ||||
---|---|---|---|---|
|
Método | URL |
---|---|
POST | https://api-barramento.meuelevestage.com/order/status |
...
01. O corpo da requisição enviada para retornar todos os status dos pedidos é o seguinte:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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": 506, 504, "description": "CLOSEDOPEN_TABLE" }, }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "1" }, { { "id": "f08549f82160c838-c82f97d0-4d29432f-8955a43a-25bc9f15c84adce087150d49", "status": { "code": 506, 505, "description": "CLOSEDTABLE_IN_TABLEUSE" }, }, "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, "cancellationReason": null, "tableCardNumber": "340" }, { "id": "b17fd862-c06d-4bce-9f11-358a2be04668", "status": { "code": 504, "description": "OPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "370" }, { "id": "5b8d7e5c-f87e-40ac-91b7-726da529fc88", "status": { "code": 504, "description": "OPEN_TABLE" }, }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "54040" }, { "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, } ] } |
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
02. Enviando o pedido para obter o status de um pedido especifico:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"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",
"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. |
...
03. Corpo da requisição para obter o status de múltiplos pedidos:
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success": true, "error": null, "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b", "orderKeyType": "CARD", "orderKey": [ "40", "20" ], "lastestUpdatedStatus": "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": "11" }, { "tableCardNumber": "340" }, { "id": "693abccf-b584-4e40-83df-266e0d4a787e360", "status": { "code": 504, 412, "description": "OPENNOT_TABLEFOUND" }, }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": null } ] } |
Dica | ||
---|---|---|
| ||
O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint |
...
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. JSON enviando faltando um ou mais campos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"success": true,
"orderStatus": [
{
"id": "bd768726-91ef-4161-b35b-4e28e711dfd8",
"status": {
"code": 1,
"description": "Em Preparo"
}
}
]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errors": [ { "key": "integrationHubServiceId", "message": "body.integrationHubServiceId must be a valid GUID" }, { "key": "orderKeyType", "message": "body.orderKeyType is required "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" }, { "idkey": "406a2a14-ac79-422a-b667-769fa1d2a9a0orderKey", "statusmessage": { "code": 504, "description": "OPEN_TABLE"body.orderKey is required" } }] } |
02. Formando inválido do JSON esperado
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "success, "deliveryAgent": nulltrue, "deliveryDateTimeerror": null, "cancellationReasonintegrationHubServiceId": null"7056c970-cb11-400f-9d4f-9f30253f3b0b", "tableCardNumberorderKeyType": "19String", },"orderKey": [ {"22" ], "idlastestUpdatedStatus": "3a18df722024-bd49-4184-aeec-bc3d499bf4ba07-16 15:48:30", "statusitems": [ { "codeid": 506"975dbf9b-a11d-4efe-b491-197ee123bfe4", "status": { "code": 504, "description": "CLOSEDOPEN_TABLE" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "2022" }, ] } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "iderrors": "2442a7dc-257d-4c01-8b42-55c9ada53420", "status": { [ { "codekey": 506"orderKeyType", "descriptionmessage": "CLOSED_TABLE" body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]" }, "deliveryAgent": null, "deliveryDateTime": null, "cancellationReason": null, "tableCardNumber": "21" } ] }] } |
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
é 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 não entendeu a requisição, por causa do Token de autenticação ausente.
Bloco de código | ||
---|---|---|
| ||
https://api-barramento.meuelevestage.com/order/statusS |
Bloco de código | ||
---|---|---|
|
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "TABLE",
"orderKey": [
"19"
],
"lastestUpdatedStatus": "2024-07-15 16:40:13",
"items": [
{
"id": "406a2a14-ac79-422a-b667-769fa1d2a9a0",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "19"
}
]
} |
Nota | ||
---|---|---|
| ||
A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado. |
...
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"
}
]
} |
Dica | ||
---|---|---|
| ||
O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint |
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:
...
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. JSON enviando faltando um ou mais campos.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b5538",
"success": true,
"orderStatus": [
{
"id": "bd768726-91ef-4161-b35b-4e28e711dfd8",
"status": {
"code": 1,
"description": "Em Preparo"
}
}
]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "body.integrationHubServiceId must be a valid GUID"
},
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
02. Formando inválido do JSON esperado
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"success": true,
"error": null,
"integrationHubServiceId": "644a4d3c-6d2c-4154-a089-c1ab3fd89151",
"orderKeyType": "String",
"orderKey": [
"22"
],
"lastestUpdatedStatus": "2024-07-16 15:48:30",
"items": [
{
"id": "975dbf9b-a11d-4efe-b491-197ee123bfe4",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "22"
}
]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
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. |
...
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. |
...
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 | ||
---|---|---|
| ||
https://api-barramento.meuelevestage.com/order/statusS |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"integrationHubServiceId": "1188f64e-3ce8-45be-882c-6c8dcfcb70d4",
"orderKeyType": "TABLE",
"orderKey": ["09"]
} |
Nota | ||
---|---|---|
| ||
O cliente não enviou uma requisição para a |
...
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 ocorrer quando o token
da requisição da autenticação, é diferente do token
gerado utilizando o integrationHubId
diferente do corpo da requisição.
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"success": true,
"error": null,
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"orderKeyType": "TABLE",
"orderKey": [
"19"
],
"lastestUpdatedStatus": "2024-07-15 17:02:35",
"items": [
{
"id": "406a2a14-ac79-422a-b667-769fa1d2a9a0",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "19"
}
]
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "errorsmessage": [ { "key": "orderKeyType_orderKey", "message": "Order status for: TABLE_22 not found" } ] }"Missing Authentication Token" } |
...
Â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. Uma ou mais informações postadas não foram encontradas.
Nota | ||
---|---|---|
| ||
Uma ou mais informações enviadas não puderam ser encontradas. |
...