Order Bump Overview
An Order Bump is an upsell configuration attached to an offer. When a customer reaches checkout for the main offer, they can optionally add one or more order bump products to their order at a discounted price.
Each order bump holds a collection of offers (offers) that represent the upsell products available during checkout. Payment configurations for bump offers are automatically inherited from the parent offer — you do not need to define them manually.
Requests return 400 unprocessable_action if:
- Any product_id belongs to a coproduced product — error reason: coproduction_product
- More than 5 offer objects are included — error reason: max_offers_exceeded
Order Bump Schema
| Field | Description | Type |
|---|---|---|
| id | Unique identifier (UUID) | String |
| name | Display name of the order bump | String |
| created_at | Indicates when the record was created in ISO8601 format | String |
| updated_at | Indicates when the record was last updated in ISO8601 format | String |
| offers | Array of bump offer objects currently active on this order bump | Array |
Bump Offer Schema
Each object in offers represents an upsell product with its own price point. These are internal offers managed by the order bump — they are not standalone purchasable offers.
| Field | Description | Type |
|---|---|---|
| id | Unique identifier (UUID) | String |
| name | Offer name (always empty for bump offers) | String |
| amount_cents | Upsell price in cents | Integer |
| amount_currency | Currency code (e.g., BRL) | String |
| availability | Always archived — bump offers are not directly purchasable | String |
| checkout_type | Checkout flow type. Can be default or without_address | String |
| smart_payment_enabled | Whether smart payment is enabled | Boolean |
| url | URL to this offer’s checkout page | String |
| created_at | Indicates when the record was created in ISO8601 format | String |
| updated_at | Indicates when the record was last updated in ISO8601 format | String |
| product | Product object containing details of the upsell product | Object |