CONTEÚDO
01. VISÃO GERAL
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 Cartão - Get Status
02. ENDPOINT
| Método | URL |
|---|
| POST | https://api-barramento.meuelevestage.com/order/status |
03. EXEMPLO DE UTILIZAÇÃO
01. O corpo da requisição enviada para retornar todos os status dos pedidos é o seguinte:
| Bloco de código |
|---|
| title | Corpo da requisição no JSON |
|---|
| linenumbers | true |
|---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "CARD",
"orderKey": [],
"lastestUpdatedStatus": "2024-09-12 11:30:10",
"items": [
{
"id": "ad976378-8823-48d3-9cd1-62d68cf3be77",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "1"
},
{
"id": "2160c838-97d0-432f-a43a-dce087150d49",
"status": {
"code": 505,
"description": "TABLE_IN_USE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"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": "4040"
}
]
} |
| 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 obter o status de um pedido especifico:
| Âncora |
|---|
| detalhes_pedido_especifico |
|---|
| detalhes_pedido_especifico |
|---|
|
| Bloco de código |
|---|
| title | Corpo da requisição no JSON |
|---|
| 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",
"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. |
03. Corpo da requisição para obter o status de múltiplos pedidos:
| Bloco de código |
|---|
| title | Corpo da requisição no JSON |
|---|
| linenumbers | true |
|---|
|
{
"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": "340"
},
{
"id": "360",
"status": {
"code": 412,
"description": "NOT_FOUND"
},
"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 GetOrderStatus. |
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. JSON enviando faltando um ou mais campos.
| Bloco de código |
|---|
| title | Corpo da requisição no JSON faltando campos |
|---|
| linenumbers | true |
|---|
|
{
"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 |
|---|
| title | Resposta do JSON da requisição |
|---|
| linenumbers | true |
|---|
|
{
"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 |
|---|
| title | JSON Inválido |
|---|
| linenumbers | true |
|---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"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 |
|---|
| title | Resposta do JSON da requisição |
|---|
| 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, por causa do Token de autenticação ausente.
| Bloco de código |
|---|
| title | URL enviada incorreda |
|---|
|
https://api-barramento.meuelevestage.com/order/statusS |
| Bloco de código |
|---|
| title | Corpo da requisição no JSON |
|---|
| linenumbers | true |
|---|
|
{
"message": "Missing Authentication Token"
} |
- 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. Uma ou mais informações postadas não foram encontradas.
| Nota |
|---|
| title | Nota: HTTP Status Code = 404 - Not Found |
|---|
|
Uma ou mais informações enviadas não puderam ser encontradas. |
05. LINKS
