TOTVS Food Service

Páginas filhas
  • API Order Mesa - Status

Versões comparadas

Versão antiga 12

changes.mady.by.user Cristiano da Silva Ferreira Mothe

Gravado em

comparado com

Nova versão 13

changes.mady.by.user Cristiano da Silva Ferreira Mothe

Gravado em

Chave

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

...

Dica
titleDica

O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint GetOrderStatus.

Informações
titleNota:

Neste exemplo, os dados retornados incluem:

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


Dicionário de Requisição

Essa requisição permite verificar o o status atualizado do(s) pedido(s), retornando informações de acordo com o corpo da response obtida atráves do endpoint getStatus.

...

  • Detalhamento dos campos da requisição:
CampoValorDescrição
integrationHubServiceIdstringChave de identificação da integração no hub
successbooleanIndica se a operação foi bem-sucedida
trueA operação foi concluída com sucesso e o status dos pedidos será retornado
falseA operação falhou, com detalhes fornecidos no campo error
lastestUpdatedStatusstring (data e hora)Data e hora da última atualização do status dos pedidos
orderKeyarrayLista de identificadores dos pedidos (neste caso, o número da mesa)
orderKeyTypeenum "TABLE", "CARD", "ORDER_ID"Tipo de chave do pedido, que pode ser mesa, cartão ou ID do pedido
itemsarrayLista de itens associados ao pedido, detalhando o status de cada item


  • Itens associados detalhados:
CampoValorDescrição
idstringIdentificador do item dentro do pedido
statusobjetoObjeto contendo informações detalhadas sobre o status do item
status.codenumberCódigo representando o status atual do item
status.descriptionstringDescrição do status atual do item
deliveryAgentstringAgente responsável pela entrega (obrigatório para pedidos de entrega)
deliveryDateTimestring (data e hora)Data e hora em que a entrega foi realizada (obrigatório para pedidos de entrega)
cancellationReasonstringMotivo do cancelamento do item (se o item foi cancelado)


  • Erro (quando success é false):
CampoValorDescrição
codecódigo do erroIdentifica o tipo de erro ocorrido
messagemensagem descritivaDetalha a falha e fornece mais informações sobre o erro


...

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:

...