Products

Catálogo: produtos.

get /v1/products — Listar produtos
post /v1/products — Criar produto
get /v1/products/{id} — Consultar produto
patch /v1/products/{id} — Atualizar a ficha do produto
get /v1/products/{id}/access-links — Listar links de acesso
post /v1/products/{id}/access-links — Adicionar link de acesso
delete /v1/products/{id}/access-links/{linkId} — Remover link de acesso
patch /v1/products/{id}/status — Mudar status do produto

get/v1/products

Listar produtos (listProducts)

Sem parâmetros de consulta a resposta é a lista completa legada ({data}); com qualquer parâmetro ela é paginada por cursor ({data, next_cursor}). Parâmetro desconhecido → 400 VALIDATION_FAILED.

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read
URL: https://api.v2.wolfpayteste.online/v1/products

Parâmetros

Nome	Onde	Tipo	Detalhes
`q`	consulta	string	1 a 120 caracteres
`status`	consulta	string	Valores: `draft`, `active`, `archived`
`limit`	consulta	integer	de 1 a 100 Padrão: `50`
`cursor`	consulta	string	Padrão `^c1_[0-9a-f]+$` até 2048 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

Resposta 200

Produtos. A página traz também offers_count, links_count (links ativos), bumps_count e revenue_30d_minor (bruto em BRL dos últimos 30 dias locais).

Um destes formatos:

SellerProductPage
object

Campo Tipo Detalhes

data obrigatório Product[]

Campo	Tipo	Detalhes
`data` obrigatório	Product[]

Exemplo de resposta 200 json

{
  "data": [
    {
      "id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
      "name": "Curso de fotografia",
      "status": "active",
      "created_at": "2026-11-06T12:00:00.000Z",
      "description": "Do básico à edição: 40 aulas gravadas e exercícios práticos.",
      "category": "design_fotografia",
      "sales_page_url": "https://example.com/curso-de-fotografia",
      "guarantee_days": 7,
      "support_name": "Equipe Estúdio Exemplo",
      "support_email": "suporte@example.com",
      "support_whatsapp": "+5511912345678",
      "statement_descriptor": "EXEMPLO FOTO",
      "offer_count": 1,
      "active_offer_count": 1,
      "offers_count": 1,
      "links_count": 1,
      "bumps_count": 0,
      "revenue_30d_minor": "29700"
    }
  ],
  "next_cursor": null
}

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/products

Criar produto (createProduct)

Cria um produto em draft. Repetir a requisição com a mesma Idempotency-Key e o mesmo corpo devolve a mesma resposta com idempotent-replayed: true; corpo diferente → 409 IDEMPOTENCY_CONFLICT.

Idempotency-Key obrigatória rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read,products:write
URL: https://api.v2.wolfpayteste.online/v1/products

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto CreateProductRequest

Corpo de createProduct
Campo	Tipo	Detalhes
`name` obrigatório	string	2 a 160 caracteres

Exemplo de corpo json

{
  "name": "Curso de fotografia"
}

Resposta 201

Produto criado.

Objeto Product

Resposta 201 de createProduct
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null

Exemplo de resposta 201 json

{
  "id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "name": "Curso de fotografia",
  "status": "draft",
  "created_at": "2026-11-06T12:00:00.000Z",
  "description": "Do básico à edição: 40 aulas gravadas e exercícios práticos.",
  "category": "design_fotografia",
  "sales_page_url": "https://example.com/curso-de-fotografia",
  "guarantee_days": 7,
  "support_name": "Equipe Estúdio Exemplo",
  "support_email": "suporte@example.com",
  "support_whatsapp": "+5511912345678",
  "statement_descriptor": "EXEMPLO FOTO"
}

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
409 — IDEMPOTENCY_CONFLICT,IDEMPOTENCY_IN_PROGRESS,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

get/v1/products/{id}

