Histórico da Página

...

...

03. EXEMPLO DE UTILIZAÇÃO

Âncora
utilizar utilizar

3.1 -Request - Corpo  Envio da requisição para consultar obter o cancelamento status de um pedido específico item cancelado no PDV: Essa requisição é enviada para verificar se os itens de um pedido cancelado em um PDV específico foram transmitidos com sucesso.
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 getCancelledItems, 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"
		}
	]
}

...

3.2. Request - Corpo da requisição 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. 

...

Dicionário de Request

Informações

...

Neste exemplo, os dados retornados incluem:

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

• Estrutura cancelledItems:

...

...

...

...

...

...

...

...

...

...

...

...

...

• id: Identificador do produto no lançamento
• index: Identificador do produto no lançamento
• name: O nome do item/produto.
• externalCode: O código do Produto no PDV integrado
• quantity: A quantidade do item cancelado.
• cancellationAgent: O operador 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

Dicionário de Retorno

...

• error: O erro é necessário quando o sucesso é falso. Deve retornar caso haja o seguinte:

...

• orderKeyType: Deve respeita a tabela abaixo:

...

• orderKey: É o identificador do pedido:

...

...

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:

...

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. JSON enviando faltando um ou mais camposIsso ocorre quando a estrutura JSON contém erros de sintaxe, como chaves ou colchetes incorretos.

{
	"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 . Formando inválido do JSON esperado- 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 corretamente

{
	"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": "ALBINO",
			"cancellationDateTime": "2024-07-17 16:04:27",
			"cancellationReason": " 55596;",
			"tableCardNumber": "23",
			"productionPoint": "NENHUM"
		}
	]
}

...