Histórico da Página

Neste exemplo, os 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.

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

• 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
  orderKey: A chave do pedido, que pode ser uma lista de identificadores
  • .

• 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

  items: Uma lista de itens relacionados ao pedido, onde cada item inclui:

  • id: O identificador do item.

  • status: O status atual do item, incluindo um código e uma descrição.

  • deliveryAgent: Informações sobre o agente de entrega, se aplicável.

  • deliveryDateTime: Data e hora de entrega, se aplicável.

  • cancellationReason: Motivo do cancelamento, se aplicável.

  • tableCardNumber: O número da mesa associada ao pedido.