Skip to main content
POST
/
products
/
create
Criar um produto
curl --request POST \
  --url https://api.abacatepay.com/v2/products/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "prod-123",
  "name": "Produto Exemplo",
  "price": 10000,
  "currency": "BRL"
}
'
{
  "data": {
    "externalId": "prod-123",
    "name": "Produto Exemplo",
    "description": "Descrição do produto",
    "price": 10000,
    "devMode": false,
    "currency": "BRL",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "status": "ACTIVE",
    "id": "prod_abc123xyz",
    "imageUrl": null,
    "cycle": null
  },
  "error": null,
  "success": true
}

Requer a permissão PRODUCT:CREATE.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json

Dados necessários para criar um produto.

​
externalId
string
required

Identificador único do produto no seu sistema.

Example:

"prod-123"

​
name
string
required

Nome do produto.

Example:

"Produto Exemplo"

​
price
number
required

Preço do produto em centavos.

Required range: x >= 1
Example:

10000

​
currency
string
default:BRL
required

Moeda do produto.

Example:

"BRL"

​
description
string

Descrição opcional do produto.

Example:

"Descrição do produto"

​
imageUrl
string<uri> | null

URL da imagem do produto. Opcional.

Example:

null

​
cycle
enum<string> | null

Opcional. Indica se o produto é uma assinatura. Quando omitido ou null, o produto é avulso (pagamento único). Valores possíveis: WEEKLY, MONTHLY, SEMIANNUALLY, ANNUALLY.

Available options:
WEEKLY,
MONTHLY,
SEMIANNUALLY,
ANNUALLY
Example:

null

Response

Produto criado com sucesso.

​
data
object

Os dados do seu produto. O campo cycle indica se o produto é uma assinatura (subscription). Quando null, o produto é avulso (pagamento único). Valores possíveis definem a recorrência da assinatura. A moeda (currency) é sempre BRL.

​
error
string | null
Example:

null

​
success
boolean

Se a requisição obteve sucesso ou não.

Example:

true