Shop

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
Languages
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}/

Share Statistics

Share statistics endpoints for media, products, playlists, categories, collections, posts, pages, and enrollment packs

Address Fields

Operations

Admin Payment Methods

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GitHub Installations

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding Info

Operations

Option Values

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments Reports

Operations

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Pro Features

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Retrieve shop products with filtering and pagination

Request

Returns a paginated list of products from the shop with filtering and sorting capabilities.

Pagination:

  • page: Page number for pagination (default: 1)
  • count: Number of products per page (default: 10, minimum: 10)

Country Context Options:

  • country_id: Filter by country ID for pricing information (numeric ID)
  • country_code: Filter by country ISO code for pricing information (e.g., "US", "PH", "CA")

Filtering Options:

  • search_query: Text search across product titles, SKUs, and descriptions
  • with_country_id: Filter by country ID for pricing information (alternative to country_id param)
  • with_category_id: Filter by specific category ID
  • by_collection: Filter by collection ID or collection title
  • with_prices: Filter by price range (format: "min-max", e.g., "10.00-100.00")
  • by_stock_available: Filter by stock availability (true/false)
  • by_language: Filter by language code (e.g., "en")

Sorting Options:

  • sorted_by: Sort order for products
    • created_at_desc: Sort by creation date (newest first)
    • created_at_asc: Sort by creation date (oldest first)
    • title_asc: Sort alphabetically by title (A-Z)
    • title_desc: Sort alphabetically by title (Z-A)
    • price_asc: Sort by price (lowest first)
    • price_desc: Sort by price (highest first)

Examples:

  • /shop.json?page=1&count=20&filterrific[sorted_by]=created_at_desc
  • /shop.json?filterrific[search_query]=shirt&filterrific[with_prices]=10.00-50.00
  • /shop.json?filterrific[with_category_id]=1&filterrific[by_stock_available]=true
  • /shop.json?country_code=PH&filterrific[search_query]=DY-ENQ-50419-PH
  • /shop.json?country_id=1&filterrific[by_language]=en
  • /shop.json?filterrific[with_country_id]=1&filterrific[by_language]=en
Query
pageinteger

Page number for pagination

Default 1
countinteger

Number of products per page (minimum 10)

Default 10
country_idinteger

Filter by country ID for pricing information

Example: country_id=1
country_codestring^[A-Z]{2,3}$

Filter by country ISO code for pricing information (2 or 3 letter code)

Example: country_code=PH
filterrific[sorted_by]string

Sort order for products

Enum"created_at_desc""created_at_asc""title_asc""title_desc""price_asc""price_desc"
filterrific[search_query]string

General search query by title, sku, and description

filterrific[with_country_id]integer

Filter by country ID for pricing

Example: filterrific[with_country_id]=1
filterrific[with_category_id]integer

Filter by category ID

Example: filterrific[with_category_id]=1
filterrific[by_collection]integer

Filter by collection ID or collection title

Example: filterrific[by_collection]=1
filterrific[with_prices]string

Filter by price range (format: min-max)

Example: filterrific[with_prices]=10.00-100.00
filterrific[by_stock_available]boolean

Filter by stock availability

Example: filterrific[by_stock_available]=true
filterrific[by_language]string

Filter by language code

Example: filterrific[by_language]=en
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/shop.json?count=10&country_code=string&country_id=0&filterrific%5Bby_collection%5D=0&filterrific%5Bby_language%5D=string&filterrific%5Bby_stock_available%5D=true&filterrific%5Bsearch_query%5D=string&filterrific%5Bsorted_by%5D=created_at_desc&filterrific%5Bwith_category_id%5D=0&filterrific%5Bwith_country_id%5D=0&filterrific%5Bwith_prices%5D=string&page=1'

Responses

successful with country_code filter

