YAyampi
Promoções - Order Bump

Criar Order Bump

Changed on

Cria um novo Order Bump

post/{alias}/pricing/order-bumps

Request

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

Path parameters

aliasstring required

Alias da loja

Request body

namestring required

Nome do Order Bump. Deve ser único na loja.

activeboolean required

Define se o Order Bump está ativo e pode ser exibido no checkout.

is_iaboolean

Define se o Order Bump é gerado por IA

pre_select_variationboolean

Se a variação deve ser pré-selecionada

resource_type'sku' | 'product' required

Tipo do item oferecido

resource_idinteger required

ID do produto ou SKU oferecido

price_salenumber float required

Preço de tabela do item na oferta, em reais.

price_discountnumber float nullable

Preço promocional do item na oferta, em reais. É um preço final, não um valor de desconto.

accepted_payment'all' | 'deposit' | 'billet' | 'credit_card' | 'pix' | 'pix_in_installments' | 'wallet' required

Método de pagamento aceito para exibir a oferta

display_rule'always' | 'products_amount' | 'selected_products' required

Regra de exibição da oferta

amount_rulestring nullable

Comparação aplicada ao valor dos produtos do carrinho: greater_than ou lower_than. Obrigatório quando display_rule for products_amount.

amount_valuenumber float nullable

Valor de referência, em reais, comparado ao total dos produtos do carrinho conforme amount_rule. Obrigatório quando display_rule for products_amount.

display_product_idsinteger[] nullable

Lista de produtos exibidos no OrderBump

displayed_quantityinteger required

Quantidade de produtos exibidos no OrderBump

Example request

{
  "name": "Oferta especial de camiseta",
  "active": true,
  "pre_select_variation": true,
  "resource_type": "product",
  "resource_id": 42533439,
  "price_sale": 50,
  "params": {
    "button_text": "+ Adicionar oferta"
  },
  "accepted_payment": "all",
  "display_rule": "always",
  "amount_rule": "greater_than",
  "amount_value": 100,
  "display_product_ids": [
    12345
  ],
  "displayed_quantity": 1,
  "restrictions": {
    "exclude": {
      "products_ids": [
        12345
      ],
      "collections_ids": [
        321
      ],
      "categories_ids": [
        654
      ],
      "brands_ids": [
        987
      ]
    }
  }
}

Response

Order Bump criado com sucesso

idinteger

ID do Order Bump.

activeboolean

Indica se o Order Bump está ativo e pode ser exibido no checkout.

is_iaboolean

Indica se o Order Bump é gerado por IA, com a escolha do produto feita automaticamente. A loja pode ter apenas um Order Bump com IA.

pre_select_variationboolean

Indica se a variação do produto ofertado já vem selecionada para o cliente.

namestring

Nome do Order Bump, único na loja.

displayed_quantityinteger

Quantidade de produtos exibidos na oferta, de 1 a 5. Configurável apenas quando is_ia for verdadeiro; nos demais casos é sempre 1.

resource_idinteger

ID do produto ou do SKU ofertado, conforme resource_type.

resource_typestring

Tipo do item ofertado: product ou sku.

price_salestring

Preço de tabela do item na oferta, em reais.

price_discountstring

Preço promocional do item na oferta, em reais. É um preço final, não um valor de desconto.

accepted_paymentstring

Meio de pagamento que o cliente precisa escolher para a oferta ser exibida. all exibe em qualquer meio.

display_rulestring

Regra de exibição da oferta: always sempre exibe, products_amount compara o valor dos produtos do carrinho e selected_products exige que o carrinho tenha os produtos de display_product_ids.

amount_rulestring

Comparação aplicada ao valor dos produtos do carrinho: greater_than ou lower_than. Preenchido quando display_rule for products_amount.

amount_valuestring

Valor de referência, em reais, comparado ao total dos produtos do carrinho conforme amount_rule.

display_product_idsinteger[]

IDs dos produtos que precisam estar no carrinho para a oferta ser exibida. Preenchido apenas quando display_rule for selected_products.

Example response

{
  "id": 255787,
  "active": true,
  "pre_select_variation": true,
  "name": "Oferta Especial",
  "displayed_quantity": 1,
  "resource_id": 42533439,
  "resource_type": "product",
  "price_sale": "50.00",
  "price_discount": "0.00",
  "params": {
    "button_text": "+ Adicionar oferta"
  },
  "accepted_payment": "all",
  "display_rule": "always",
  "amount_rule": "greater_than",
  "amount_value": "0.00",
  "updated_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"
  },
  "display_product_ids": []
}

Changes