Order bumps

Update order bump

View as Markdown Raw markdown in a new tab Open in ChatGPT Ask questions about this page Open in Claude Ask questions about this page

PATCH / v1 / order-bumps / {order_bump_id}

Changes the fields that you send. All other fields stay.

status active or inactive switches the order bump on or off at the checkouts at once.
product_ids replaces the whole list. null means the checkouts of all products.

Where an order bump shows:

On the checkouts of product_ids, or of all products, but not on the checkout of the offered product itself.
Only on products with one-time billing.
Not when the buyer pays in installments, except with PayPal or Klarna.

The order of several order bumps on one checkout cannot be set. To delete an order bump, use POST /v1/delete.

The fields have the same names and formats as in GET /v1/order-bumps.

Changes at once MCP tool update_order_bump

curl -X PATCH "https://api.tentary.com/v1/order-bumps/1" \
  -H "Authorization: Bearer $TENTARY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "active"
}'

const response = await fetch("https://api.tentary.com/v1/order-bumps/1", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.TENTARY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "active"
  }),
});
const data = await response.json();

import os
import requests

response = requests.patch(
    "https://api.tentary.com/v1/order-bumps/1",
    headers={"Authorization": f"Bearer {os.environ['TENTARY_API_KEY']}"},
    json={
        "status": "active",
    },
)
data = response.json()

<?php
$ch = curl_init('https://api.tentary.com/v1/order-bumps/1');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TENTARY_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'status' => 'active',
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 · Response

{
  "id": 1,
  "name": "E-book with the course",
  "status": "active",
  "product": {
    "id": 101,
    "name": "Yoga Basics E-Book",
    "status": "live"
  },
  "price": "9.00",
  "product_price": "19.00",
  "currency": "EUR",
  "title": null,
  "description_html": "<p>The 20 most important poses to look up after each lesson.</p>",
  "checkbox_text": "Yes, add the e-book for 9 EUR",
  "hide_product_image": false,
  "product_ids": [
    102
  ],
  "admin_url": "https://app.tentary.com/orderbumps/edit/1"
}

Authorization

Authorization string header required

Bearer tnt_… · A personal API key (tnt_...). Create it in the Tentary app on the page AI & API. Introduction

Path parameters

order_bump_id integer required

The id from list_order_bumps.

min 1 Example: 1

Body application/json

name string

Name in the Tentary app. Buyers do not see it.

min length 1 max length 255
product_id integer

The offered product (id from list_products): live, without variants, with one-time billing, not external.

min 1
product_ids array of integer can be null

The products whose checkout shows the order bump (live or draft, one-time billing; ids from list_products). null = all products. On create, left out = all products. On update, left out = no change; a list replaces the list.

max items 200
price number | string can be null

Special price for the order bump. Amount in the account currency, like 49 or 19.99. 0 = free. null or left out on create = the price of the product (it follows later changes of that price). A lower price shows the product price crossed out.

min 0 max 21474836.47 pattern ^[0-9]{1,9}(\.[0-9]{1,2})?$
title string

Title that buyers see. Empty = the product title.

max length 255
description_html string

Short text about the offer, HTML (p, h1-h3, strong, em, u, del, ul, ol, li, blockquote, a).

max length 65535
checkbox_text string

Text next to the checkbox. Empty = "Yes, add to my order" (German: "Ja, zur Bestellung hinzufügen").

max length 255
hide_product_image boolean

Hide the product image in the order bump. Default false.
status string

active = buyers see the order bump at the checkouts of product_ids at once. inactive = it is hidden at every checkout; its settings, sales and revenue stay, and it can be made active again.

Allowed values: activeinactive

Response

Fields of the answer with status 200. Errors always have the same format, see Errors.

id integer

The ID.
name string

Name in the Tentary app. Buyers do not see it.
status string

active = buyers see it at the checkout. inactive = hidden at every checkout, kept with its settings and sales.

Allowed values: activeinactive
product object

The offered product.
Show 3 fields Hide fields
- id integer
  
  The ID.
- name string can be null
  
  The name.
- status string
  
  The status.
  
  Allowed values: livedraftarchiveddeleted
price string

Decimal string, like "19.90". What buyers pay for the order bump.
product_price string

Decimal string, like "19.90". The price of the product. Shown crossed out when price is lower.
currency string

Currency code, like EUR.
title string can be null

null = the product title.
description_html string

Short text about the offer, HTML.
checkbox_text string can be null

null = "Yes, add to my order".
hide_product_image boolean
product_ids array of integer can be null

The products whose checkout shows it. null = all products.
admin_url string<uri>

The page in the Tentary app.