YAyampi
Promoções - Produtos

Atualizar promoção

Atualiza os detalhes de uma promoção específica

put/{alias}/pricing/promotions/{id}

Request

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

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da promoção

Request body

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 request

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

Response

Detalhes da promoção

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.

include_idsinteger[]

IDs dos produtos alcançados pelas regras de inclusão, já expandindo marcas, coleções e categorias

exclude_idsinteger[]

IDs dos produtos alcançados pelas regras de exclusão, já expandindo marcas, coleções e categorias

Example response

{
  "name": "Promoção relâmpago",
  "url": "https://www.domain.com/promocoes/test",
  "utm_source": "google",
  "utm_campaign": "adwords",
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes

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