Histórico da Página

...

02. ENDPOINT

Âncora
endpoint endpoint

...

03. EXEMPLO DE UTILIZAÇÃO

Âncora
utilizar utilizar

013.1 - Request - Enviando o pedido para requisição do a solicitação para o cancelamento de um pedido especifico: Âncoratodos_statustodos_statusespecífico: Ao fazer essa requisição, o sistema processa a solicitação de cancelamento do pedido indicado.

{
  "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType": "TABLE",
  "orderKey": ["22"]
}

...

3.2 - Request - Ao reenviar a solicitação, a resposta retornada será a seguinte: Após reenviar a requisição, você receberá uma resposta detalhando o status atualizado do processamento do pedido.

{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order cancelled itens request already exists: TABLE_22"
		}
	]
}

...

3.3 - Request - Ao enviar novamente a solicitação, o processamento será realizado conforme a seguinte resposta: Reenviando a requisição, o sistema processará o pedido e retornará uma resposta que reflete o status do processamento realizado.

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "TABLE",
	"orderKey": ["22"],
	"lastestUpdatedStatus": "2024-07-17 14:21:24",
	"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"
		}
	]
}

...

...

Dicionário da Requisição:

• orderKeyType: Deve respeita a tabela abaixo:

...

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.

014.1. Formando inválido do JSON esperado.

...

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

...

024.2. JSON enviando faltando um ou mais campos.

...

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

...

034.3. GUID incorreto 

{
    "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

...

044.4. Enviando uma requisição sem informar o código da orderKey corretamente

...