YAyampi
Promoções - Upsells

Atualizar um upsell

Changed on

Atualizar um upsell

put/{alias}/pricing/upsells/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/pricing/upsells/{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 do upsell

Request body

activeboolean required

Define se o upsell está ativo.

namestring required

Nome do upsell.

descriptionstring

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

email_subjectstring

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

smsstring

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

type'product'

Tipo do item ofertado, sempre product.

context'before' | 'after' | 'delayed' | 'manual' 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.

discount_type'percentage' | 'fixed'

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

discount_amountnumber float

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

product_pricenumber float required

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

product_quantityinteger required

Quantidade do produto sugerido incluída na oferta.

suggested_product_idinteger 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.

resource_type'ALWAYS' | 'PRODUCT' | 'CATEGORY' | 'BRAND' required

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

trigger_resource_idinteger[]

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

Example request

{
  "active": true,
  "name": "Combo Protetor + Película",
  "description": "Aproveite e proteja seu smartphone com esse combo especial",
  "email_subject": "Não perca essa oferta especial para seu produto!",
  "sms": "Aproveite 20% OFF no combo protetor + película para seu smartphone! Clique aqui: {link}",
  "type": "product",
  "context": "before",
  "discount_type": "percentage",
  "discount_amount": 20,
  "product_price": 40,
  "product_quantity": 2,
  "suggested_product_id": 34025022,
  "resource_type": "PRODUCT",
  "trigger_resource_id": [
    42,
    51
  ]
}

Response

Upsell atualizado com sucesso

Changes

  • bbafb577e11cRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      removed the enum value always of the request property

    • breaking

      removed the enum value brand of the request property

    • breaking

      removed the enum value category of the request property

    • breaking

      removed the enum value product of the request property

    • info

      added the new ALWAYS enum value to the request property

    • info

      added the new BRAND enum value to the request property

    • info

      added the new CATEGORY enum value to the request property

    • info

      added the new PRODUCT enum value to the request property