API atual/Referência completa/Marketplace de módulos

Navegar o catálogo de módulos

Lista os módulos disponíveis com filtros, consulta o detalhe de um módulo, as categorias e os módulos já instalados na loja.

Quatro leituras para descobrir o que existe e o que a sua loja já usa. Todas exigem manage_modules ou manage_settings.

Listar o catálogo

Devolve os módulos ordenados por categoria e depois por nome, cada um com o estado de instalação na loja do token, a nota média e o número de avaliações.

GET/api/v1/admin/marketplace/modulesAdmin

Lista os módulos disponíveis para a loja

Parâmetros de consulta

categorystring

Só módulos desta categoria. Use os valores devolvidos pela rota de categorias (mais abaixo).

searchstring

Texto procurado no nome, na descrição e no slug, sem diferenciar maiúsculas.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora disso volta a 20.

installed_onlyboolean

Com true, devolve só os instalados, sem paginação (page e per_page são ignorados e category/search também).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/marketplace/modules?category=catalog&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Módulos

json

{
  "modules": [
    {
      "id": "be8a6c23-46c5-4a64-8729-a67357ecafca",
      "name": "Vendor KYC",
      "slug": "vendor-kyc",
      "version": "1.0.0",
      "description": "Know Your Customer verification for vendor onboarding. Documents + approvals managed on the vendor applications page.",
      "long_description": "",
      "author": "Venddor",
      "category": "general",
      "icon_url": "",
      "screenshots": [],
      "pricing_type": "free",
      "price_cents": 0,
      "changelog": [],
      "website_url": "",
      "support_url": "",
      "min_plan": "",
      "is_active": true,
      "config_schema": {
        "fields": [
          { "key": "expiry_days", "label": "Document Expiry (days)", "type": "number", "description": "Days until documents expire and need renewal" }
        ]
      },
      "dependencies": [],
      "extension_points": ["admin.sidebar.items"],
      "install_status": "not_installed",
      "avg_rating": 0,
      "review_count": 0,
      "created_at": "2026-03-14T07:36:51Z",
      "updated_at": "2026-03-14T07:36:51Z"
    }
  ],
  "total": 59,
  "page": 1,
  "per_page": 20
}

Campos da resposta

modulesarray

Módulos da página.

modules[].iduuid

Id do módulo no catálogo central. As outras rotas usam o slug.

modules[].slugstring

Identificador estável do módulo.

modules[].namestring

Nome para exibição.

modules[].versionstring

Versão do módulo.

modules[].descriptionstring

Resumo curto. O catálogo guarda os textos em inglês, e a API devolve como está.

modules[].long_descriptionstring

Descrição longa. Pode vir vazia.

modules[].authorstring

Autor. Padrão Venddor.

modules[].categorystring

Categoria do módulo.

modules[].pricing_typestring

freepremiumenterprise

Modelo de preço.

modules[].price_centsinteger

Preço em centavos inteiros. 0 nos gratuitos.

modules[].min_planstring

Plano mínimo da loja. Vazio quando não há exigência.

modules[].is_activeboolean

Se o módulo está ativo no catálogo.

modules[].config_schemaobject

Descrição dos campos de configuração do módulo.

modules[].dependenciesarray

Slugs de outros módulos necessários. Ligados junto na instalação.

modules[].install_statusstring

not_installedinstalled_enabledinstalled_disabled

Estado do módulo na loja do token.

modules[].avg_ratingnumber

Nota média de 1 a 5. 0 sem avaliações.

modules[].review_countinteger

Quantidade de avaliações.

totalinteger

Total que casa com o filtro, em todas as páginas.

pageinteger

Página devolvida.

per_pageinteger

Itens por página aplicados.

Detalhe de um módulo

Mesmo objeto da lista, para um único módulo.

GET/api/v1/admin/marketplace/modules/{slug}Admin

Consulta um módulo pelo slug

Parâmetros de caminho

slugstringobrigatório

Slug do módulo (por exemplo vendor-kyc).

Categorias

Devolve as categorias distintas dos módulos ativos, em ordem alfabética.

GET/api/v1/admin/marketplace/categoriesAdmin

Lista as categorias de módulos

200Categorias

json

{
  "categories": [
    "admin", "analytics", "catalog", "checkout", "commerce", "content", "erp_integrations",
    "general", "integrations", "marketing", "payments", "productivity", "sales",
    "sales_channels", "security", "shipping", "storefront"
  ],
  "total": 17
}

Módulos instalados

Devolve só os módulos instalados na loja, sem paginação.

GET/api/v1/admin/marketplace/installedAdmin

Lista os módulos instalados na loja

200Módulos instalados

json

{ "modules": [], "total": 0 }

Cada item tem os mesmos campos do catálogo. Os recursos nativos da plataforma e os conectores de canais de venda externos ficam fora desta lista, mesmo estando ligados.

Erros

Status	Quando	Corpo de exemplo
401	Sem token.	`{"error":"missing authorization header"}`
403	Sem `manage_modules` nem `manage_settings`.	`{"error":"..."}`
404	Slug não existe (detalhe).	`{"error":"module not found"}`
500	Falha ao consultar.	`{"error":"failed to list marketplace modules","detail":"..."}`

