CONTEÚDO
...
O endpoint CancelledItems da API Order MesaCartão é utilizado para envio do resultado da solicitação de itens cancelados de pedido através do Ponto de Vendas (PDV). Este endpoint recebe o mesmo corpo de requisição utilizado pelo endpoint GetCancelledItems
- API Order Mesa Cartão - Get Cancelled Items
...
02. ENDPOINT
...
Método | URL |
---|
POST | https://api-barramento.meuelevestage.com/order/cancelledItens |
...
03. EXEMPLO DE UTILIZAÇÃO
01. Corpo da requisição de um cancelamento especifico:
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "5ffec6b8011c8369-1c5551c1-4a7d4d49-985f9dab-12d13685b5539d4ed9f38844",
"orderKeyType": "TABLECARD",
"orderKey": [
"22"
],
"lastestUpdatedStatus": "2024-07-18 09:26:47",
"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"
}
]
} |
...
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "d01ea5cd011c8369-795251c1-4b774d49-b0ae9dab-ed93aa32e8329d4ed9f38844",
"orderKeyType": "TABLECARD",
"orderKey": [
"22",
"23"
],
"lastestUpdatedStatus": "2024-07-18 09:48:03",
"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"
},
{
"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"
}
]
} |
Dica |
---|
|
O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint GetCancelledItems |
info
...
04. ERROS
...
...
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úmero 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.
A
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:
...
Bloco de código |
---|
title | Corpo da requisição no JSON faltando campos |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "5ffec6b8011c8369-1c5551c1-4a7d4d49-985f9dab-12d13685b5539d4ed9f38844",
"orderKeyType": "TABLECARD",
"orderKey": [
"22",
"23"
],
"lastestUpdatedStatus": "2024-07-18 09:48:03",
"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"
},
{
"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"
}
]
} |
...
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "5ffec6b8011c8369-1c5551c1-4a7d4d49-985f9dab-12d13685b5539d4ed9f38844",
"orderKeyType": "String",
"orderKey": [
"22",
"23"
],
"lastestUpdatedStatus": "2024-07-18 09:48:03",
"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"
},
{
"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"
}
]
} |
...
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/cancelledItensS |
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"message": "'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImludGVncmF0aW9uSHViU2VydmljZUlkIjoiNWZmZWM2YjgtMWM1NS00YTdkLTk4NWYtMTJkMTM2ODViNTUzIiwicHJvdmlkZXJNZXJjaGFudElkIjoiNTAiLCJwcm92aWRlcklkIjoiOTZlZjNjOTEtMDFmMy00ZjQ5LThjMmEtMGUxMDBjNjZlYjE5IiwibG9naW4iOiIiLCJwYXNzd29yZCI6IiIsImF1dGhvcml6YXRpb25Db2RlIjoiIiwiYXV0aG9yaXphdGlvbkNvZGVWZXJpZmllciI6IiIsIm1lcmNoYW50SWQiOiJmOTRkMjBjYy0yMTIwLTRjMDMtYjM5NS0xYWM3MjU1NDI2OGEiLCJtZXJjaGFudE5hbWUiOiJCT1RFQ08gRE8gQUxCSU5PIiwicHJvdmlkZXJOYW1lIjoiR29vbWVyIiwiYXBwSWQiOiI1N2Y0MzczMS1mNGE2LTRjMDgtODYxNy03YzkyMTAwMTZiZmIiLCJhcHBEZXNjcmlwdGlvbiI6IlRPVFZTIENoZWYiLCJhcHBOb3RpZmljYXRpb25UeXBlIjoiU1FTIn0sImV4cCI6MTcyMTMxMjA5MCwiaWF0IjoxNzIxMzA4NDkwfQ._oyafbCtPm9kiKS6jEb9lZjiE11O7aNRh3Z4tJAnpM8' not a valid key=value pair (missing equal-sign) in Authorization header: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImludGVncmF0aW9uSHViU2VydmljZUlkIjoiNWZmZWM2YjgtMWM1NS00YTdkLTk4NWYtMTJkMTM2ODViNTUzIiwicHJvdmlkZXJNZXJjaGFudElkIjoiNTAiLCJwcm92aWRlcklkIjoiOTZlZjNjOTEtMDFmMy00ZjQ5LThjMmEtMGUxMDBjNjZlYjE5IiwibG9naW4iOiIiLCJwYXNzd29yZCI6IiIsImF1dGhvcml6YXRpb25Db2RlIjoiIiwiYXV0aG9yaXphdGlvbkNvZGVWZXJpZmllciI6IiIsIm1lcmNoYW50SWQiOiJmOTRkMjBjYy0yMTIwLTRjMDMtYjM5NS0xYWM3MjU1NDI2OGEiLCJtZXJjaGFudE5hbWUiOiJCT1RFQ08gRE8gQUxCSU5PIiwicHJvdmlkZXJOYW1lIjoiR29vbWVyIiwiYXBwSWQiOiI1N2Y0MzczMS1mNGE2LTRjMDgtODYxNy03YzkyMTAwMTZiZmIiLCJhcHBEZXNjcmlwdGlvbiI6IlRPVFZTIENoZWYiLCJhcHBOb3RpZmljYXRpb25UeXBlIjoiU1FTIn0sImV4cCI6MTcyMTMxMjA5MCwiaWF0IjoxNzIxMzA4NDkwfQ._oyafbCtPm9kiKS6jEb9lZjiE11O7aNRh3Z4tJAnpM8'."
} |
Nota |
---|
title | Nota: HTTP Status Code = 403 - Forbidden |
---|
|
O cliente não enviou uma requisição para a URL incorreta. |
Token de autenticação ausente.
...
- HTTP Status Code 404 - Not Found
Âncora |
---|
| status_code_404 |
---|
| status_code_404 |
---|
|
...
Bloco de código |
---|
title | JSON de retorno de múltiplos pedidos |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "f1b874af011c8369-96ab51c1-45354d49-aac39dab-25118fe586cc9d4ed9f38844",
"orderKeyType": "TABLECARD",
"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 |
---|
title | Resposta do JSON da requisição |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order status for: TABLECARD_22 not found"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 404 - Not Found |
---|
|
Uma ou mais informações enviadas não puderam ser encontradas. |
...
05. LINKS