Skip to main content
GET
Visualizar promoção

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID da promoção

Response

Detalhes da promoção

Recursos adicionais da promoção, retornados sob demanda via parâmetro include.

id
integer

ID da promoção.

active
boolean

Indica se a promoção está ativa.

all_products
boolean

Indica se a promoção vale para todo o catálogo; quando falso, valem as coleções, marcas e produtos vinculados a ela.

utm_only
boolean

Indica se a promoção só é aplicada quando o acesso vier com os parâmetros utm_source e utm_campaign cadastrados nela.

highlight_on_menu
boolean

Indica se a promoção é destacada no menu da loja.

accumulate
boolean

Indica se a promoção pode ser acumulada com outros descontos.

price_attribute
string

Preço do SKU usado como base do desconto: price_sale (preço de venda) ou price_discount (preço promocional).

name
string

Nome da promoção, único dentro da loja.

Example:

"Promoção relâmpago"

expired
boolean
read-only

Indica se a data de término da promoção já passou.

url
string<uri>

URL da página da promoção na loja; inclui os parâmetros UTM quando utm_only for verdadeiro.

Example:

"https://www.domain.com/promocoes/test"

slug
string

Slug da promoção, usado na composição da URL.

value
number<float>

Percentual de desconto aplicado sobre o preço definido em price_attribute.

utm_source
string

Valor de utm_source que ativa a promoção, obrigatório quando utm_only for verdadeiro.

Example:

"google"

utm_campaign
string

Valor de utm_campaign que ativa a promoção, obrigatório quando utm_only for verdadeiro.

Example:

"adwords"

start_at
object
end_at
object
created_at
object
updated_at
object