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.
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
Mock server https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/shop.json
Production server with company subdomain https://myco.fluid.app/shop.json
Local development server http://fluid.lvh.me:3000/shop.json
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl-i-X GET \'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/shop.json?count=10&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
Bodyapplication/jsonArray [
idintegerrequired
Product ID
Example: 1
slugstring or null
Product slug
Example: "sample-product"
statusstring
Product status
Example: "active"
skustring or null
Product SKU
Example: "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"
external_urlstring or null
External URL
Example: "https://external.com"
tax_category_idinteger or null
Tax category ID
Example: 1
publicboolean
Is product public
Example: true
in_stockboolean
Is product in stock
Example: true
keep_sellingboolean
Continue selling when out of stock
Example: false
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
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: "Sample Product"
descriptionstring or null
Product description
Example: "A great product"
introductionstring or null
Product introduction
feature_textstring or null
Feature text
strippedstring or null
Plain text description
review_countintegerrequired
Number of reviews
Example: 5
viewsintegerrequired
Number of views
Example: 100
leadsintegerrequired
Number of leads
Example: 10
pricestring or null
Product price
Example: "29.99"
share_linkstring or null
Share link URL
display_pricestring or null
Formatted display price
Example: "$29.99"
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