Skip to main content
POST
Criar desconto

Autorizações

Authorization
string
header
obrigatório

Token de acesso opaco emitido pela API de autenticação (POST /authentication/v1/oauth/token).

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Id (UUID) da loja na plataforma. A loja precisa estar autorizada para o aplicativo.

Corpo

application/json
type
enum<string>

Tipo do desconto.

Opções disponíveis:
COUPON,
SMART
code
string

Código do cupom (COUPON).

name
string

Nome do desconto inteligente (SMART).

startsAt
string<date-time>

Início da vigência.

endsAt
string<date-time>

Fim da vigência (opcional).

rules
object
options
enum<string>[]

Opções do desconto.

Opções disponíveis:
CUMULATIVE_WITH_SMART,
NON_PROMOTION_PRODUCTS,
SUBSCRIBER

Resposta

Desconto criado.

id
string<uuid>
createdAt
string<date-time>
startsAt
string<date-time>
endsAt
string<date-time>

Omitido quando o desconto não tem fim de vigência.

type
enum<string>
Opções disponíveis:
COUPON,
SMART
code
string

Código do cupom. Presente apenas em COUPON.

name
string

Nome do desconto. Presente apenas em SMART.

status
enum<string>

Situação da vigência.

Opções disponíveis:
ACTIVE,
SCHEDULED,
OVERDUE
rules
object
options
enum<string>[]

Omitido quando não há opções.

Opções disponíveis:
CUMULATIVE_WITH_SMART,
NON_PROMOTION_PRODUCTS,
SUBSCRIBER