Veja também

Navegar o catálogo de módulos

Lista os módulos disponíveis com filtros, consulta o detalhe de um módulo, as categorias e os módulos já instalados na loja.

Quatro leituras para descobrir o que existe e o que a sua loja já usa. Todas exigem manage_modules ou manage_settings.

Listar o catálogo

Devolve os módulos ordenados por categoria e depois por nome, cada um com o estado de instalação na loja do token, a nota média e o número de avaliações.

GET/api/v1/admin/marketplace/modulesAdmin

Lista os módulos disponíveis para a loja

Parâmetros de consulta

categorystring

Só módulos desta categoria. Use os valores devolvidos pela rota de categorias (mais abaixo).

searchstring

Texto procurado no nome, na descrição e no slug, sem diferenciar maiúsculas.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora disso volta a 20.

installed_onlyboolean

Com true, devolve só os instalados, sem paginação (page e per_page são ignorados e category/search também).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/marketplace/modules?category=catalog&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Módulos

json

{
  "modules": [
    {
      "id": "be8a6c23-46c5-4a64-8729-a67357ecafca",
      "name": "Vendor KYC",
      "slug": "vendor-kyc",
      "version": "1.0.0",
      "description": "Know Your Customer verification for vendor onboarding. Documents + approvals managed on the vendor applications page.",
      "long_description": "",
      "author": "Venddor",
      "category": "general",
      "icon_url": "",
      "screenshots": [],
      "pricing_type": "free",
      "price_cents": 0,
      "changelog": [],
      "website_url": "",
      "support_url": "",
      "min_plan": "",
      "is_active": true,
      "config_schema": {
        "fields": [
          { "key": "expiry_days", "label": "Document Expiry (days)", "type": "number", "description": "Days until documents expire and need renewal" }
        ]
      },
      "dependencies": [],
      "extension_points": ["admin.sidebar.items"],
      "install_status": "not_installed",
      "avg_rating": 0,
      "review_count": 0,
      "created_at": "2026-03-14T07:36:51Z",
      "updated_at": "2026-03-14T07:36:51Z"
    }
  ],
  "total": 59,
  "page": 1,
  "per_page": 20
}

Campos da resposta

modulesarray

Módulos da página.

modules[].iduuid

Id do módulo no catálogo central. As outras rotas usam o slug.

modules[].slugstring

Identificador estável do módulo.

modules[].namestring

Nome para exibição.

modules[].versionstring

Versão do módulo.

modules[].descriptionstring

Resumo curto. O catálogo guarda os textos em inglês, e a API devolve como está.

modules[].long_descriptionstring

Descrição longa. Pode vir vazia.

modules[].authorstring

Autor. Padrão Venddor.

modules[].categorystring

Categoria do módulo.

modules[].pricing_typestring

freepremiumenterprise

Modelo de preço.

modules[].price_centsinteger

Preço em centavos inteiros. 0 nos gratuitos.

modules[].min_planstring

Plano mínimo da loja. Vazio quando não há exigência.

modules[].is_activeboolean

Se o módulo está ativo no catálogo.

modules[].config_schemaobject

Descrição dos campos de configuração do módulo.

modules[].dependenciesarray

Slugs de outros módulos necessários. Ligados junto na instalação.

modules[].install_statusstring

not_installedinstalled_enabledinstalled_disabled

Estado do módulo na loja do token.

modules[].avg_ratingnumber

Nota média de 1 a 5. 0 sem avaliações.

modules[].review_countinteger

Quantidade de avaliações.

totalinteger

Total que casa com o filtro, em todas as páginas.

pageinteger

Página devolvida.

per_pageinteger

Itens por página aplicados.

Detalhe de um módulo

Mesmo objeto da lista, para um único módulo.

GET/api/v1/admin/marketplace/modules/{slug}Admin

Consulta um módulo pelo slug

Parâmetros de caminho

slugstringobrigatório

Slug do módulo (por exemplo vendor-kyc).

Categorias

Devolve as categorias distintas dos módulos ativos, em ordem alfabética.

GET/api/v1/admin/marketplace/categoriesAdmin

Lista as categorias de módulos

200Categorias

json

{
  "categories": [
    "admin", "analytics", "catalog", "checkout", "commerce", "content", "erp_integrations",
    "general", "integrations", "marketing", "payments", "productivity", "sales",
    "sales_channels", "security", "shipping", "storefront"
  ],
  "total": 17
}

Módulos instalados

Devolve só os módulos instalados na loja, sem paginação.

GET/api/v1/admin/marketplace/installedAdmin

Lista os módulos instalados na loja

200Módulos instalados

json

{ "modules": [], "total": 0 }

Cada item tem os mesmos campos do catálogo. Os recursos nativos da plataforma e os conectores de canais de venda externos ficam fora desta lista, mesmo estando ligados.

Erros

Status	Quando	Corpo de exemplo
401	Sem token.	`{"error":"missing authorization header"}`
403	Sem `manage_modules` nem `manage_settings`.	`{"error":"..."}`
404	Slug não existe (detalhe).	`{"error":"module not found"}`
500	Falha ao consultar.	`{"error":"failed to list marketplace modules","detail":"..."}`