Pular para o conteúdo
Catálogo

Buscar item do catálogo por id

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/catalog/{id}
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcatalog.read

Devolve também item inativo (fora de venda) — o status diz.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho 1–80

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

O item do catálogo, com preço, condições, fotos e ficha técnica.

V1CatalogItem

  • idstring
  • typestring
    • um de"servico""produto"
  • namestring
  • categorystring | null
  • descriptionstring

  • Preço do item, por model: fixo/apartir (amountCents), faixa (minCents..maxCents), recorrente (amountCents por period, prazo em termMonths), sessao (amountCents por sessão), pacote (tiers) ou consulta (sem valor: preço sob consulta). Tudo em centavos de real.

    • modelstring
      • um de"fixo""apartir""faixa""recorrente""sessao""pacote""consulta"
    • amountCentsintegerpode faltar
    • minCentsintegerpode faltar
    • maxCentsintegerpode faltar
    • periodstringpode faltar
      • um de"mensal""trimestral""semestral""anual"
    • termMonthsinteger | nullpode faltar
    • sessionsinteger | nullpode faltar

    • Cada item da lista

      • labelstring
      • amountCentsinteger
      • onboolean
      • pctnumber
      • onboolean
      • ninteger
      • onboolean
      • valorCentsinteger
      • atestring | null
    • discountAuthorityPctnumberpode faltar
  • statusstring
    • um de"active""inactive"

  • Cada item da lista

    • urlstring
    • thumbUrlstring | null
  • customFieldsobjeto livre
    • chave string
    • valor qualquer valor JSON
  • updatedAtstring