FlintflintDocs

Bundles

Bundles group product variants sold together as a single sellable unit: a meal combo, a starter kit, a multi-pack. A bundle has its own price, SKU, image, tax settings, and categories, independent of its components. Each component references a product variant with a quantity and display position.

Bundles are sellable the same way variants are: pass a bundle_id on an order line item and Flint resolves price and display from the catalog. Bundle availability is computed from component inventory, so a bundle is only available_for_sale while every component variant has sufficient stock. Bundles can also carry modifier set assignments for buyer customization.

Endpoints

List bundles#

GET/v1/bundles

List bundles.

Query parameters
page_sizeinteger

Page size, default 20, max 100.

page_tokenstring

Cursor returned by the previous list response.

querystring

Search across bundle_id, name, description, and SKU.

statusenum

Filter by bundle status.

activeinactivedeleted
sort_byenum

Sort field.

created_atupdated_atname
sort_directionenum

Sort direction.

ascdesc
Response · 200
dataarray of objectrequired
metaobject
next_page_tokenstring
request_idstring
Bash
curl https://api.withflintpay.com/v1/bundles \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": [],
  "next_page_token": "Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I",
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Create bundle#

POST/v1/bundlesIdempotent

Create bundle.

Request body
barcodestring
categoriesarray of string
componentsarray of object
descriptionstring
image_urlstring
metadatamap of string
namestringrequired
skustring
statusenum
activeinactive
tax_categoryenum

Flint line-item tax category.

generalphysical_goodsdigital_goodssoftwaresaasservicesprofessional_servicesfoodprepared_foodclothingmedical_goodsadmission
taxableboolean
unit_price_moneyobjectrequired

Monetary amount represented as integer minor units plus an ISO 4217 currency code.

Response · 201
dataobjectrequired
metaobject
request_idstring
Bash
curl -X POST https://api.withflintpay.com/v1/bundles \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{}'
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Get bundle#

GET/v1/bundles/{bundle_id}

Get bundle.

Path parameters
bundle_idstringrequired

Flint bundle ID.

Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl https://api.withflintpay.com/v1/bundles/{bundle_id} \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Update bundle#

PATCH/v1/bundles/{bundle_id}Idempotent

Update bundle.

Path parameters
bundle_idstringrequired

Flint bundle ID.

Request body
barcodestring
categoriesarray of string
descriptionstring
image_urlstring
metadatamap of string
namestring
skustring
statusenum
activeinactive
tax_categoryenum

Flint line-item tax category.

generalphysical_goodsdigital_goodssoftwaresaasservicesprofessional_servicesfoodprepared_foodclothingmedical_goodsadmission
taxableboolean
unit_price_moneyobject

Monetary amount represented as integer minor units plus an ISO 4217 currency code.

Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl -X PATCH https://api.withflintpay.com/v1/bundles/{bundle_id} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{}'
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Delete bundle#

DELETE/v1/bundles/{bundle_id}Idempotent

Delete bundle.

Path parameters
bundle_idstringrequired

Flint bundle ID.

Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl -X DELETE https://api.withflintpay.com/v1/bundles/{bundle_id} \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Replace bundle categories#

PUT/v1/bundles/{bundle_id}/categoriesIdempotent

Replace bundle categories.

Path parameters
bundle_idstringrequired

Flint bundle ID.

Request body
categoriesarray of stringrequired
Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl -X PUT https://api.withflintpay.com/v1/bundles/{bundle_id}/categories \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{}'
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Add bundle components#

POST/v1/bundles/{bundle_id}/componentsIdempotent

Add bundle components.

Path parameters
bundle_idstringrequired

Flint bundle ID.

Request body
componentsarray of objectrequired
Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl -X POST https://api.withflintpay.com/v1/bundles/{bundle_id}/components \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{}'
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Update bundle component#

PATCH/v1/bundles/{bundle_id}/components/{bundle_component_id}Idempotent

Update bundle component.

Path parameters
bundle_idstringrequired

Flint bundle ID.

bundle_component_idstringrequired

Stable bundle component ID.

Request body
positioninteger
quantityinteger

Whole-number quantity; fractional quantities are not supported.

Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl -X PATCH https://api.withflintpay.com/v1/bundles/{bundle_id}/components/{bundle_component_id} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{}'
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Delete bundle component#

DELETE/v1/bundles/{bundle_id}/components/{bundle_component_id}Idempotent

Delete bundle component.

Path parameters
bundle_idstringrequired

Flint bundle ID.

bundle_component_idstringrequired

Stable bundle component ID.

Response · 200
dataobjectrequired
metaobject
request_idstring
Bash
curl -X DELETE https://api.withflintpay.com/v1/bundles/{bundle_id}/components/{bundle_component_id} \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": {},
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}
Rate this doc