Histórico da Página

CONTEÚDO

• Visão Geral
• Endpoint
• Exemplo de Utilização
  • Retorno do resultado do cancelamento especifico
  • Retorno do resultado de múltiplos cancelamentos
• Erros
  • HTTP Status Code - 400 - Bad Request
  • HTTP Status Code 401 - Unauthorized
  • HTTP Status Code 403 - Forbidden
  • HTTP Status Code 404 - Not Found
  • HTTP Status Code 412 - Precondition Failed
  • HTTP Status Code 429 - Too Many Requests
• Links

...

O endpoint CancelledItems da API Order Mesa é 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 da resposta obtida pelo endpoint GetCancelledItems -   API Order Mesa - Get Cancelled Items

...

02. ENDPOINT

Âncora
endpoint endpoint

...

03. EXEMPLO DE UTILIZAÇÃO

...

Âncora
utilizar utilizar

3.1 - Envio da requisição para obter o status de um item cancelado no PDV:
Ao enviar a requisição para este endpoint, o sistema processa a solicitação e retorna o status atualizado de um item cancelado no PDV. O corpo da requisição deve conter os dados obtidos no endpoint getCancelledItems01. Corpo da requisição de um cancelamento especifico: , e a resposta fornecerá as informações detalhadas sobre o cancelamento solicitado.

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"orderKeyType": "TABLE",
	"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"
		}
	]
}

...

023.2. Request - Corpo da requisição de para consultar o cancelamento de vários pedidos no PDV específico:

Essa requisição é enviada para verificar se os itens de vários pedidos cancelados em um PDV específico foram transmitidos com sucesso. 

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "d01ea5cd-7952-4b77-b0ae-ed93aa32e832",
	"orderKeyType": "TABLE",
	"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"
		}
	]
}

Neste exemplo, os dados retornados incluem:

Dicionário de Request

Informações sobre o campos da request da API cancelledItems, é utilizada para retornar os dados do(s) pedido(s) cancelado(s).

• Estrutura cancelledItems:

...

...

...

...

...

...

...

...

...

...

• 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.

• Enumerações para orderKeyType:

  Âncora
  table_orderKeyType table_orderKeyType

• Estrutura cancelledItems (dentro de item):

• Estrutura Error:

  Âncora
  table_error table_error

...

04. ERROS

Âncora
erros 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:

4.1 - Formato inválido do JSON esperado:

A requisição foi enviada com um JSON malformado ou inválido, o que impede o sistema de interpretá-la corretamente. Isso ocorre quando a estrutura JSON contém erros de sintaxe, como chaves ou colchetes incorretos.

{

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. JSON enviando faltando um ou mais campos.

{
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"orderKeyType": "TABLE",
	"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"
		}
	]
}

{
	"errors": [
		{
			"key": "success",
			"message": "body.success is required"
		}
	]
}

...

4.2 - JSON enviado com a ausência de um ou mais campos obrigatórios:

Se a requisição estiver faltando um ou mais campos obrigatórios, o servidor responderá com um erro 400. Cada campo requerido deve estar presente para que a operação seja processada corretamente02. Formando inválido do JSON esperado

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"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": "ALBINO19",
			"cancellationDateTimename": "2024-07-17 16:04:27MARACUJA",
			"cancellationReasonexternalCode": " 55596;58",
			"tableCardNumberquantity": "23"1,
			"productionPointcancellationAgent": "NENHUM"
		}
	]
}

{
	"errors": [
		{ALBINO",
			"cancellationDateTime": "2024-07-17 16:04:27",
			"keycancellationReason": "orderKeyType 55596;",
			"messagetableCardNumber": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"23",
			"productionPoint": "NENHUM"
		}
	]
}

...

{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}

...

• HTTP Status Code 403 401 - ForbiddenUnauthorized

  Âncora
  status_code_

  403

  401 status_code_

  403

  401

   

O código de status HTTP 403401, conhecido como "ForbiddenUnauthorized" (ProibidoNã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 não entendeu a requisição do cliente por está tentando acessar uma URL incorreta

https://api-barramento.meuelevestage.com/order/cancelledItensS

{
	"message": "'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImludGVncmF0aW9uSHViU2VydmljZUlkIjoiNWZmZWM2YjgtMWM1NS00YTdkLTk4NWYtMTJkMTM2ODViNTUzIiwicHJvdmlkZXJNZXJjaGFudElkIjoiNTAiLCJwcm92aWRlcklkIjoiOTZlZjNjOTEtMDFmMy00ZjQ5LThjMmEtMGUxMDBjNjZlYjE5IiwibG9naW4iOiIiLCJwYXNzd29yZCI6IiIsImF1dGhvcml6YXRpb25Db2RlIjoiIiwiYXV0aG9yaXphdGlvbkNvZGVWZXJpZmllciI6IiIsIm1lcmNoYW50SWQiOiJmOTRkMjBjYy0yMTIwLTRjMDMtYjM5NS0xYWM3MjU1NDI2OGEiLCJtZXJjaGFudE5hbWUiOiJCT1RFQ08gRE8gQUxCSU5PIiwicHJvdmlkZXJOYW1lIjoiR29vbWVyIiwiYXBwSWQiOiI1N2Y0MzczMS1mNGE2LTRjMDgtODYxNy03YzkyMTAwMTZiZmIiLCJhcHBEZXNjcmlwdGlvbiI6IlRPVFZTIENoZWYiLCJhcHBOb3RpZmljYXRpb25UeXBlIjoiU1FTIn0sImV4cCI6MTcyMTMxMjA5MCwiaWF0IjoxNzIxMzA4NDkwfQ._oyafbCtPm9kiKS6jEb9lZjiE11O7aNRh3Z4tJAnpM8' not a valid key=value pair (missing equal-sign) in Authorization header: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImludGVncmF0aW9uSHViU2VydmljZUlkIjoiNWZmZWM2YjgtMWM1NS00YTdkLTk4NWYtMTJkMTM2ODViNTUzIiwicHJvdmlkZXJNZXJjaGFudElkIjoiNTAiLCJwcm92aWRlcklkIjoiOTZlZjNjOTEtMDFmMy00ZjQ5LThjMmEtMGUxMDBjNjZlYjE5IiwibG9naW4iOiIiLCJwYXNzd29yZCI6IiIsImF1dGhvcml6YXRpb25Db2RlIjoiIiwiYXV0aG9yaXphdGlvbkNvZGVWZXJpZmllciI6IiIsIm1lcmNoYW50SWQiOiJmOTRkMjBjYy0yMTIwLTRjMDMtYjM5NS0xYWM3MjU1NDI2OGEiLCJtZXJjaGFudE5hbWUiOiJCT1RFQ08gRE8gQUxCSU5PIiwicHJvdmlkZXJOYW1lIjoiR29vbWVyIiwiYXBwSWQiOiI1N2Y0MzczMS1mNGE2LTRjMDgtODYxNy03YzkyMTAwMTZiZmIiLCJhcHBEZXNjcmlwdGlvbiI6IlRPVFZTIENoZWYiLCJhcHBOb3RpZmljYXRpb25UeXBlIjoiU1FTIn0sImV4cCI6MTcyMTMxMjA5MCwiaWF0IjoxNzIxMzA4NDkwfQ._oyafbCtPm9kiKS6jEb9lZjiE11O7aNRh3Z4tJAnpM8'."
}

...

...

, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

...

• 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.

...

• HTTP Status Code 404 - Not Found

  Âncora
  status_code_404 status_code_404

...

...

05. LINKS

Âncora
links links