Skip to main content

List Order Bumps

List order bumps on an owner product, including inactive ones. The envelope is { items, pagination }. Array order is display order — see Display order. Incomplete items are omitted — see Incomplete items.

Default per_page is 25. A page past the last page returns empty items and the requested current_page.

Request

Live:

  • GET /products/{productId}/order-bumps

Draft (same item shape; overlay collection):

  • GET /products/{productId}/draft/order-bumps

There is no live nested GET /products/{productId}/order-bumps/{id} — use Get Order Bump (GET /order-bumps/{id}). Draft get is nested.

Path Parameters

ParameterTypeRequiredDescription
productIdstringYesOwner product UUID.

Query Parameters

ParameterTypeRequiredDefaultDescription
pageintegerNo1Page number.
per_pageintegerNo25Items per page (min 1, max 100).

Example Request

curl -X GET "https://cart.easy.tools/api/v1/products/0632bef5-c308-42cd-9cba-89a7a4f722bb/order-bumps" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response

Success Response (200)

{
"items": [
{
"id": "4eebbd13-ee35-4d66-bfec-a9988b63ef75",
"product_id": "70dbd819-fac2-4dcf-b655-fb925e24410b",
"variant_id": "5272bfcf-4e92-458d-b513-80ca474a16e4",
"name": "Backup recording",
"title": "Add the recording",
"description": "Keep the session afterwards.",
"amount": 4900,
"currency": "usd",
"display_type": "large_thumbnail",
"validity_minutes": null,
"active": true
}
],
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 25,
"total": 1
}
}

See Order Bump Object.

Pagination Object

FieldTypeDescription
current_pageintegerRequested page.
total_pagesintegerTotal pages (at least 1).
per_pageintegerPage size.
totalintegerTotal complete bumps on this owner.

Error Responses

Bad Request (400)

{
"message": "Invalid product ID"
}

Returned when the path UUID is malformed.

Not Found Error (404)

{
"message": "Product with ID 0632bef5-c308-42cd-9cba-89a7a4f722bb not found"
}

Unauthorized Error (401)

{
"message": "Unauthenticated."
}

Forbidden Error (403)

{
"message": "You do not have API access to the requested store."
}