Skip to content

Order Bumps

Manage add-on offers shown during checkout.

Fields

idstringUnique identifier of the resource.
namestring
statusenumdraft · active · paused
descriptionstring
productNamestring
variantNamestring
imageUrlstring
offerPricenumber
See all 20 fields
minimumCartSubtotalnumber
priorityinteger
maxPerCartinteger
startsAtstring
endsAtstring
badgeLabelstring
callToActionstring
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstring
productIdstring
variantIdstring

Operations

MethodEndpointOperation
POST/v1/order-bumpsCreate order bump
GET/v1/order-bumpsList order bumps
GET/v1/order-bumps/{orderBumpId}Get order bump
PUT/v1/order-bumps/{orderBumpId}Update order bump
DELETE/v1/order-bumps/{orderBumpId}Delete order bump

Last updated: