GuiasReferência da APIWebhooksVoltar para a Dashboard
Ofertas

Listar ofertas de um produto

id precisa ser o id (uuid) de um produto da sua conta — produtos de outro whitelabel retornam 404.

Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.

GET
/offers/by-product/{id}

Authorization

AuthorizationBearer <token>

Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.

In: header

Path Parameters

idstring
Formatuuid

Query Parameters

page?integer

Número da página, começando em 1.

Default1
Range1 <= value
per_page?integer

Itens por página, de 1 a 100.

Default25
Range1 <= value <= 100
is_active?boolean

true lista só os ativos; false, só os inativos. Sem o filtro, lista os dois.

title?string

Título da oferta. Busca por parte do texto, sem diferenciar maiúsculas de minúsculas.

Length1 <= length <= 255

Response Body

curl -X GET "https://pagpolar-api.creativecode.dev.br/v1/offers/by-product/497f6eca-6276-4993-bfeb-53cbbbba6f08?page=1&per_page=25&is_active=true&title=string"
{
  "data": [
    {
      "id": "d5e6f7a8-b9c0-4d1e-2f3a-4b5c6d7e8f9a",
      "identifier": "PPP1234567890",
      "title": "Plano Mensal",
      "price": 197.9,
      "is_active": true,
      "requires_shipping": false,
      "is_default": false,
      "product_id": "c4d5e6f7-a8b9-4c0d-1e2f-3a4b5c6d7e8f",
      "payment_methods": {
        "pix": true,
        "credit_card": true,
        "billet": false
      },
      "max_credit_card_installments": 12,
      "cycle": "MONTHLY",
      "cycle_interval": 1,
      "cycle_interval_limit": 12,
      "allow_purchase_quantity": false,
      "purchase_quantity_limit": 10,
      "purchase_quantity_min": 1,
      "expires_at": null,
      "created_at": "2026-01-10T10:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 143,
    "total_pages": 6
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}

Consultar o frete de uma oferta GET

Devolve as opções de entrega de uma oferta de produto físico para um CEP. Use o `id` da opção escolhida em `shipping_option_id` na criação do pagamento. Pré-requisito, feito pelo vendedor no painel: a integração de logística cadastrada, as dimensões e o peso do produto preenchidos e pelo menos uma configuração de frete ativa. Sem configuração de frete, a consulta responde `400`. Oferta que não é de produto físico responde `200` com a lista vazia. Se a transportadora não responder, as opções de frete calculado ficam de fora e as opções grátis e de valor fixo continuam na lista.

Editar oferta PATCH

Edita campos comerciais de uma oferta já criada. Envie apenas os campos que deseja atualizar (edição parcial) — o corpo não pode vir vazio. Diferente da consulta (`GET /offers/{identifier}`, que usa o código da oferta, `PPP` seguido de 10 dígitos), esta rota identifica a oferta pelo `id` (uuid). Não é possível alterar `product_id`, `cycle`/`cycle_interval` (assinatura) ou `is_default` por aqui — a troca de oferta padrão continua sendo feita apenas pelo painel.