Criar produto e oferta

Crie o produto

Envie o nome do produto. A descrição é opcional.

curl -X POST "https://api.pagpolar.com/v1/products" \
  -H "Authorization: Bearer <SEU_TOKEN_DE_ACESSO>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Curso de fotografia",
    "description": "Curso online com 20 aulas"
  }'

const response = await fetch('https://api.pagpolar.com/v1/products', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${accessToken}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Curso de fotografia',
    description: 'Curso online com 20 aulas',
  }),
});

console.log(response.status, await response.json());

A rota aceita só esses dois campos. Qualquer outro campo responde 400.

Resposta 201 (resumida):

{
  "data": {
    "id": "c4d5e6f7-a8b9-4c0d-8e2f-3a4b5c6d7e8f",
    "name": "Curso de fotografia",
    "description": "Curso online com 20 aulas",
    "type": "DIGITAL",
    "is_active": true,
    "warranty_time": 7
  }
}

O que a API faz por você:

• O produto nasce digital (type: DIGITAL) e ativo (is_active: true).
• warranty_time é o prazo de garantia em dias. Vem da configuração da plataforma. Sem configuração, vale 7.

Guarde data.id. Ele é o <ID_DO_PRODUTO> do próximo passo. Contrato completo: POST /products.

Crie a oferta

A oferta define o preço, os meios de pagamento e o máximo de parcelas no cartão.

price vai em centavos, como número inteiro (9700 = R$ 97,00), e volta em reais na resposta (97). Veja Valores nas respostas.

curl -X POST "https://api.pagpolar.com/v1/offers" \
  -H "Authorization: Bearer <SEU_TOKEN_DE_ACESSO>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "<ID_DO_PRODUTO>",
    "title": "Oferta principal",
    "price": 9700,
    "is_enabled_pix": true,
    "is_enabled_billet": true,
    "is_enabled_credit_card": true,
    "max_credit_card_installments": 12
  }'

const response = await fetch('https://api.pagpolar.com/v1/offers', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${accessToken}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    product_id: '<ID_DO_PRODUTO>',
    title: 'Oferta principal',
    price: 9700,
    is_enabled_pix: true,
    is_enabled_billet: true,
    is_enabled_credit_card: true,
    max_credit_card_installments: 12,
  }),
});

console.log(response.status, await response.json());

Meios de pagamento e valor mínimo

Os três meios de pagamento começam ligados. Cada um tem um valor mínimo, conferido ao salvar a oferta:

• Abaixo do mínimo, a API desliga o meio, mesmo que você envie true.
• A partir do mínimo, o meio fica ligado, a não ser que você envie false.
• A resposta mostra o resultado em payment_methods (pix, credit_card e billet). Confira sempre.

Exemplos, com max_credit_card_installments: 1 e sem enviar is_enabled_*:

Ao editar a oferta com PATCH /offers/{id}, a regra roda de novo:

A regra da parcela mínima

A API converte price para reais, dividindo por 100, e divide o resultado por max_credit_card_installments. O que sobra é o valor de cada parcela. Por padrão, cada parcela precisa valer pelo menos R$ 5,00.

Ao contrário do valor mínimo do meio, que só desliga o meio, a parcela mínima recusa a oferta: abaixo dela, a resposta é 400, e a mensagem mostra o valor da parcela e o mínimo em vigor. A regra roda ao criar e ao editar a oferta, mesmo com o cartão desligado.

Sem max_credit_card_installments, a conta usa 12 parcelas: todo price abaixo de 6000 recusa a criação. Para uma oferta barata, envie max_credit_card_installments: 1. Mesmo assim, um price abaixo de 500 não passa.

Resposta 201 (resumida):

{
  "data": {
    "id": "d5e6f7a8-b9c0-4d1e-8f3a-4b5c6d7e8f9a",
    "identifier": "PPP1234567890",
    "title": "Oferta principal",
    "price": 97,
    "is_active": true,
    "product_id": "c4d5e6f7-a8b9-4c0d-8e2f-3a4b5c6d7e8f",
    "payment_methods": {
      "pix": true,
      "credit_card": true,
      "billet": true
    },
    "max_credit_card_installments": 12
  }
}

Contrato completo: POST /offers.

Consulte a oferta

Antes de vender, confira se a oferta está como você espera. Envie o código da oferta ou o id.

curl "https://api.pagpolar.com/v1/offers/<CODIGO_DA_OFERTA>" \
  -H "Authorization: Bearer <SEU_TOKEN_DE_ACESSO>"

const response = await fetch('https://api.pagpolar.com/v1/offers/<CODIGO_DA_OFERTA>', {
  headers: { Authorization: `Bearer ${accessToken}` },
});

console.log(response.status, await response.json());

O caminho aceita três formatos:

A resposta 200 traz os mesmos campos da criação.

Confira três coisas antes de vender:

Contrato completo: GET /offers/{identifier}. Para ver todas as ofertas de um produto, use GET /offers/by-product/{id}.