Produtos

Properties

  • Name
    id
    Type
    string
    Description

    Identificador único do produto começa com prod_.

  • Name
    category
    Type
    string
    Description

    Categoria do produto, representada pelos seguintes valores:

    • business: Administração e Negócios
    • pets: Animais de Estimação
    • arts_music: Artes e Música
    • self_help: Auto-ajuda e Desenvolvimento Pessoal
    • automotive: Automóveis
    • blogs_social_media: Blogs e Redes Sociais
    • home_garden: Casa e Jardinagem
    • cooking_recipes: Culinária, Gastronomia, Receitas
    • design_templates: Design e Templates PSD, PPT ou HTML
    • media_editing: Edição de Áudio, Vídeo ou Imagens
    • education: Educacional, Cursos Técnicos e Profissionalizantes
    • appliances: Eletrodomésticos
    • electronics: Eletrônicos
    • portable_electronics: Eletroportáteis
    • entertainment: Entretenimento, Lazer e Diversão
    • sports_fitness: Esportes e Fitness
    • movies_cinema: Filmes e Cinema
    • general: Geral
    • comics: Histórias em Quadrinhos
    • languages: Idiomas
    • computing: Informática
    • internet_marketing: Internet Marketing
    • investments_finance: Investimentos e Finanças
    • card_games: Jogos de Cartas, Poker, Loterias
    • computer_games: Jogos de Computador, Jogos Online
    • legal: Jurídico
    • literature_poetry: Literatura e Poesia
    • network_marketing: Marketing de Rede
    • marketing_communication: Marketing e Comunicação
    • environment: Meio Ambiente
    • fashion: Moda e vestuário
    • furniture_decor: Móveis e decoração
    • music: Música, Bandas e Shows
    • dating_relationships: Paquera, Sedução e Relacionamentos
    • perfumery: Perfumaria
    • disability: Pessoas com deficiência
    • plugins_widgets_extensions: Plugins, Widgets e Extensões
    • productivity: Produtividade e Organização Pessoal
    • baby_products: Produtos infantis
    • reports_articles_research: Relatórios, Artigos e Pesquisas
    • religion_beliefs: Religião e Crenças
    • romance_drama_stories: Romances, Dramas, Estórias e Contos
    • rpg_tabletop_games: RPG e Jogos de Mesa
    • health_beauty: Saúde, Bem-estar e Beleza
    • scripts: Scripts
    • software: Software
    • occupational_safety: Segurança do Trabalho
    • sexology_sexuality: Sexologia e Sexualidade
    • video_snippets: Snippets (Trechos de Vídeo)
    • tourism: Turismo
  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp de quando o produto foi criado, em Unix Epoch.

  • Name
    updated_at
    Type
    timestamp
    Description

    Timestamp de quando o produto foi atualizado pela última vez, em Unix Epoch.

  • Name
    description
    Type
    string
    Description

    Descrição do produto. Exemplo: Produto mais vendido....

  • Name
    guarantee
    Type
    integer
    Description

    Período de garantia do produto, em dias.

  • Name
    image
    Type
    string
    Description

    URL da imagem do produto. Pode ser null se não houver.

  • Name
    name
    Type
    string
    Description

    Nome do produto. Exemplo: HITPAG.

  • Name
    producer_email
    Type
    string
    Description

    E-mail do produtor. Pode ser null se não informado.

  • Name
    producer_name
    Type
    string
    Description

    Nome do produtor. Pode ser null se não informado.

  • Name
    sales_page_url
    Type
    string
    Description

    URL da página de vendas. Exemplo: https://www.upag.io.

  • Name
    soft_descriptor
    Type
    string
    Description

    Descriptor da transação. Exemplo: HITPAG.

  • Name
    status
    Type
    'pending' | 'active' | 'rejected' | 'blocked'
    Description

    Status do produto, podendo ser:

    • pending: Pendente
    • active: Ativo
    • rejected: Rejeitado
    • blocked: Bloqueado
  • Name
    type
    Type
    'physical' | 'digital' | 'service'
    Description

    Tipo do produto, podendo ser:

    • physical: Produto físico
    • digital: Produto digital
    • service: Serviço
  • Name
    approved_at
    Type
    timestamp
    Description

    Timestamp de aprovação do produto, ou null se ainda não aprovado.


GET/api/v1/products

Listar todos os produtos

Retorna uma lista de todos os produtos cadastrados.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limita o número de produtos retornados.

  • Name
    page
    Type
    integer
    Description

    Número da página a ser retornada.

Request

GET
/api/v1/products
curl -G https://api.upag.io/api/v1/products \
  -H "Authorization: Bearer {token}" \
  -d page=1 \
  -d limit=10

Response

{
  "data": 
  [
      {
          "id": "prod_wJwZdpJaFUHEsXkC",
          "name": "HITPAG",
          "description": "Produto de teste",
          "image": null,
          "type": "digital",
          "status": "pending",
          "category": "business",
          "guarantee": 7,
          "soft_descriptor": "UPAG",
          "sales_page_url": "https://www.upag.io",
          "producer_name": null,
          "producer_email": null,
          "created_at": 1729031931000,
          "updated_at": 1729031931000,
          "approved_at": null
      },
  ],
  "count": 1
}

Esta página foi útil?