Skip to main content
POST
Create bundle

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

Body

application/json

A bundle a supplier is creating or editing.

name
string
required

What to call it.

Required string length: 1 - 120
stacking
string
required

How it behaves alongside a reseller's standing discount: BundleWins, BestWins or Stack.

Minimum string length: 1
Pattern: ^(?:BundleWins|BestWins|Stack)$
targetMode
string
required

Who may see and buy it: AllResellers, Tier or SpecificResellers.

Minimum string length: 1
Pattern: ^(?:AllResellers|Tier|SpecificResellers)$
targetResellerIds
string<uuid>[]
required

The resellers to offer it to, when targeting named ones.

isEnabled
boolean
required

Whether to offer it now.

order
integer<int32>
required

Where it sits among the store's other bundles.

items
object[]
required

What is in it. A bundle with no lines is not a bundle.

Minimum array length: 1
description
string | null

An optional line explaining who it is for.

Maximum string length: 500
discountPercent
number<double> | null

The discount off list price to advertise it at, or null to let the store's basket tiers decide.

Required range: 0 <= x <= 100
tierId
string<uuid> | null

The standing tier to limit it to, when targeting a tier.

startsAt
string<date-time> | null

When it becomes available, or null for immediately.

endsAt
string<date-time> | null

When it stops being available, or null for never.

perResellerLimit
integer<int32> | null

How many times one reseller may buy it, or null for no limit.

Required range: 1 <= x <= 1000000
totalLimit
integer<int32> | null

How many times it may be bought at all, or null for no limit.

Required range: 1 <= x <= 1000000

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
any | null

Represents the data associated with a response.

Last modified on August 22, 2026