List product bundles

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description

swagger.json

swagger.yaml

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://docs.fluid.app/_mock/docs/apis/swagger/

Production server with company subdomain

https://{company}.fluid.app/

Local development server

http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

Create a product bundle

Request

Creates a new product bundle for a product

Path

product_idintegerrequired

Product ID

Example: 1

Bodyapplication/json

bundled_variant_idintegerrequired

Example: 123

quantityintegerrequired

Example: 2

display_externallyboolean

Example: true

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{product_id}/product_bundles' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bundled_variant_id": 123,
    "quantity": 2,
    "display_externally": true
  }'

Responses

Product bundle created

Bodyapplication/json

product_bundleobject(ProductBundle)required

product_bundle.idintegerrequired

product_bundle.quantityinteger>= 1required

Default 1

product_bundle.tax_percentagenumber or string or null[ 0.01 .. 100 ]

product_bundle.display_externallyboolean or null

Default true

product_bundle.bundled_variantobject(Variant)required

product_bundle.bundled_variant.idintegerrequired

product_bundle.bundled_variant.titlestring or null

Example: "Variant 1"

product_bundle.bundled_variant.image_urlstring or null

Example: "https://via.placeholder.com/150"

product_bundle.bundled_variant.image_pathstring or null

Example: "https://via.placeholder.com/150"

product_bundle.bundled_variant.skustring or null

Example: "SKU-123456"

product_bundle.bundled_variant.primary_imagestring or null

Example: "https://via.placeholder.com/150"

product_bundle.bundled_variant.pricenumber or string or null

Example: 100

product_bundle.bundled_variant.price_in_currencystringrequired

Example: "USD 100.00"

product_bundle.bundled_variant.optionsArray of objectsrequired

product_bundle.bundled_variant.options[].titlestring

Example: "Size"

product_bundle.bundled_variant.options[].valuestring

Example: "XL"

product_bundle.bundled_variant.productobject(Product)required

product_bundle.bundled_variant.product.idintegerrequired

product_bundle.bundled_variant.product.titlestringrequired

product_bundle.bundled_variant.product.image_urlstring or null

product_bundle.bundled_variant.product.image_pathstring or null

product_bundle.bundled_variant.product.pricenumber or string or null[ 0 .. 99999999 ]

Default "0.0"

product_bundle.bundled_variant.product.cvinteger or null

Default 0

product_bundle.bundled_variant.product.taxnumber or string or null

Default "0.0"

product_bundle.bundled_variant.product.skustring or null

product_bundle.bundled_variant.product.metadataobjectrequired

Default "{}"

product_bundle.bundled_variant.product.introductionstring or null

product_bundle.bundled_variant.product.price_in_currencystringrequired

product_bundle.bundled_variant.product.tax_in_currencystringrequired

product_bundle.bundled_variant.product.cv_in_currencystringrequired

product_bundle.bundled_variant.product.metafieldsArray of objects(Metafield)required

product_bundle.bundled_variant.product.metafields[].idintegerrequired

product_bundle.bundled_variant.product.metafields[].namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"

product_bundle.bundled_variant.product.metafields[].keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"

product_bundle.bundled_variant.product.metafields[].valuestring or objectrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"

product_bundle.bundled_variant.product.metafields[].value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"

product_bundle.bundled_variant.product.metafields[].descriptionstring or null

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"

product_bundle.bundled_variant.product.metafields[].owner_typestringrequired

The type of resource that this metafield belongs to (polymorphic association).

Example: "Product"

product_bundle.bundled_variant.product.metafields[].owner_idintegerrequired

The ID of the specific resource that this metafield belongs to.

Example: 12345

product_bundle.bundled_variant.product.metafields[].created_atstring(date-time)required

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"

product_bundle.bundled_variant.product.metafields[].updated_atstring(date-time)required

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"

product_bundle.bundled_variant.product.metafields[].metafield_definitionobject or null(MetafieldDefinition)

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "product_bundle": {
    "id": 0,
    "quantity": 1,
    "tax_percentage": 0.01,
    "display_externally": true,
    "bundled_variant": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

List product bundles

Request

Path

product_idintegerrequired

Product ID

Example: 1

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{product_id}/product_bundles' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Empty product bundles list

Bodyapplication/json

product_bundlesArray of objects(ProductBundle)required

product_bundles[].idintegerrequired

product_bundles[].quantityinteger>= 1required

Default 1

product_bundles[].tax_percentagenumber or string or null[ 0.01 .. 100 ]

product_bundles[].display_externallyboolean or null

Default true

product_bundles[].bundled_variantobject(Variant)

product_bundles[].bundled_variant_idintegerrequired

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "product_bundles": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a product bundle

Request

Removes a product bundle from a product

Path

product_idintegerrequired

Product ID

Example: 1

idintegerrequired

Product bundle ID

Example: 1

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{product_id}/product_bundles/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Product bundle deleted

Bodyapplication/json

messagestringrequired

Example: "Product bundle deleted"

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "message": "Product bundle deleted",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a product bundle

Request

Updates an existing product bundle for a product

Path

product_idintegerrequired

Product ID

Example: 1

idintegerrequired

Product Bundle ID

Example: 1

Bodyapplication/json

bundled_variant_idinteger

Example: 123

quantityinteger

Example: 3

display_externallyboolean

Example: true

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{product_id}/product_bundles/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bundled_variant_id": 123,
    "quantity": 3,
    "display_externally": true
  }'

Responses

Product bundle updated with new bundled variant