v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Promoções - Order Bump

Atualizar Order Bump

Atualiza os detalhes de um Order Bump específico

put/{alias}/pricing/order-bumps/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do Order Bump

Request body

namestring required
activeboolean required
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
price_discountnumber float nullable
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
amount_valuenumber float nullable
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
}

Response

Order Bump atualizado com sucesso

idinteger
activeboolean
is_iaboolean
pre_select_variationboolean
namestring
displayed_quantityinteger
resource_idinteger
resource_typestring
price_salestring
price_discountstring
accepted_paymentstring
display_rulestring
amount_rulestring
amount_valuestring
display_product_idsinteger[]

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": []
}