363946 – Inclusão de Descrições nos Campos de APIs do HubCitel (Versão 1.3.88)

Filtros


Tópicos

Objetivo da mudança:

O objetivo é adicionar descrições completas e claras aos campos das APIs, garantindo melhor entendimento e usabilidade pelos desenvolvedores que integram o sistema através do HubCitel. Isso facilitará a interpretação dos dados e reduzirá dúvidas durante a implementação e uso das APIs.

Instruções sobre o que configurar:

Não foi criada nenhuma configuração para essa alteração. 

Instruções sobre como utilizar:

  1. Acessar a documentação do HubCitel.
  2. Localizar a API desejada na seção correspondente.
  3. Consultar a descrição detalhada de cada campo no corpo da requisição ou resposta.
    • Exemplo para POST /api/public/v1/products/filter:
      • Campo: productId
        • Tipo: string
        • Descrição: Identificador único do produto na base de dados.
        • Exemplo: “12345”.
    • Repetir o mesmo para os demais campos das APIs listadas.
  4. Utilizar os exemplos fornecidos para estruturar suas requisições ou interpretar respostas.
Este artigo foi útil para você?
Pró
Não
Contra