Skip to main content
POST
Criar upsell

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Estrutura de dados para criação e atualização de um upsell.

active
boolean
required

Define se o upsell está ativo.

Example:

true

name
string
required

Nome do upsell.

Example:

"Combo Protetor + Película"

context
enum<string>
required

Momento em que a oferta é apresentada: before antes da conclusão do pedido, after logo após a conclusão e delayed por e-mail ou SMS depois da compra.

Available options:
before,
after,
delayed,
manual
Example:

"before"

suggested_product_id
integer
required

ID do produto sugerido na oferta. Precisa ser um produto da loja sem customização obrigatória, e pode ser o mesmo produto que dispara o upsell.

Example:

34025022

resource_type
enum<string>
required

Tipo de gatilho que faz a oferta aparecer, enviado em letras maiúsculas. ALWAYS exibe a oferta em qualquer pedido.

Available options:
ALWAYS,
PRODUCT,
CATEGORY,
BRAND
Example:

"PRODUCT"

description
string

Texto da oferta exibido ao cliente. Obrigatório quando context for after ou delayed.

Example:

"Aproveite e proteja seu smartphone com esse combo especial"

email_subject
string

Assunto do e-mail que leva a oferta ao cliente. Obrigatório quando context for delayed.

Example:

"Não perca essa oferta especial para seu produto!"

sms
string

Texto do SMS que leva a oferta ao cliente. Obrigatório quando context for delayed e a loja tiver SMS habilitado.

Example:

"Aproveite 20% OFF no combo protetor + película para seu smartphone! Clique aqui: {link}"

type
enum<string>

Tipo do item ofertado, sempre product.

Available options:
product
Example:

"product"

discount_type
enum<string>

Tipo de desconto aplicado ao preço do produto sugerido: percentage para percentual e fixed para valor em reais.

Available options:
percentage,
fixed
Example:

"percentage"

discount_amount
number<float>

Valor do desconto aplicado ao preço do produto sugerido, conforme discount_type.

Example:

20

product_price
number<float>

Preço do produto sugerido na oferta, em reais. Precisa ser maior que zero quando context for diferente de before.

Example:

40

product_quantity
integer

Quantidade do produto sugerido incluída na oferta.

Example:

2

trigger_resource_id
integer[]

IDs dos produtos, categorias ou marcas que disparam a oferta, conforme resource_type. Obrigatório quando resource_type for diferente de ALWAYS.

Example:

Response

Upsell criado com sucesso

data
Upsell de produtos · object[]

Dados do upsell criado.