Sign in
Bundles

Create bundle

Creates a new product bundle that can be linked to orders.

post/bundles

Request body

namestring required

Bundle name visible on the checkout page.

descriptionstring

Longer description of the product.

valuenumber float

Price of the product.

is_activeboolean

Whether the product link is available (true) or unavailable (false).

is_shippableboolean

Whether the product can be shipped. If true, the checkout will ask for shipping details.

value_shippingnumber float

Shipping cost. Required if is_shippable is true.

tagstring

Optional short tag for the product.

metadataobject

Array to save any other data needed.

imagesstring[]

Array of product image URLs.

expirationstring date-time

Expiration date for the product link.

expiration_unitnumber

Expiration unit if stock is limited.

expiration_amountnumber

Expiration amount for reduced/augmented prices.

buyer_confirmed_urlstring uri

URL where the buyer is redirected after payment is completed.

buyer_denied_urlstring uri

URL where the buyer is redirected if payment fails.

seller_confirmed_urlstring uri

URL where the seller is redirected after the payout is completed.

seller_denied_urlstring uri

URL where the seller is redirected if the payout fails.

Example request

{
  "name": "Test product",
  "value": 1.24
}

Response

Bundle created

idinteger
selfstring
namestring
descriptionstring nullable
valuenumber
value_shippingnumber nullable
currencystring
amountstring nullable

Formatted price with currency symbol.

amount_shippingstring nullable
buyer_linkstring uri nullable
imagesstring[] nullable
expirationstring date-time nullable
expiration_unitnumber nullable
expiration_amountnumber nullable
is_expiredboolean
is_activeboolean
is_shippableboolean
tagstring nullable
visitsinteger nullable
metadataobject nullable
created_byinteger nullable
created_atstring date-time nullable
updated_atstring date-time nullable
qr_linkstring uri nullable
connectionsConnections

Hypermedia links to related resources.

Example response

{
  "currency": "EUR"
}

Changes

Changed in 1 of the 4 revisions of this API.1