Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

Token de API gerado no painel da CentralCart.

Corpo

application/json
name
string
obrigatório

Nome da promoção, até 35 caracteres

type
enum<string>
obrigatório

PROGRESSIVE dá desconto maior conforme o carrinho cresce. BUY_X_PAY_Y dá desconto em produtos escolhidos ao atingir o mínimo

Opções disponíveis:
PROGRESSIVE,
BUY_X_PAY_Y
condition_mode
enum<string>
obrigatório

Se o mínimo das faixas é em unidades ou em valor (R$)

Opções disponíveis:
QUANTITY,
VALUE
starts_at
string
obrigatório

Início da promoção

targets
object[]
obrigatório

Produtos que contam para atingir o mínimo, de 1 a 10 alvos

tiers
object[]
obrigatório

Faixas, de 1 a 10, cada uma com um mínimo diferente. O BUY_X_PAY_Y aceita uma faixa só

enabled
boolean

Ativa a promoção. Padrão true na criação; na atualização mantém o estado atual

ends_at
string | null

Fim da promoção. Omita ou envie null para não expirar

Resposta

Promoção criada.

id
number

ID da promoção

store_id
number

ID da loja

name
string

Nome da promoção

type
enum<string>

Tipo da promoção

Opções disponíveis:
PROGRESSIVE,
BUY_X_PAY_Y
condition_mode
enum<string>

Se o mínimo das faixas é em unidades ou em valor (R$)

Opções disponíveis:
QUANTITY,
VALUE
enabled
boolean

Indica se a promoção está ativada

starts_at
string

Início da promoção

ends_at
string | null

Fim da promoção. null não expira

created_at
string

Data de criação

updated_at
string

Data da última atualização

targets
object[]

Produtos que contam para atingir o mínimo

tiers
object[]

Faixas, do menor para o maior mínimo