Listar filtros de vendas
Lista os filtros e valores aceitos na listagem de vendas. O campo `campaign` sempre vem vazio: para filtrar por campanha, use os nomes de **Listar campanhas**.
Autorização
apiToken Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.
Local: header
Corpo da Resposta
application/json
application/json
curl -X GET "https://example.com/sales/available-filters"{ "content": { "status": [ "made_effective", "not_logged" ], "origin": [ "CAMPAIGN", "PROVI_PAY" ], "courses": [ { "id": 123, "name": "courseName" } ], "productType": [ "CourseFinancing", "MAAS", "CreditCard", "Boleto", "ProviPay" ], "creator": [ "seler@domain.com" ], "campaign": [] }}Consultar vendas pelo externalSaleId
Consulta vendas pelo ID do seu sistema (`externalSaleId`). Como o mesmo ID pode estar em mais de uma venda, a resposta é uma lista de até 50 vendas (as 50 criadas mais recentemente), sem garantia de ordem entre os itens. Nenhuma venda com esse ID responde 400 com `SALE-001` e mensagem `Sale not found`. Atenção: na resposta os produtos vêm com `productSKU` e `variantSKU` (SKU em maiúsculo), diferente do corpo de criação.
Criar venda exclusiva
Cria uma venda exclusiva para um CPF a partir de cursos e turmas já cadastrados (IDs do PrincipiaPay). Obrigatórios: `cpf`, `checkout_price_in_cents` e `courses` (cada item com `id` e `courseClassId`, uma turma por curso). Com `campaign_id`, preço, cursos e prazos vêm da campanha e `courses` e `checkout_price_in_cents` deixam de ser obrigatórios. O preço total deve ser menor ou igual à soma dos preços das turmas. A entrada, se informada, precisa ser menor que o preço e não pode ser menor que a entrada padrão do curso (ou do parceiro, se o curso não tiver). Com mais de um curso, vale a maior entrada. Para novas integrações, prefira **Criar checkout (venda)**, que cadastra produtos e variações pelos seus SKUs.