Bodyapplication/jsonArray [
idintegerrequired

Product ID

Example: 1
slugstring or null

Product slug

Example: "ph-product"
canonical_urlstring or null

Canonical URL for the product

Example: "https://example.com/home/products/ph-product"
custom_slugboolean

Whether product uses a custom slug

Example: false
statusstring

Product status

Example: "active"
skustring or null

Product SKU

Example: "PH-SKU-123"
upcstring or null

UPC code

Example: "123456789012"
hs_codestring or null

HS code

Example: "1234.56"
image_urlstring or null

Product image URL

Example: "https://example.com/image.jpg"
compressed_image_urlstring or null

Compressed image URL

Example: "https://example.com/compressed.jpg"
image_pathstring or null

Image path

Example: "/images/product.jpg"
tax_category_idinteger or null

Tax category ID

Example: 1
publicboolean

Is product public

Example: true
in_stockboolean

Is product in stock

Example: true
track_quantityboolean

Track product quantity

Example: true
no_indexboolean

Exclude from search indexing

Example: false
commissionstring or null

Commission amount

Example: "5.00"
affiliate_commissionstring or null

Affiliate commission

Example: "2.50"
integration_idstring or null

Integration ID

Example: "ext-123"
external_idstring or null

External ID

Example: "external-456"
last_synced_atstring or null(date-time)

Last sync timestamp

metadataobject or null

Additional metadata

publish_to_retail_storeboolean

Publish to retail store

Example: true
publish_to_rep_storeboolean

Publish to rep store

Example: true
publish_to_share_tabboolean

Publish to share tab

Example: true
publish_atstring or null(date-time)

Scheduled publish date

show_reviewsboolean

Show product reviews

Example: true
international_tax_typestring or null

International tax type

application_theme_template_idinteger or null

Theme template ID

updated_atstring(date-time)

Last updated timestamp

option_attrsArray of arrays

Option attributes

track_inventory_on_bundle_itemsboolean

Whether to track inventory on bundle items

activebooleanrequired

Is product active

Example: true
titlestringrequired

Product title

Example: "PH Product"
descriptionstring or null

Product description

Example: "A great PH product"
introductionstring or null

Product introduction

feature_textstring or null

Feature text

strippedstring or null

Plain text description

review_countintegerrequired

Number of reviews

Example: 0
viewsintegerrequired

Number of views

Example: 0
leadsintegerrequired

Number of leads

Example: 0
pricestring or null

Product price

Example: "1999.99"
share_linkstring or null

Share link URL

display_pricestring or null

Formatted display price

Example: "₱1,999.99 (PHP)"
subscription_pricestring or null

Subscription price

tax_inclusive_pricestring or null

Tax inclusive price

tax_inclusive_wholesalestring or null

Tax inclusive wholesale price

tax_inclusive_subscription_pricestring or null

Tax inclusive subscription price

tax_inclusive_wholesale_subscription_pricestring or null

Tax inclusive wholesale subscription price

currency_codestring or null

Currency code

Example: "PHP"
categoryobject or null

Product category

collectionsArray of objects

Product collections

tagsArray of objects

Product tags

labelobject or null

Product label

display_tagstring or null

Display tag

Example: "new"
imagesArray of objects

Product images

optionsArray of objects

Product options

variantsArray of objects

Product variants

search_engine_optimizerobject or null

SEO metadata

product_subscription_plansArray of objects

Available subscription plans

product_bundlesArray of arrays

Product bundles

tax_categoryobject or null

Tax category information

metafieldsArray of arrays

Product metafields

metafields_collectionArray of objects

Product metafields collection with key and value

]
Response
application/json
[
  {
    "id": 1,
    "slug": "ph-product",
    "canonical_url": "https://example.com/home/products/ph-product",
    "custom_slug": false,
    "status": "active",
    "sku": "PH-SKU-123",
    "upc": "123456789012",
    "hs_code": "1234.56",
    "image_url": "https://example.com/image.jpg",
    "compressed_image_url": "https://example.com/compressed.jpg",
    "image_path": "/images/product.jpg",
    "tax_category_id": 1,
    "public": true,
    "in_stock": true,
    "track_quantity": true,
    "no_index": false,
    "commission": "5.00",
    "affiliate_commission": "2.50",
    "integration_id": "ext-123",
    "external_id": "external-456",
    "last_synced_at": "2019-08-24T14:15:22Z",
    "metadata": {},
    "publish_to_retail_store": true,
    "publish_to_rep_store": true,
    "publish_to_share_tab": true,
    "publish_at": "2019-08-24T14:15:22Z",
    "show_reviews": true,
    "international_tax_type": "string",
    "application_theme_template_id": 0,
    "updated_at": "2019-08-24T14:15:22Z",
    "option_attrs": [],
    "track_inventory_on_bundle_items": true,
    "active": true,
    "title": "PH Product",
    "description": "A great PH product",
    "introduction": "string",
    "feature_text": "string",
    "stripped": "string",
    "review_count": 0,
    "views": 0,
    "leads": 0,
    "price": "1999.99",
    "share_link": "string",
    "display_price": "₱1,999.99 (PHP)",
    "subscription_price": "string",
    "tax_inclusive_price": "string",
    "tax_inclusive_wholesale": "string",
    "tax_inclusive_subscription_price": "string",
    "tax_inclusive_wholesale_subscription_price": "string",
    "currency_code": "PHP",
    "category": { … },
    "collections": [ … ],
    "tags": [ … ],
    "label": {},
    "display_tag": "new",
    "images": [ … ],
    "options": [ … ],
    "variants": [ … ],
    "search_engine_optimizer": { … },
    "product_subscription_plans": [ … ],
    "product_bundles": [],
    "tax_category": {},
    "metafields": [],
    "metafields_collection": [ … ]
  }
]

Sitemap

Operations

Social Media

Operations

Subdomains

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Trainings

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

VGS Webhooks

Operations

Variant Countries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json
idintegerrequired
user_idinteger or null
titlestringrequired
descriptionobject or null
strippedstring or null
media_typestringrequired
Enum"share""update""training""upload"
media_formatstring or null
image_urlstring or null
video_urlstring or null
pdf_urlstring or null
kindstring or null
activebooleanrequired
visibilityinteger or null
share_linkstring or null
preview_linkstring or null
viewsintegerrequired
leadsintegerrequired
watchobject or null
video_statusstring or null
durationinteger or null
cta_urlstring or null
cta_button_textstring or null
cta_enabledbooleanrequired
cta_action_typestring or null
video_shopping_enabledbooleanrequired
prompts_enabledbooleanrequired
ranksArray of strings
settingsobject or null
application_theme_template_idinteger or null
created_atstring(date-time)required
subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects
tagsArray of objects
slugstring or null

URL-friendly slug for the media item

canonical_urlstring or null

The primary URL for accessing this media item on the company's website

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects
commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

publish_atstring or null(date-time)

Scheduled publish date/time. If set to a future date, the media will not be publicly accessible until that time.

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "canonical_url": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string",
  "publish_at": "2019-08-24T14:15:22Z"
}