Order Bumps

Order bumps

Als Markdown anzeigen Rohes Markdown in neuem Tab In ChatGPT öffnen Zu dieser Seite befragen In Claude öffnen Zu dieser Seite befragen

GET / v1 / order-bumps

The order bumps, newest first. An order bump is an extra offer that buyers add with one checkbox at the checkout. For each: name, status, the offered product (with its status), price and product price, title, description, checkbox text, the products whose checkout shows it, sales and revenue, and the admin link.

active: buyers see it at the checkout.
inactive: hidden at every checkout. It keeps its settings and sales.

Without status, the list has active and inactive order bumps. Deleted order bumps are not listed.

product_ids null means the checkouts of all products.
sales and revenue count the orders with this order bump that are paid or in payment, like the order bump editor in the app. They are only in this list.

The fields have the same names and formats as in POST /v1/order-bumps and PATCH /v1/order-bumps/{order_bump_id}.

Liest nur MCP-Werkzeug list_order_bumps

curl "https://api.tentary.com/v1/order-bumps" \
  -H "Authorization: Bearer $TENTARY_API_KEY"

const response = await fetch("https://api.tentary.com/v1/order-bumps", {
  headers: {
    Authorization: `Bearer ${process.env.TENTARY_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

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

<?php
$ch = curl_init('https://api.tentary.com/v1/order-bumps');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TENTARY_API_KEY'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 · Antwort

{
  "order_bumps": [
    {
      "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",
      "sales": 0,
      "revenue": "0.00"
    }
  ],
  "next_cursor": null,
  "links": {
    "order_bumps": "https://app.tentary.com/orderbumps",
    "new_order_bump": "https://app.tentary.com/orderbumps/new"
  }
}

Autorisierung

Authorization string Header erforderlich

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

Query-Parameter

status string

Only order bumps with this status.

Mögliche Werte: activeinactive
cursor string

next_cursor of the previous page. Send the same filters and limit again: the cursor does not keep them. Leave out for the first page.
limit integer

Items per page, default 25.

min. 1 max. 50

Antwort

Felder der Antwort mit Status 200. Fehler haben immer dasselbe Format, siehe Fehler.

order_bumps array of object

Newest first.
15 Felder anzeigen Felder ausblenden
- 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.
  
  Mögliche Werte: activeinactive
- product object
  
  The offered product.
  3 Felder anzeigen Felder ausblenden
  
  id integer
  
  The ID.
  
  name string kann null sein
  
  The name.
  
  status string
  
  The status.
  
  Mögliche Werte: 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 kann null sein
  
  null = the product title.
- description_html string
  
  Short text about the offer, HTML.
- checkbox_text string kann null sein
  
  null = "Yes, add to my order".
- hide_product_image boolean
- product_ids array of integer kann null sein
  
  The products whose checkout shows it. null = all products.
- admin_url string<uri>
  
  The page in the Tentary app.
- sales integer
  
  Orders with this order bump that are paid or in payment (like the editor).
- revenue string
  
  Decimal string, like "19.90". What buyers paid for it in these orders.
next_cursor string kann null sein

Send it as cursor for the next page, with the same filters and limit. null = this is the last page.
links object

Pages in the Tentary app or on tentary.com.
2 Felder anzeigen Felder ausblenden
- order_bumps string<uri>
  
  Page in the Tentary app.
- new_order_bump string<uri>
  
  Page in the Tentary app.