YAyampi
Promoções - Produtos

Criar promoção

Cria uma nova promoção

post/{alias}/pricing/promotions

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/pricing/promotions
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

activeboolean required

Status da promoção

all_productsboolean required

Aplicar em todos os produtos

utm_onlyboolean required

Exclusivo para UTM

highlight_on_menuboolean

Destacar no menu

accumulateboolean

Permite acumular com outras promoções

price_attribute'price_sale' | 'price_discount' required

Atributo de preço para aplicar desconto

namestring required

Nome da promoção

valuenumber float required

Valor do desconto

utm_sourcestring

Origem UTM

utm_campaignstring

Campanha UTM

start_atstring date-time required

Data e hora de início

end_atstring date-time required

Data e hora de término

collections_idsinteger[]

IDs das coleções

brands_idsinteger[]

IDs das marcas

categories_idsinteger[]

IDs das categorias

banners_idsinteger[]

IDs dos banners

Example request

{
  "active": true,
  "all_products": true,
  "utm_only": true,
  "highlight_on_menu": true,
  "accumulate": true,
  "price_attribute": "price_discount",
  "name": "Black Friday 2025",
  "value": 123,
  "utm_source": "google",
  "utm_campaign": "black_friday",
  "start_at": "2025-11-25 00:00:00",
  "end_at": "2025-11-30 23:59:59",
  "collections_ids": [
    1,
    2
  ],
  "brands_ids": [
    1,
    2
  ],
  "categories_ids": [
    1,
    2
  ],
  "banners_ids": [
    1,
    2
  ]
}

Response

Promoção criada com sucesso

idinteger

ID da promoção.

activeboolean

Indica se a promoção está ativa.

all_productsboolean

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

utm_onlyboolean

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

highlight_on_menuboolean

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

accumulateboolean

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

price_attributestring

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

namestring

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

expiredboolean

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

urlstring uri

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

slugstring

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

valuenumber float

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

utm_sourcestring

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

utm_campaignstring

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

Example response

{
  "name": "Promoção relâmpago",
  "url": "https://www.domain.com/promocoes/test",
  "utm_source": "google",
  "utm_campaign": "adwords"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.