Páginas filhas
  • API Order Mesa - Get Status

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

3.2 - Request - Ao reenviar a solicitação, a resposta será a seguinte:

Ao reenviar a requisição, você receberá uma resposta contendo o status atualizado e os detalhes do pedido.

Bloco de código
titleJSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_40"
		}
	]
}  
 

...

3.8 - Request - Ao reenviar a solicitação, a resposta será a seguinte:

Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código
titleJSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_"
		}
	]
}  
 

...

Nota
titleNota: HTTP Status Code = 226 IM Used

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.

Informações
titleInformações dos campos:

Os dados retornados pela resposta incluem:

  • integrationHubServiceId: Chave de identificação de integração, utilizada para identificar de forma única a integração no hub.

  • success: Indica se a operação foi bem-sucedida. Este campo é um valor booleano:

    • true: A operação foi concluída com sucesso e os detalhes do pedido estarão disponíveis no campo items.
    • false: A operação falhou, e os detalhes do erro serão fornecidos no campo error.
  • lastestUpdatedStatus: A data e hora da última atualização do status do pedido, representada como uma string.

  • orderKey: Identificador do pedido, conforme definido pelo tipo de chave em orderKeyType.

  • orderKeyType: Tipo da chave do pedido, que pode ser um dos seguintes valores:

    • TABLE: Representa um número de mesa.
    • CARD: Representa um cartão.
    • ORDER_ID: Representa um identificador único do pedido.

    Enum: [TABLE, CARD, ORDER_ID]

  • items: Uma lista de itens relacionados ao pedido, contendo os detalhes sobre o status de cada item. Cada item inclui as seguintes informações:

    • id: Identificador do item dentro do pedido.
    • status: O status atual do item (informações detalhadas estão contidas no objeto Status).
    • deliveryAgent: O agente responsável pela entrega. Este campo é obrigatório se o pedido for do tipo delivery.
    • deliveryDateTime: A data e hora em que a entrega foi realizada. Este campo é obrigatório se o pedido for do tipo delivery.
    • cancellationReason: O motivo do cancelamento do item ou do pedido. Este campo é obrigatório quando o pedido ou o item foi cancelado.
  • error: Este campo é obrigatório quando success é false e contém detalhes sobre o erro ocorrido:

    • code: Código do erro, que identifica o tipo de falha.
    • message: Mensagem descritiva que fornece mais detalhes sobre o erro.

Dicionário de Retorno

...


...


Dicionário de Requisição


Essa requisição permite consultar o status atualizado de um pedido, retornando informações detalhadas sobre cada item associado ao pedido e possíveis erros ocorridos durante o processo. A integração é identificada de forma única através da integrationHubServiceId


  • Detalhamento dos campos da requisição:
CampoValorDescrição
integrationHubServiceId *stringChave de identificação da integração no hub
orderKeyTypeenum Tipo de chave do pedido, que pode ser mesa, cartão ou ID do pedido
orderKeystringIdentificador do pedido, de acordo com o tipo definido em orderKeyType


  • Enumerações do campo orderKeyType:
EnumValorDescrição
TABLETABLEIdentifica o pedido pelo número da mesa
CARDCARDIdentifica o pedido pelo número do cartão
ORDER_IDORDER_IDIdentifica o pedido por um ID exclusivo do pedido
Dica
titleCampos obrigatórios

Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório


...

04. ERROS
Âncora
erros
erros

...

  • Detalhamento dos campos da lista de itens:

...

  • Detalhamento do campo error (quando success é false):

...

  • Valores possíveis para orderKeyType:

...

Quando a requisição for reenviada, o sistema processará a solicitação e retornará uma resposta com o status atualizado, juntamente com os detalhes de cada pedido solicitado. Isso garante que qualquer modificação ou atualização recente seja refletida na resposta.


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

Bloco de código
titleJSON Inválido
linenumberstrue
{
    "integrationHubServiceId": "393d9572-2ec9-4cda-9ad3-5b69e02c988d",
	  "orderKeyType": "string",
	   "orderKey": ["string"]
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}]
}


...


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

Se a requisição estiver 4.2 - JSON enviando 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.

Bloco de código
titleJSON Inválido
linenumberstrue
{
    "integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType is required"
		},
		{
			"key": "orderKey",
			"message": "body.orderKey is required"
		}
	]
}


...


4.3 - GUID incorreto:

O GUID (Identificador Globalmente Único) enviado na requisição está incorreto ou malformado, o que pode resultar em um erro. Um GUID é uma sequência específica que deve seguir o padrão correto.4.3 - GUID incorreto 

Bloco de código
titleJSON com o GUID inválido
linenumberstrue
{
    "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}
Bloco de código
titleJSON Inválido GUID incorreto
linenumberstrue
{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}


...


4.4 - Enviando uma requisição sem informar o código da orderKey corretamente Requisição enviada sem informar o orderKey corretamente:

Caso a requisição seja enviada sem o campo orderKey ou com o valor incorreto, o sistema não conseguirá identificar o pedido, resultando em um erro 400. O orderKey deve estar corretamente preenchido e de acordo com o orderKeyType informado.

Bloco de código
titleJSON com sem informar o código da orderKey
linenumberstrue
{
    "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
	  "orderKeyType": "TABLE",
	  "orderKey": [""]
}

...