Consultar produto (getProduct)

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read
URL: https://api.v2.wolfpayteste.online/v1/products/{id}

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do produto (`prd_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do produto (prd_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Produto.

Objeto Product

Resposta 200 de getProduct
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null

Exemplo de resposta 200 json

{
  "id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "name": "Curso de fotografia",
  "status": "active",
  "created_at": "2026-11-06T12:00:00.000Z",
  "description": "Do básico à edição: 40 aulas gravadas e exercícios práticos.",
  "category": "design_fotografia",
  "sales_page_url": "https://example.com/curso-de-fotografia",
  "guarantee_days": 7,
  "support_name": "Equipe Estúdio Exemplo",
  "support_email": "suporte@example.com",
  "support_whatsapp": "+5511912345678",
  "statement_descriptor": "EXEMPLO FOTO"
}

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

patch/v1/products/{id}

Atualizar a ficha do produto (updateProduct)

Atualiza a ficha: description (texto simples, até 2.000 caracteres, sem HTML), category (lista fechada), sales_page_url (https), guarantee_days (garantia do produtor, 0 a 30 dias; não é garantia de pagamento), support_name, support_email, support_whatsapp (E.164, ex.: +5511912345678) e statement_descriptor (até 13 letras, números ou espaços; guardado, sem efeito no simulador). Envie só os campos a mudar; null limpa o campo. O checkout hospedado mostra descrição, suporte e garantia do produtor. Toda mudança é auditada.

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read,products:write
URL: https://api.v2.wolfpayteste.online/v1/products/{id}

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do produto (`prd_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do produto (prd_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto UpdateProductRequest

Corpo de updateProduct
Campo	Tipo	Detalhes
`description`	string \| null
`category`	string \| null
`sales_page_url`	string \| null
`guarantee_days`	integer	de 0 a 30
`support_name`	string \| null
`support_email`	string (e-mail) \| null
`support_whatsapp`	string \| null
`statement_descriptor`	string \| null

Exemplo de corpo json

{
  "description": "Do básico à edição: 40 aulas gravadas e exercícios práticos.",
  "category": "design_fotografia",
  "guarantee_days": 7,
  "support_email": "suporte@example.com",
  "support_whatsapp": "+5511912345678",
  "statement_descriptor": "EXEMPLO FOTO"
}

Resposta 200

Produto com a ficha atualizada.

Objeto Product

Resposta 200 de updateProduct
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null

Exemplo de resposta 200 json

{
  "id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "name": "Curso de fotografia",
  "status": "active",
  "created_at": "2026-11-06T12:00:00.000Z",
  "description": "Do básico à edição: 40 aulas gravadas e exercícios práticos.",
  "category": "design_fotografia",
  "sales_page_url": "https://example.com/curso-de-fotografia",
  "guarantee_days": 7,
  "support_name": "Equipe Estúdio Exemplo",
  "support_email": "suporte@example.com",
  "support_whatsapp": "+5511912345678",
  "statement_descriptor": "EXEMPLO FOTO"
}

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

get/v1/products/{id}/access-links

Listar links de acesso (listProductAccessLinks)

Links de entrega do produto (no máximo 5), na ordem do recibo. O comprador só os vê no recibo depois do pagamento aprovado.

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read
URL: https://api.v2.wolfpayteste.online/v1/products/{id}/access-links

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do produto (`prd_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do produto (prd_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Links de acesso.

Objeto ProductAccessLinkList

Resposta 200 de listProductAccessLinks
Campo	Tipo	Detalhes
`data` obrigatório	ProductAccessLink[]	0 a 5 itens

Exemplo de resposta 200 json

{
  "data": [
    {
      "id": "pal_4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d",
      "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
      "label": "Área de membros",
      "url": "https://membros.example.com/curso-de-fotografia",
      "host": "membros.example.com",
      "position": 0,
      "created_at": "2026-11-06T12:00:00.000Z"
    }
  ]
}

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/products/{id}/access-links

Adicionar link de acesso (createProductAccessLink)

Adiciona um link https (rótulo de até 80 caracteres) ao fim da lista; no máximo 5 por produto (409 PRODUCT_ACCESS_LINK_LIMIT_REACHED). O link aparece no recibo do checkout só depois do pagamento aprovado, com o domínio visível e sem redirecionamento automático. Repetir a requisição com a mesma Idempotency-Key e o mesmo corpo devolve a mesma resposta com idempotent-replayed: true; corpo diferente → 409 IDEMPOTENCY_CONFLICT.

Idempotency-Key obrigatória rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read,products:write
URL: https://api.v2.wolfpayteste.online/v1/products/{id}/access-links

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do produto (`prd_...`). mínimo 1 caractere(s)
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do produto (prd_...).

mínimo 1 caractere(s)

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto CreateProductAccessLinkRequest

Corpo de createProductAccessLink
Campo	Tipo	Detalhes
`label` obrigatório	string	1 a 80 caracteres
`url` obrigatório	string	9 a 2048 caracteres

Exemplo de corpo json

{
  "label": "Área de membros",
  "url": "https://membros.example.com/curso-de-fotografia"
}

Resposta 201

Link criado.

Objeto ProductAccessLink

Resposta 201 de createProductAccessLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^pal_[A-Za-z0-9]{1,64}$`
`product_id` obrigatório	string	Começa com `prd_`
`label` obrigatório	string
`url` obrigatório	string
`host` obrigatório	string
`position` obrigatório	integer	de 0 a 9007199254740991
`created_at` obrigatório	string

Exemplo de resposta 201 json

{
  "id": "pal_4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d",
  "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "label": "Área de membros",
  "url": "https://membros.example.com/curso-de-fotografia",
  "host": "membros.example.com",
  "position": 0,
  "created_at": "2026-11-06T12:00:00.000Z"
}

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — IDEMPOTENCY_CONFLICT,IDEMPOTENCY_IN_PROGRESS,PRODUCT_ACCESS_LINK_LIMIT_REACHED,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

delete/v1/products/{id}/access-links/{linkId}

Remover link de acesso (deleteProductAccessLink)

Remove o link da entrega (auditado); depois disso ele responde 404.

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read,products:write
URL: https://api.v2.wolfpayteste.online/v1/products/{id}/access-links/{linkId}

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do produto (`prd_...`). mínimo 1 caractere(s)
`linkId`obrigatório	caminho	string	Id do link de acesso (`pal_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do produto (prd_...).

mínimo 1 caractere(s)

linkIdobrigatório

caminho

string

Id do link de acesso (pal_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Link removido.

Objeto ProductAccessLink

Resposta 200 de deleteProductAccessLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^pal_[A-Za-z0-9]{1,64}$`
`product_id` obrigatório	string	Começa com `prd_`
`label` obrigatório	string
`url` obrigatório	string
`host` obrigatório	string
`position` obrigatório	integer	de 0 a 9007199254740991
`created_at` obrigatório	string

Exemplo de resposta 200 json

{
  "id": "pal_4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d",
  "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "label": "Área de membros",
  "url": "https://membros.example.com/curso-de-fotografia",
  "host": "membros.example.com",
  "position": 0,
  "created_at": "2026-11-06T12:00:00.000Z"
}

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

patch/v1/products/{id}/status

Mudar status do produto (setProductStatus)

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: products:read,products:write
URL: https://api.v2.wolfpayteste.online/v1/products/{id}/status

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do produto (`prd_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do produto (prd_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto CatalogStatusRequest

Corpo de setProductStatus
Campo	Tipo	Detalhes
`status` obrigatório	string	Valores: `draft`, `active`, `archived`

Exemplo de corpo json

{
  "status": "active"
}

Resposta 200

Produto atualizado.

Objeto Product

Resposta 200 de setProductStatus
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null

Exemplo de resposta 200 json

{
  "id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "name": "Curso de fotografia",
  "status": "active",
  "created_at": "2026-11-06T12:00:00.000Z",
  "description": "Do básico à edição: 40 aulas gravadas e exercícios práticos.",
  "category": "design_fotografia",
  "sales_page_url": "https://example.com/curso-de-fotografia",
  "guarantee_days": 7,
  "support_name": "Equipe Estúdio Exemplo",
  "support_email": "suporte@example.com",
  "support_whatsapp": "+5511912345678",
  "statement_descriptor": "EXEMPLO FOTO"
}

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — INVALID_STATE_TRANSITION,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR