Skip to main content
GET
Consulta um cupom com o status de sincronização no provedor

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

couponId
string
required
Pattern: ^coup_[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

Default Response

id
string
required

Identificador único do cupom (prefixo coup_).

Example:

"coup_01J9ZQ8H6K3M2N4P5R6S7T8U9V"

organizationId
string
required

Organização dona do cupom.

Example:

"org_01J9ZQ8H6K3M2N4P5R6S7T8U9V"

programId
string
required

Programa ao qual o cupom pertence.

Example:

"prog_01J9ZQ8H6K3M2N4P5R6S7T8U9V"

affiliateId
string
required

Afiliado dono do cupom.

Example:

"aff_01J9ZQ8H6K3M2N4P5R6S7T8U9V"

code
string
required

Código do cupom, normalizado em maiúsculas.

Example:

"MARIA15"

discountType
enum<string>
required

Tipo de desconto. percentage: percentual sobre a compra. fixed: valor fixo em centavos.

Available options:
percentage,
fixed
Example:

"percentage"

discountValue
number
required

Valor do desconto. Para percentage, é o percentual (ex.: 15 = 15%). Para fixed, é o valor fixo em centavos (ex.: 1990 = R$19,90).

Example:

15

status
enum<string>
required

Status do cupom. pending: criado, aguardando sincronização com o provedor de pagamento. active: sincronizado e válido para uso. sync_failed: a sincronização com o provedor de pagamento falhou (tente novamente com a operação de ressincronização). inactive: desativado, não gera mais descontos.

Available options:
pending,
active,
sync_failed,
inactive
Example:

"active"

providerSync
object | null
required

Status da sincronização com o provedor de pagamento. null enquanto a sincronização ainda não foi tentada.

deactivatedAt
string<date-time> | null
required

Data/hora em que o cupom foi desativado. null se estiver ativo.

Example:

"2026-06-13T12:00:00.000Z"

createdAt
string<date-time>
required

Data/hora de criação do cupom (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

updatedAt
string<date-time>
required

Data/hora da última atualização do cupom (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"