Criar Cupom

POST /api/v1/coupon

Criar Cupom

cURL

curl --request POST \
  --url https://api.selltrust.com.br/api/v1/coupon \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "discount_type": "<string>",
  "discount_value": 123,
  "min_order_value": 123,
  "max_uses": 123,
  "expires_at": "<string>",
  "active": true,
  "product_ids": [
    {}
  ]
}
'

Response

{
  "id": "uuid-do-cupom",
  "store_id": "uuid-da-loja",
  "code": "PROMO10",
  "discount_type": "PERCENTAGE",
  "discount_value": 10,
  "min_order_value": null,
  "max_uses": null,
  "used_count": 0,
  "expires_at": null,
  "active": true,
  "product_ids": [],
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z"
}

Gera um código promocional. Pode ser de desconto fixo (FIXED) ou porcentagem (PERCENTAGE).

Authorization · string · required

Token de acesso no formato Bearer <seu_token>.

code · string · required

Código do cupom (mínimo de 3 caracteres).

discount_type · string · required

Tipo de desconto: PERCENTAGE ou FIXED.

discount_value · number · required

Valor do desconto. Ex: 10 para 10% ou R$10.

min_order_value · number

Valor mínimo do pedido para aplicar o cupom.

max_uses · number

Limite máximo de usos do cupom.

expires_at · string

Data de expiração no formato ISO 8601.

active · boolean · required

Status de ativação do cupom.

product_ids · array · required

Lista de IDs (UUID) de produtos válidos para o cupom. Array vazio aplica a todos.

Response

{
  "id": "uuid-do-cupom",
  "store_id": "uuid-da-loja",
  "code": "PROMO10",
  "discount_type": "PERCENTAGE",
  "discount_value": 10,
  "min_order_value": null,
  "max_uses": null,
  "used_count": 0,
  "expires_at": null,
  "active": true,
  "product_ids": [],
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z"
}