API atual/Referência completa/Planos de seller

Assinantes e atribuição

Lista os sellers de um plano e coloca um seller em um plano.

Cada seller está em um plano. Mudar o plano de um seller é uma decisão do administrador: a atribuição vale mesmo se o seller estiver acima do limite do novo plano, e a resposta traz o que foi excedido para você avisar o lojista.

Listar assinantes

GET/api/v1/admin/vendor-plans/{id}/subscribersAdmin

Lista assinantes de um plano

Parâmetros de caminho

idintegerobrigatório

Id numérico do plano.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/vendor-plans/8/subscribers" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Assinantes

json

{
  "subscribers": [
    {
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "name": "Loja Seller Teste",
      "email": "contato@lojaseller.example.com",
      "status": "A",
      "created_at": "2026-05-29 18:52:13.802087+00"
    }
  ],
  "total": 1
}

Campos da resposta

totalinteger

Quantidade.

subscribersarray

Sellers do plano.

subscribers[].vendor_iduuid

Seller.

subscribers[].namestring

Nome do seller.

subscribers[].emailstring

E-mail.

subscribers[].statusstring

Status do seller (A ativo...).

subscribers[].created_atstring

Cadastro, texto no formato do banco (2026-05-29 18:52:13.802087+00), não RFC 3339.

Erros

Status	Quando	Corpo de exemplo
400	`id` não numérico.	`{"error":"invalid plan ID"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_vendors` nem `view_vendors`.	`{"error":"insufficient privileges","privilege_required_any":["manage_vendors","view_vendors"]}`
403	O módulo `vendor-plans` está desligado na loja.	`{"error":"module_disabled","module":"vendor-plans"}`

Atribuir um plano

POST/api/v1/admin/vendor-plans/{id}/assignAdmin

Atribui um plano a um seller

Parâmetros de caminho

idintegerobrigatório

Id do plano que o seller vai receber.

Corpo da requisição

vendor_iduuidobrigatório

Seller que muda de plano.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/vendor-plans/8/assign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"
  }'

Resposta

200Plano atribuído

json

{
  "plan_id": 8,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "current_products": 946,
  "products_limit": 6000,
  "products_ok": true,
  "current_revenue_cents": 0,
  "revenue_limit_cents": 0,
  "revenue_ok": true,
  "available": true
}

Campos da resposta

current_productsinteger

Produtos do seller hoje.

products_okboolean

Dentro do limite de produtos.

current_revenue_centsinteger

Faturamento atual em centavos.

revenue_okboolean

Dentro do limite de faturamento.

availableboolean

Sempre true para o administrador.

assigned_over_limitboolean

true quando foi atribuído mesmo acima de um limite; errors diz qual.

errorsarray

Textos dos limites excedidos.

Erros

Status	Quando	Corpo de exemplo
400	`id` inválido, `vendor_id` ausente, plano inexistente ou plano desativado.	`{"error":"failed to assign plan","detail":"plan 8 is disabled"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_vendors`.	`{"error":"insufficient privileges","required":"manage_vendors"}`
403	O módulo `vendor-plans` está desligado na loja.	`{"error":"module_disabled","module":"vendor-plans"}`

Veja também

Planos de seller

API atual/Referência completa/Planos de seller

Assinantes e atribuição

Lista os sellers de um plano e coloca um seller em um plano.

Listar assinantes

GET/api/v1/admin/vendor-plans/{id}/subscribersAdmin

Lista assinantes de um plano

Parâmetros de caminho

idintegerobrigatório

Id numérico do plano.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/vendor-plans/8/subscribers" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Assinantes

json

{
  "subscribers": [
    {
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "name": "Loja Seller Teste",
      "email": "contato@lojaseller.example.com",
      "status": "A",
      "created_at": "2026-05-29 18:52:13.802087+00"
    }
  ],
  "total": 1
}

Campos da resposta

totalinteger

Quantidade.

subscribersarray

Sellers do plano.

subscribers[].vendor_iduuid

Seller.

subscribers[].namestring

Nome do seller.

subscribers[].emailstring

E-mail.

subscribers[].statusstring

Status do seller (A ativo...).

subscribers[].created_atstring

Cadastro, texto no formato do banco (2026-05-29 18:52:13.802087+00), não RFC 3339.

Erros

Status	Quando	Corpo de exemplo
400	`id` não numérico.	`{"error":"invalid plan ID"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_vendors` nem `view_vendors`.	`{"error":"insufficient privileges","privilege_required_any":["manage_vendors","view_vendors"]}`
403	O módulo `vendor-plans` está desligado na loja.	`{"error":"module_disabled","module":"vendor-plans"}`

Atribuir um plano

POST/api/v1/admin/vendor-plans/{id}/assignAdmin

Atribui um plano a um seller

Parâmetros de caminho

idintegerobrigatório

Id do plano que o seller vai receber.

Corpo da requisição

vendor_iduuidobrigatório

Seller que muda de plano.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/vendor-plans/8/assign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"
  }'

Resposta

200Plano atribuído

json

{
  "plan_id": 8,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "current_products": 946,
  "products_limit": 6000,
  "products_ok": true,
  "current_revenue_cents": 0,
  "revenue_limit_cents": 0,
  "revenue_ok": true,
  "available": true
}

Campos da resposta

current_productsinteger

Produtos do seller hoje.

products_okboolean

Dentro do limite de produtos.

current_revenue_centsinteger

Faturamento atual em centavos.

revenue_okboolean

Dentro do limite de faturamento.

availableboolean

Sempre true para o administrador.

assigned_over_limitboolean

true quando foi atribuído mesmo acima de um limite; errors diz qual.

errorsarray

Textos dos limites excedidos.

Erros

Status	Quando	Corpo de exemplo
400	`id` inválido, `vendor_id` ausente, plano inexistente ou plano desativado.	`{"error":"failed to assign plan","detail":"plan 8 is disabled"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_vendors`.	`{"error":"insufficient privileges","required":"manage_vendors"}`
403	O módulo `vendor-plans` está desligado na loja.	`{"error":"module_disabled","module":"vendor-plans"}`

Veja também

Planos de seller