Páginas filhas
  • API Order Mesa - Status

Versões comparadas

Chave

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

...

  • 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:

...