Libraries

Fluid APIs (1.0.0)

The Fluid 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
fluid.api.json
fluid.api.yaml
Overview
E-mail support@fluid.app
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/fluid.api/
Production server with company subdomain
https://{company}.fluid.app/api/
Local development server
http://fluid.lvh.me:{port}/api/

Activities

Manage activities

Operations

Carts

Carts api that can be used for api call by webhooks of external applications or admins.

Operations

CatchUps

Catchup is a unique feature in our mobile app designed to keep you informed about everything you might have missed while you were away. From unread messages to visitor activities, it ensures you stay up-to-date with all the important details.

Operations

Categories

Categories

Operations

Collections

Products can be organized under a collection or multiple collections.

Operations

Contacts

Manage contacts

Operations

Conversations

Conversations within Fluid's platform serve as the central hub where users, contacts and/or automated agents (such as Response Bots and Broadcast Bots) come together to exchange messages. Each conversation can include multiple participants, ranging from individual users to bots designed to provide interactive support or broadcast important updates. With a flexible architecture, Conversations allow for rich interactions, whether it’s real-time messaging, automated responses, or large-scale broadcasts.

The structure supports seamless communication, enabling participants to share information effectively while allowing developers to build and extend features like bots that can respond, broadcast, or even act as virtual assistants within any conversation.

Operations

Custom Pages

Create and manage custom pages within the application. Custom pages allow you to build unique, branded experiences and content areas tailored to your needs.

Operations

Events

Manage and track system events that occur within the application. Events provide a way to monitor and respond to various activities and state changes.

Operations

Libraries

Manage reusable components and resources that can be shared across your application. Libraries help maintain consistency and reduce duplication in your implementation.

Operations

List Company Libraries

Request

Retrieves a list of libraries associated with the company.

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8Array [
idinteger(int32)required
Example: 361
titlestringrequired
Example: "New library"
slugstringrequired
Example: "new-library"
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarystringrequired
affiliate_idinteger(int32)required
Example: 2707
labelstringrequired
display_tagstringrequired
library_itemsArray of LibraryItem (object) or LibraryItem1 (object)required
Example: []
One of:
library_items[].​idinteger(int32)
library_items[].​orderstring
library_items[].​relateable_typestring
library_items[].​relateableobject(Relateable)
Example: {"id":1981,"active":true,"title":"In iste aliquip aliq","description":{"id":2025,"name":"description","body":"<div>Minus eum proident, .</div>","record_type":"Product","record_id":1981,"created_at":"2022-06-17T09:25:58.301Z","updated_at":"2022-06-17T09:25:58.301Z","locale":null},"stripped":"Minus eum proident, .","price":"182.0","display_price":"Rs.182.00 (NPR)","subscription_price":"182.0","display_subscription_price":"Rs.182.00 (NPR)","wholesale_price":"0.0","display_wholesale_price":"Rs.0.00 (NPR)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"Rs.0.00 (NPR)","shipping":"737.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg","detail":"https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg","full":"https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg","sku":"Alias rerum quis asp","country_code":"np","country_id":141,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.182.00","Rs.182.00"],"price_range_formatted":"Rs.182.00","unlimited_inventory":false,"default_variant":{"id":9970,"product_id":1981,"shopify_id":null,"title":null,"sku":"Alias rerum quis asp","position":84,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-06-17T09:25:58.326Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":null,"size":null,"physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"Rs.","currency_code":"NPR","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":1881,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg","full":"https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":9970,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":99273,"price":"182.0","shipping":"737.0","tax":"0.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.182.00","country_iso":"NP","subscription_price":"182.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}
]
Response
application/json; charset=utf-8
[
  {
    "id": 361,
    "title": "New library",
    "slug": "new-library",
    "share_link": null,
    "views": 0,
    "leads": 0,
    "company_library": null,
    "affiliate_id": 2707,
    "label": null,
    "display_tag": null,
    "library_items": []
  }
]

Create Company Library

Request

Creates a new library for a company with specified resources and settings.

Bodyapplication/jsonrequired
libraryobject(Library)required
Example: {"title":"Library from API","affiliate_id":1,"library_items_attributes":[{"relateable_type":"Product","relateable_id":1,"order":3},{"relateable_type":"Medium","relateable_id":1,"order":2},{"relateable_type":"Product","relateable_id":2,"order":1}]}
library.​titlestringrequired
Example: "Library from API"
library.​affiliate_idinteger(int32)required
Example: 1
library.​library_items_attributesArray of objects(LibraryItemsAttribute)required
Example: [{"relateable_type":"Product","relateable_id":1,"order":3},{"relateable_type":"Medium","relateable_id":1,"order":2},{"relateable_type":"Product","relateable_id":2,"order":1}]
library.​library_items_attributes[].​relateable_typestringrequired
Example: "Product"
library.​library_items_attributes[].​relateable_idinteger(int32)required
Example: 1
library.​library_items_attributes[].​orderinteger(int32)required
Example: 3
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "library": {
      "title": "Library from API",
      "affiliate_id": 1,
      "library_items_attributes": [
        {
          "relateable_type": "Product",
          "relateable_id": 1,
          "order": 3
        },
        {
          "relateable_type": "Medium",
          "relateable_id": 1,
          "order": 2
        },
        {
          "relateable_type": "Product",
          "relateable_id": 2,
          "order": 1
        }
      ]
    }
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
titlestringrequired
slugstringrequired
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarystringrequired
affiliate_idinteger(int32)required
labelstringrequired
display_tagstringrequired
library_itemsArray of objects(LibraryItem3)required
Example: [{"id":1351,"order":1,"relateable_type":"Product","relateable":{"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}}]
library_items[].​idinteger(int32)required
Example: 1351
library_items[].​orderinteger(int32)required
Example: 1
library_items[].​relateable_typestringrequired
Example: "Product"
library_items[].​relateableobject(Relateable2)required
Example: {"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}
library_items[].​relateable.​idinteger(int32)required
Example: 2198
library_items[].​relateable.​activebooleanrequired
Example: true
library_items[].​relateable.​titlestringrequired
Example: "not again"
library_items[].​relateable.​descriptionobject(Description19)required
Example: {"id":2025,"name":"description","body":"<div>Minus eum proident, .</div>","record_type":"Product","record_id":1981,"created_at":"2022-06-17T09:25:58.301Z","updated_at":"2022-06-17T09:25:58.301Z","locale":null}
library_items[].​relateable.​description.​idinteger(int32)required
Example: 2025
library_items[].​relateable.​description.​namestringrequired
Example: "description"
library_items[].​relateable.​description.​bodystringrequired
Example: "<div>Minus eum proident, .</div>"
library_items[].​relateable.​description.​record_typestringrequired
Example: "Product"
library_items[].​relateable.​description.​record_idinteger(int32)required
Example: 1981
library_items[].​relateable.​description.​created_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​updated_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​localestringrequired
library_items[].​relateable.​strippedstringrequired
Example: "no not again never"
library_items[].​relateable.​pricestring
library_items[].​relateable.​display_pricestring
library_items[].​relateable.​subscription_pricestring
library_items[].​relateable.​display_subscription_pricestring
library_items[].​relateable.​wholesale_pricestring
library_items[].​relateable.​display_wholesale_pricestring
library_items[].​relateable.​wholesale_subscription_pricestring
library_items[].​relateable.​display_wholesale_subscription_pricestring
library_items[].​relateable.​shippingstring
Example: "1.0"
library_items[].​relateable.​imageobject(Image3)
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
library_items[].​relateable.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"
library_items[].​relateable.​skustring
Example: "not again"
library_items[].​relateable.​country_codestring
Example: "bt"
library_items[].​relateable.​country_idstring
library_items[].​relateable.​viewsinteger(int32)required
library_items[].​relateable.​leadsinteger(int32)required
library_items[].​relateable.​share_linkstringrequired
library_items[].​relateable.​commissionstring
Example: "10.0"
library_items[].​relateable.​publicboolean
Example: true
library_items[].​relateable.​shopify_idstring
library_items[].​relateable.​shopify_handlestring
library_items[].​relateable.​in_stockboolean
Example: true
library_items[].​relateable.​vendorstring
library_items[].​relateable.​price_rangeArray of strings
Example: ["Rs.0.00","Rs.156.00"]
library_items[].​relateable.​price_range_formattedstring
Example: "Rs.0.00 - Rs.156.00"
library_items[].​relateable.​unlimited_inventoryboolean
library_items[].​relateable.​default_variantobject(DefaultVariant18)
Example: {"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1}
library_items[].​relateable.​currency_symbolstring
Example: "$"
library_items[].​relateable.​currency_codestring
Example: "USD"
library_items[].​relateable.​average_ratinginteger(int32)
library_items[].​relateable.​option_valuesstring
library_items[].​relateable.​publish_to_retail_storeboolean
Example: true
library_items[].​relateable.​publish_to_rep_storeboolean
Example: true
library_items[].​relateable.​publish_to_share_tabboolean
Example: true
library_items[].​relateable.​hide_rating?boolean
Example: true
library_items[].​relateable.​hide_reviews?boolean
Example: true
library_items[].​relateable.​prompts_enabledbooleanrequired
library_items[].​relateable.​labelstringrequired
library_items[].​relateable.​display_tagstringrequired
library_items[].​relateable.​imagesArray of objects(Image9)
Example: [{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}]
library_items[].​relateable.​countriesArray of objects(Country7)
Example: [{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
library_items[].​relateable.​variantsArray of objects(Variant24)
Example: [{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}]
library_items[].​relateable.​optionsArray of Option3 (object) or Option31 (object)
Example: []
library_items[].​relateable.​promptsArray of stringsrequired
Example: []
library_items[].​relateable.​enroll_productsArray of strings
Example: []
library_items[].​relateable.​enrollment_packsArray of strings
Example: []
library_items[].​relateable.​user_idstring
library_items[].​relateable.​media_typestring
library_items[].​relateable.​media_formatstring
library_items[].​relateable.​video_urlstring
library_items[].​relateable.​pdf_urlstring
library_items[].​relateable.​kindstring
library_items[].​relateable.​visibilitystring
library_items[].​relateable.​watchstring
library_items[].​relateable.​video_statusstring
library_items[].​relateable.​durationinteger(int32)
library_items[].​relateable.​cta_urlstring
library_items[].​relateable.​cta_button_textstring
library_items[].​relateable.​cta_enabledboolean
library_items[].​relateable.​cta_action_typestring
library_items[].​relateable.​video_shopping_enabledboolean
library_items[].​relateable.​attached_shareablesArray of strings
Response
application/json; charset=utf-8
{
  "id": 0,
  "title": "string",
  "slug": "string",
  "share_link": "string",
  "views": 0,
  "leads": 0,
  "company_library": "string",
  "affiliate_id": 0,
  "label": "string",
  "display_tag": "string",
  "library_items": [
    { … }
  ]
}

Get Company Library Details

Request

Retrieves the details of a specific company library.

Path
idstringrequired

The unique identifier of the company library

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
Example: 361
titlestringrequired
Example: "New library"
slugstringrequired
Example: "new-library"
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarystringrequired
affiliate_idinteger(int32)required
Example: 2707
labelstringrequired
display_tagstringrequired
library_itemsArray of stringsrequired
Example: []
Response
application/json; charset=utf-8
{
  "id": 361,
  "title": "New library",
  "slug": "new-library",
  "share_link": null,
  "views": 0,
  "leads": 0,
  "company_library": null,
  "affiliate_id": 2707,
  "label": null,
  "display_tag": null,
  "library_items": []
}

Delete Library

Request

Deletes a specific library from the company's collection.

Path
idstringrequired

Unique identifier of the library to delete

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

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
string
Response
application/json; charset=utf-8
"Library deleted successfully."

Update Company Library

Request

Updates an existing library for a company with specified title, affiliate information, and library items.

Path
idintegerrequired

The unique identifier of the library to update

Bodyapplication/jsonrequired
libraryobject(Library1)required
Example: {"title":"Edited Title","affiliate_id":5,"company_library":true}
library.​titlestringrequired
Example: "Edited Title"
library.​affiliate_idinteger(int32)required
Example: 5
library.​company_librarybooleanrequired
Example: true
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "library": {
      "title": "Edited Title",
      "affiliate_id": 5,
      "company_library": true
    }
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
titlestringrequired
slugstringrequired
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarybooleanrequired
affiliate_idinteger(int32)required
labelstringrequired
display_tagstringrequired
library_itemsArray of objects(LibraryItem3)required
Example: [{"id":1351,"order":1,"relateable_type":"Product","relateable":{"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}}]
library_items[].​idinteger(int32)required
Example: 1351
library_items[].​orderinteger(int32)required
Example: 1
library_items[].​relateable_typestringrequired
Example: "Product"
library_items[].​relateableobject(Relateable2)required
Example: {"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}
library_items[].​relateable.​idinteger(int32)required
Example: 2198
library_items[].​relateable.​activebooleanrequired
Example: true
library_items[].​relateable.​titlestringrequired
Example: "not again"
library_items[].​relateable.​descriptionobject(Description19)required
Example: {"id":2025,"name":"description","body":"<div>Minus eum proident, .</div>","record_type":"Product","record_id":1981,"created_at":"2022-06-17T09:25:58.301Z","updated_at":"2022-06-17T09:25:58.301Z","locale":null}
library_items[].​relateable.​description.​idinteger(int32)required
Example: 2025
library_items[].​relateable.​description.​namestringrequired
Example: "description"
library_items[].​relateable.​description.​bodystringrequired
Example: "<div>Minus eum proident, .</div>"
library_items[].​relateable.​description.​record_typestringrequired
Example: "Product"
library_items[].​relateable.​description.​record_idinteger(int32)required
Example: 1981
library_items[].​relateable.​description.​created_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​updated_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​localestringrequired
library_items[].​relateable.​strippedstringrequired
Example: "no not again never"
library_items[].​relateable.​pricestring
library_items[].​relateable.​display_pricestring
library_items[].​relateable.​subscription_pricestring
library_items[].​relateable.​display_subscription_pricestring
library_items[].​relateable.​wholesale_pricestring
library_items[].​relateable.​display_wholesale_pricestring
library_items[].​relateable.​wholesale_subscription_pricestring
library_items[].​relateable.​display_wholesale_subscription_pricestring
library_items[].​relateable.​shippingstring
Example: "1.0"
library_items[].​relateable.​imageobject(Image3)
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
library_items[].​relateable.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"
library_items[].​relateable.​skustring
Example: "not again"
library_items[].​relateable.​country_codestring
Example: "bt"
library_items[].​relateable.​country_idstring
library_items[].​relateable.​viewsinteger(int32)required
library_items[].​relateable.​leadsinteger(int32)required
library_items[].​relateable.​share_linkstringrequired
library_items[].​relateable.​commissionstring
Example: "10.0"
library_items[].​relateable.​publicboolean
Example: true
library_items[].​relateable.​shopify_idstring
library_items[].​relateable.​shopify_handlestring
library_items[].​relateable.​in_stockboolean
Example: true
library_items[].​relateable.​vendorstring
library_items[].​relateable.​price_rangeArray of strings
Example: ["Rs.0.00","Rs.156.00"]
library_items[].​relateable.​price_range_formattedstring
Example: "Rs.0.00 - Rs.156.00"
library_items[].​relateable.​unlimited_inventoryboolean
library_items[].​relateable.​default_variantobject(DefaultVariant18)
Example: {"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1}
library_items[].​relateable.​currency_symbolstring
Example: "$"
library_items[].​relateable.​currency_codestring
Example: "USD"
library_items[].​relateable.​average_ratinginteger(int32)
library_items[].​relateable.​option_valuesstring
library_items[].​relateable.​publish_to_retail_storeboolean
Example: true
library_items[].​relateable.​publish_to_rep_storeboolean
Example: true
library_items[].​relateable.​publish_to_share_tabboolean
Example: true
library_items[].​relateable.​hide_rating?boolean
Example: true
library_items[].​relateable.​hide_reviews?boolean
Example: true
library_items[].​relateable.​prompts_enabledbooleanrequired
library_items[].​relateable.​labelstringrequired
library_items[].​relateable.​display_tagstringrequired
library_items[].​relateable.​imagesArray of objects(Image9)
Example: [{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}]
library_items[].​relateable.​countriesArray of objects(Country7)
Example: [{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
library_items[].​relateable.​variantsArray of objects(Variant24)
Example: [{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}]
library_items[].​relateable.​optionsArray of Option3 (object) or Option31 (object)
Example: []
library_items[].​relateable.​promptsArray of stringsrequired
Example: []
library_items[].​relateable.​enroll_productsArray of strings
Example: []
library_items[].​relateable.​enrollment_packsArray of strings
Example: []
library_items[].​relateable.​user_idstring
library_items[].​relateable.​media_typestring
library_items[].​relateable.​media_formatstring
library_items[].​relateable.​video_urlstring
library_items[].​relateable.​pdf_urlstring
library_items[].​relateable.​kindstring
library_items[].​relateable.​visibilitystring
library_items[].​relateable.​watchstring
library_items[].​relateable.​video_statusstring
library_items[].​relateable.​durationinteger(int32)
library_items[].​relateable.​cta_urlstring
library_items[].​relateable.​cta_button_textstring
library_items[].​relateable.​cta_enabledboolean
library_items[].​relateable.​cta_action_typestring
library_items[].​relateable.​video_shopping_enabledboolean
library_items[].​relateable.​attached_shareablesArray of strings
Response
application/json; charset=utf-8
{
  "id": 0,
  "title": "string",
  "slug": "string",
  "share_link": "string",
  "views": 0,
  "leads": 0,
  "company_library": true,
  "affiliate_id": 0,
  "label": "string",
  "display_tag": "string",
  "library_items": [
    { … }
  ]
}

Add Item to Library

Request

Add an item to a specific library within the company.

Path
library_idstringrequired

ID of the library to add the item to

Bodyapplication/jsonrequired
library_itemobject(LibraryItem5)required
Example: {"relateable_type":"Product","relateable_id":3,"order":1}
library_item.​relateable_typestringrequired
Example: "Product"
library_item.​relateable_idinteger(int32)required
Example: 3
library_item.​orderinteger(int32)required
Example: 1
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries/{library_id}/add_item_to_library' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "library_item": {
      "relateable_type": "Product",
      "relateable_id": 3,
      "order": 1
    }
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
titlestringrequired
slugstringrequired
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarybooleanrequired
affiliate_idinteger(int32)required
labelstringrequired
display_tagstringrequired
library_itemsArray of objects(LibraryItem3)required
Example: [{"id":1351,"order":1,"relateable_type":"Product","relateable":{"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}}]
library_items[].​idinteger(int32)required
Example: 1351
library_items[].​orderinteger(int32)required
Example: 1
library_items[].​relateable_typestringrequired
Example: "Product"
library_items[].​relateableobject(Relateable2)required
Example: {"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}
library_items[].​relateable.​idinteger(int32)required
Example: 2198
library_items[].​relateable.​activebooleanrequired
Example: true
library_items[].​relateable.​titlestringrequired
Example: "not again"
library_items[].​relateable.​descriptionobject(Description19)required
Example: {"id":2025,"name":"description","body":"<div>Minus eum proident, .</div>","record_type":"Product","record_id":1981,"created_at":"2022-06-17T09:25:58.301Z","updated_at":"2022-06-17T09:25:58.301Z","locale":null}
library_items[].​relateable.​description.​idinteger(int32)required
Example: 2025
library_items[].​relateable.​description.​namestringrequired
Example: "description"
library_items[].​relateable.​description.​bodystringrequired
Example: "<div>Minus eum proident, .</div>"
library_items[].​relateable.​description.​record_typestringrequired
Example: "Product"
library_items[].​relateable.​description.​record_idinteger(int32)required
Example: 1981
library_items[].​relateable.​description.​created_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​updated_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​localestringrequired
library_items[].​relateable.​strippedstringrequired
Example: "no not again never"
library_items[].​relateable.​pricestring
library_items[].​relateable.​display_pricestring
library_items[].​relateable.​subscription_pricestring
library_items[].​relateable.​display_subscription_pricestring
library_items[].​relateable.​wholesale_pricestring
library_items[].​relateable.​display_wholesale_pricestring
library_items[].​relateable.​wholesale_subscription_pricestring
library_items[].​relateable.​display_wholesale_subscription_pricestring
library_items[].​relateable.​shippingstring
Example: "1.0"
library_items[].​relateable.​imageobject(Image3)
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
library_items[].​relateable.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"
library_items[].​relateable.​skustring
Example: "not again"
library_items[].​relateable.​country_codestring
Example: "bt"
library_items[].​relateable.​country_idstring
library_items[].​relateable.​viewsinteger(int32)required
library_items[].​relateable.​leadsinteger(int32)required
library_items[].​relateable.​share_linkstringrequired
library_items[].​relateable.​commissionstring
Example: "10.0"
library_items[].​relateable.​publicboolean
Example: true
library_items[].​relateable.​shopify_idstring
library_items[].​relateable.​shopify_handlestring
library_items[].​relateable.​in_stockboolean
Example: true
library_items[].​relateable.​vendorstring
library_items[].​relateable.​price_rangeArray of strings
Example: ["Rs.0.00","Rs.156.00"]
library_items[].​relateable.​price_range_formattedstring
Example: "Rs.0.00 - Rs.156.00"
library_items[].​relateable.​unlimited_inventoryboolean
library_items[].​relateable.​default_variantobject(DefaultVariant18)
Example: {"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1}
library_items[].​relateable.​currency_symbolstring
Example: "$"
library_items[].​relateable.​currency_codestring
Example: "USD"
library_items[].​relateable.​average_ratinginteger(int32)
library_items[].​relateable.​option_valuesstring
library_items[].​relateable.​publish_to_retail_storeboolean
Example: true
library_items[].​relateable.​publish_to_rep_storeboolean
Example: true
library_items[].​relateable.​publish_to_share_tabboolean
Example: true
library_items[].​relateable.​hide_rating?boolean
Example: true
library_items[].​relateable.​hide_reviews?boolean
Example: true
library_items[].​relateable.​prompts_enabledbooleanrequired
library_items[].​relateable.​labelstringrequired
library_items[].​relateable.​display_tagstringrequired
library_items[].​relateable.​imagesArray of objects(Image9)
Example: [{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}]
library_items[].​relateable.​countriesArray of objects(Country7)
Example: [{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
library_items[].​relateable.​variantsArray of objects(Variant24)
Example: [{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}]
library_items[].​relateable.​optionsArray of Option3 (object) or Option31 (object)
Example: []
library_items[].​relateable.​promptsArray of stringsrequired
Example: []
library_items[].​relateable.​enroll_productsArray of strings
Example: []
library_items[].​relateable.​enrollment_packsArray of strings
Example: []
library_items[].​relateable.​user_idstring
library_items[].​relateable.​media_typestring
library_items[].​relateable.​media_formatstring
library_items[].​relateable.​video_urlstring
library_items[].​relateable.​pdf_urlstring
library_items[].​relateable.​kindstring
library_items[].​relateable.​visibilitystring
library_items[].​relateable.​watchstring
library_items[].​relateable.​video_statusstring
library_items[].​relateable.​durationinteger(int32)
library_items[].​relateable.​cta_urlstring
library_items[].​relateable.​cta_button_textstring
library_items[].​relateable.​cta_enabledboolean
library_items[].​relateable.​cta_action_typestring
library_items[].​relateable.​video_shopping_enabledboolean
library_items[].​relateable.​attached_shareablesArray of strings
Response
application/json; charset=utf-8
{
  "id": 0,
  "title": "string",
  "slug": "string",
  "share_link": "string",
  "views": 0,
  "leads": 0,
  "company_library": true,
  "affiliate_id": 0,
  "label": "string",
  "display_tag": "string",
  "library_items": [
    { … }
  ]
}

Delete Library Item

Request

Delete a specific library item associated with a company.

Path
idstringrequired

The ID of the library

Query
library_item_idstringrequired

The ID of the library item to be deleted

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries/{id}/destroy_library_item?library_item_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
titlestringrequired
slugstringrequired
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarybooleanrequired
affiliate_idinteger(int32)required
labelstringrequired
display_tagstringrequired
library_itemsArray of objects(LibraryItem3)required
Example: [{"id":1351,"order":1,"relateable_type":"Product","relateable":{"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}}]
library_items[].​idinteger(int32)required
Example: 1351
library_items[].​orderinteger(int32)required
Example: 1
library_items[].​relateable_typestringrequired
Example: "Product"
library_items[].​relateableobject(Relateable2)required
Example: {"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}
library_items[].​relateable.​idinteger(int32)required
Example: 2198
library_items[].​relateable.​activebooleanrequired
Example: true
library_items[].​relateable.​titlestringrequired
Example: "not again"
library_items[].​relateable.​descriptionobject(Description19)required
Example: {"id":2025,"name":"description","body":"<div>Minus eum proident, .</div>","record_type":"Product","record_id":1981,"created_at":"2022-06-17T09:25:58.301Z","updated_at":"2022-06-17T09:25:58.301Z","locale":null}
library_items[].​relateable.​description.​idinteger(int32)required
Example: 2025
library_items[].​relateable.​description.​namestringrequired
Example: "description"
library_items[].​relateable.​description.​bodystringrequired
Example: "<div>Minus eum proident, .</div>"
library_items[].​relateable.​description.​record_typestringrequired
Example: "Product"
library_items[].​relateable.​description.​record_idinteger(int32)required
Example: 1981
library_items[].​relateable.​description.​created_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​updated_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​localestringrequired
library_items[].​relateable.​strippedstringrequired
Example: "no not again never"
library_items[].​relateable.​pricestring
library_items[].​relateable.​display_pricestring
library_items[].​relateable.​subscription_pricestring
library_items[].​relateable.​display_subscription_pricestring
library_items[].​relateable.​wholesale_pricestring
library_items[].​relateable.​display_wholesale_pricestring
library_items[].​relateable.​wholesale_subscription_pricestring
library_items[].​relateable.​display_wholesale_subscription_pricestring
library_items[].​relateable.​shippingstring
Example: "1.0"
library_items[].​relateable.​imageobject(Image3)
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
library_items[].​relateable.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"
library_items[].​relateable.​skustring
Example: "not again"
library_items[].​relateable.​country_codestring
Example: "bt"
library_items[].​relateable.​country_idstring
library_items[].​relateable.​viewsinteger(int32)required
library_items[].​relateable.​leadsinteger(int32)required
library_items[].​relateable.​share_linkstringrequired
library_items[].​relateable.​commissionstring
Example: "10.0"
library_items[].​relateable.​publicboolean
Example: true
library_items[].​relateable.​shopify_idstring
library_items[].​relateable.​shopify_handlestring
library_items[].​relateable.​in_stockboolean
Example: true
library_items[].​relateable.​vendorstring
library_items[].​relateable.​price_rangeArray of strings
Example: ["Rs.0.00","Rs.156.00"]
library_items[].​relateable.​price_range_formattedstring
Example: "Rs.0.00 - Rs.156.00"
library_items[].​relateable.​unlimited_inventoryboolean
library_items[].​relateable.​default_variantobject(DefaultVariant18)
Example: {"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1}
library_items[].​relateable.​currency_symbolstring
Example: "$"
library_items[].​relateable.​currency_codestring
Example: "USD"
library_items[].​relateable.​average_ratinginteger(int32)
library_items[].​relateable.​option_valuesstring
library_items[].​relateable.​publish_to_retail_storeboolean
Example: true
library_items[].​relateable.​publish_to_rep_storeboolean
Example: true
library_items[].​relateable.​publish_to_share_tabboolean
Example: true
library_items[].​relateable.​hide_rating?boolean
Example: true
library_items[].​relateable.​hide_reviews?boolean
Example: true
library_items[].​relateable.​prompts_enabledbooleanrequired
library_items[].​relateable.​labelstringrequired
library_items[].​relateable.​display_tagstringrequired
library_items[].​relateable.​imagesArray of objects(Image9)
Example: [{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}]
library_items[].​relateable.​countriesArray of objects(Country7)
Example: [{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
library_items[].​relateable.​variantsArray of objects(Variant24)
Example: [{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}]
library_items[].​relateable.​optionsArray of Option3 (object) or Option31 (object)
Example: []
library_items[].​relateable.​promptsArray of stringsrequired
Example: []
library_items[].​relateable.​enroll_productsArray of strings
Example: []
library_items[].​relateable.​enrollment_packsArray of strings
Example: []
library_items[].​relateable.​user_idstring
library_items[].​relateable.​media_typestring
library_items[].​relateable.​media_formatstring
library_items[].​relateable.​video_urlstring
library_items[].​relateable.​pdf_urlstring
library_items[].​relateable.​kindstring
library_items[].​relateable.​visibilitystring
library_items[].​relateable.​watchstring
library_items[].​relateable.​video_statusstring
library_items[].​relateable.​durationinteger(int32)
library_items[].​relateable.​cta_urlstring
library_items[].​relateable.​cta_button_textstring
library_items[].​relateable.​cta_enabledboolean
library_items[].​relateable.​cta_action_typestring
library_items[].​relateable.​video_shopping_enabledboolean
library_items[].​relateable.​attached_shareablesArray of strings
Response
application/json; charset=utf-8
{
  "id": 0,
  "title": "string",
  "slug": "string",
  "share_link": "string",
  "views": 0,
  "leads": 0,
  "company_library": true,
  "affiliate_id": 0,
  "label": "string",
  "display_tag": "string",
  "library_items": [
    { … }
  ]
}

Clone Company Library

Request

Creates a copy of an existing company library with all its associated items and settings.

Path
idstringrequired

The ID of the company library to clone

Bodyapplication/jsonrequired
affiliate_idinteger(int32)required
Example: 2707
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries/{id}/clone_company_library' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "affiliate_id": 2707
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
Example: 1276
titlestringrequired
Example: "Edited Title-Copy"
slugstringrequired
Example: "edited-title-copy"
share_linkstringrequired
viewsinteger(int32)required
leadsinteger(int32)required
company_librarystringrequired
affiliate_idinteger(int32)required
Example: 2707
labelstringrequired
display_tagstringrequired
library_itemsArray of objects(LibraryItem8)required
Example: [{"id":1359,"order":1,"relateable_type":"Product","relateable":{"id":2206,"active":true,"title":"wallpaper","description":{"id":4745,"name":"description","body":"<div>wallpaper</div>","record_type":"Product","record_id":2206,"created_at":"2022-12-19T08:59:48.650Z","updated_at":"2022-12-19T08:59:48.650Z","locale":null},"stripped":"wallpaper","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","detail":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","full":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif"},"image_url":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","sku":"wallpaper","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.78.00","Rs.78.00"],"price_range_formatted":"Rs.78.00","unlimited_inventory":false,"default_variant":{"id":19537,"product_id":2206,"shopify_id":null,"title":"5","sku":null,"position":12611,"inventory_policy":"none","taxable":true,"inventory_quantity":-3,"created_at":"2022-12-23T09:31:41.111Z","updated_at":"2024-08-03T20:54:57.333Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":false,"discarded_at":null,"price":null,"weight":null,"size":null,"physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2053,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","full":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif"},"image_url":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19537,"title":"5","image_url":null,"buyable":true,"option_value_ids":[121],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127470,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127469,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127471,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]},{"id":19538,"title":"2","image_url":null,"buyable":true,"option_value_ids":[122],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127473,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127472,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127474,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]},{"id":19539,"title":"3","image_url":null,"buyable":true,"option_value_ids":[123],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127476,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127475,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127477,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]}],"options":[{"id":31,"title":"variant","position":21,"presentation":"variant"}],"prompts":[],"enroll_products":[],"enrollment_packs":[]}},{"id":1358,"order":2,"relateable_type":"Medium","relateable":{"id":4431,"user_id":null,"media_type":"share","media_format":"png","image_url":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/hCCYL9UwQw6UjENqRy84_kittya+snow+leopard+close1667812853.jpg","video_url":"","pdf_url":"","title":null,"description":{"id":4695,"name":"description","body":"<div>iui</div>","record_type":"Medium","record_id":4431,"created_at":"2022-11-28T11:17:27.644Z","updated_at":"2022-11-28T11:17:27.644Z","locale":null},"stripped":"iui","kind":"image","active":true,"visibility":null,"share_link":null,"views":0,"leads":0,"watch":null,"video_status":null,"duration":0,"cta_url":"","cta_button_text":"Learn More","cta_enabled":false,"cta_action_type":"visit_on_click","video_shopping_enabled":false,"prompts_enabled":false,"label":null,"display_tag":null,"prompts":[],"attached_shareables":[]}},{"id":1357,"order":3,"relateable_type":"Product","relateable":{"id":2198,"active":true,"title":"not again","description":{"id":4729,"name":"description","body":"<div>no not again never</div>","record_type":"Product","record_id":2198,"created_at":"2022-12-19T08:37:40.643Z","updated_at":"2022-12-19T08:37:40.643Z","locale":null},"stripped":"no not again never","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","sku":"not again","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.156.00"],"price_range_formatted":"Rs.0.00 - Rs.156.00","unlimited_inventory":false,"default_variant":{"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2047,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg","full":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg"},"image_url":"https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19511,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125486,"price":"156.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.156.00","country_iso":"BT","subscription_price":"156.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}},{"id":1356,"order":4,"relateable_type":"Product","relateable":{"id":2204,"active":true,"title":"lengthy image","description":{"id":4741,"name":"description","body":"<div>lengthy image</div>","record_type":"Product","record_id":2204,"created_at":"2022-12-19T08:58:13.978Z","updated_at":"2022-12-19T08:58:13.978Z","locale":null},"stripped":"lengthy image","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png","detail":"https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png","full":"https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png"},"image_url":"https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png","sku":"lengthy image","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.89.00"],"price_range_formatted":"Rs.0.00 - Rs.89.00","unlimited_inventory":false,"default_variant":{"id":19517,"product_id":2204,"shopify_id":null,"title":null,"sku":"lengthy image","position":12588,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:58:14.026Z","updated_at":"2024-08-03T20:54:57.333Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2052,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/VMYnhvE3QZNIN65Djnis_lengthy+image.png","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/VMYnhvE3QZNIN65Djnis_lengthy+image.png","full":"https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png"},"image_url":"https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19517,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":125495,"price":"89.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.89.00","country_iso":"BT","subscription_price":"89.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrollment_packs":[]}}]
library_items[].​idinteger(int32)required
Example: 1359
library_items[].​orderinteger(int32)required
Example: 1
library_items[].​relateable_typestringrequired
Example: "Product"
library_items[].​relateableobject(Relateable6)required
Example: {"id":2206,"active":true,"title":"wallpaper","description":{"id":4745,"name":"description","body":"<div>wallpaper</div>","record_type":"Product","record_id":2206,"created_at":"2022-12-19T08:59:48.650Z","updated_at":"2022-12-19T08:59:48.650Z","locale":null},"stripped":"wallpaper","price":null,"display_price":"","subscription_price":null,"display_subscription_price":null,"wholesale_price":null,"display_wholesale_price":"","wholesale_subscription_price":null,"display_wholesale_subscription_price":null,"shipping":"1.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","detail":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","full":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif"},"image_url":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","sku":"wallpaper","country_code":"bt","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.78.00","Rs.78.00"],"price_range_formatted":"Rs.78.00","unlimited_inventory":false,"default_variant":{"id":19537,"product_id":2206,"shopify_id":null,"title":"5","sku":null,"position":12611,"inventory_policy":"none","taxable":true,"inventory_quantity":-3,"created_at":"2022-12-23T09:31:41.111Z","updated_at":"2024-08-03T20:54:57.333Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":false,"discarded_at":null,"price":null,"weight":null,"size":null,"physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1},"currency_symbol":"$","currency_code":"USD","average_rating":0,"option_values":null,"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"hide_rating?":true,"hide_reviews?":true,"prompts_enabled":false,"label":null,"display_tag":null,"images":[{"id":2053,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","full":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif"},"image_url":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","position":null,"shopify_id":null}],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19537,"title":"5","image_url":null,"buyable":true,"option_value_ids":[121],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127470,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127469,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127471,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]},{"id":19538,"title":"2","image_url":null,"buyable":true,"option_value_ids":[122],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127473,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127472,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127474,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]},{"id":19539,"title":"3","image_url":null,"buyable":true,"option_value_ids":[123],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127476,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127475,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127477,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]}],"options":[{"id":31,"title":"variant","position":21,"presentation":"variant"}],"prompts":[],"enroll_products":[],"enrollment_packs":[]}
library_items[].​relateable.​idinteger(int32)required
Example: 2206
library_items[].​relateable.​activebooleanrequired
Example: true
library_items[].​relateable.​titlestringrequired
Example: "wallpaper"
library_items[].​relateable.​descriptionobject(Description19)required
Example: {"id":2025,"name":"description","body":"<div>Minus eum proident, .</div>","record_type":"Product","record_id":1981,"created_at":"2022-06-17T09:25:58.301Z","updated_at":"2022-06-17T09:25:58.301Z","locale":null}
library_items[].​relateable.​description.​idinteger(int32)required
Example: 2025
library_items[].​relateable.​description.​namestringrequired
Example: "description"
library_items[].​relateable.​description.​bodystringrequired
Example: "<div>Minus eum proident, .</div>"
library_items[].​relateable.​description.​record_typestringrequired
Example: "Product"
library_items[].​relateable.​description.​record_idinteger(int32)required
Example: 1981
library_items[].​relateable.​description.​created_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​updated_atstringrequired
Example: "2022-06-17T09:25:58.301Z"
library_items[].​relateable.​description.​localestringrequired
library_items[].​relateable.​strippedstringrequired
Example: "wallpaper"
library_items[].​relateable.​pricestring
library_items[].​relateable.​display_pricestring
library_items[].​relateable.​subscription_pricestring
library_items[].​relateable.​display_subscription_pricestring
library_items[].​relateable.​wholesale_pricestring
library_items[].​relateable.​display_wholesale_pricestring
library_items[].​relateable.​wholesale_subscription_pricestring
library_items[].​relateable.​display_wholesale_subscription_pricestring
library_items[].​relateable.​shippingstring
Example: "1.0"
library_items[].​relateable.​imageobject(Image3)
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
library_items[].​relateable.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif"
library_items[].​relateable.​skustring
Example: "wallpaper"
library_items[].​relateable.​country_codestring
Example: "bt"
library_items[].​relateable.​country_idstring
library_items[].​relateable.​viewsinteger(int32)required
library_items[].​relateable.​leadsinteger(int32)required
library_items[].​relateable.​share_linkstringrequired
library_items[].​relateable.​commissionstring
Example: "10.0"
library_items[].​relateable.​publicboolean
Example: true
library_items[].​relateable.​shopify_idstring
library_items[].​relateable.​shopify_handlestring
library_items[].​relateable.​in_stockboolean
Example: true
library_items[].​relateable.​vendorstring
library_items[].​relateable.​price_rangeArray of strings
Example: ["Rs.78.00","Rs.78.00"]
library_items[].​relateable.​price_range_formattedstring
Example: "Rs.78.00"
library_items[].​relateable.​unlimited_inventoryboolean
library_items[].​relateable.​default_variantobject(DefaultVariant18)
Example: {"id":19511,"product_id":2198,"shopify_id":null,"title":null,"sku":"not again","position":12580,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2022-12-19T08:37:40.716Z","updated_at":"2024-03-13T07:38:28.858Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":null,"unit_of_weight":null,"height":0,"width":0,"length":0,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":null,"active":true,"bar_code":null,"track_quantity":null,"keep_selling":null,"option_attrs":[],"allow_subscription":true,"subscription_only":false,"limit_subscription":false,"subscription_max_qty":null,"shipping_included_in_price":false,"subscription_interval":1}
library_items[].​relateable.​currency_symbolstring
Example: "$"
library_items[].​relateable.​currency_codestring
Example: "USD"
library_items[].​relateable.​average_ratinginteger(int32)
library_items[].​relateable.​option_valuesstring
library_items[].​relateable.​publish_to_retail_storeboolean
Example: true
library_items[].​relateable.​publish_to_rep_storeboolean
Example: true
library_items[].​relateable.​publish_to_share_tabboolean
Example: true
library_items[].​relateable.​hide_rating?boolean
Example: true
library_items[].​relateable.​hide_reviews?boolean
Example: true
library_items[].​relateable.​prompts_enabledbooleanrequired
library_items[].​relateable.​labelstringrequired
library_items[].​relateable.​display_tagstringrequired
library_items[].​relateable.​imagesArray of objects(Image9)
Example: [{"id":2053,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","full":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif"},"image_url":"https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif","position":null,"shopify_id":null}]
library_items[].​relateable.​countriesArray of objects(Country7)
Example: [{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
library_items[].​relateable.​variantsArray of objects(Variant28)
Example: [{"id":19537,"title":"5","image_url":null,"buyable":true,"option_value_ids":[121],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127470,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127469,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127471,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]},{"id":19538,"title":"2","image_url":null,"buyable":true,"option_value_ids":[122],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127473,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127472,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127474,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]},{"id":19539,"title":"3","image_url":null,"buyable":true,"option_value_ids":[123],"allow_subscription":true,"subscription_only":false,"shipping_included_in_price":false,"variant_countries":[{"id":127476,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.78.00","country_iso":"NP","subscription_price":"78.0","display_wholesale_price":"Rs.0.00","display_wholesale_subscription_price":"Rs.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":127475,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.78.00","country_iso":"BT","subscription_price":"78.0","display_wholesale_price":"Nu.0.00","display_wholesale_subscription_price":"Nu.0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":127477,"price":"78.0","shipping":"1.0","tax":"1.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋78.00","country_iso":"AF","subscription_price":"78.0","display_wholesale_price":"؋0.00","display_wholesale_subscription_price":"؋0.00","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}}]}]
library_items[].​relateable.​optionsArray of Option3 (object) or strings
Example: [{"id":31,"title":"variant","position":21,"presentation":"variant"}]
library_items[].​relateable.​promptsArray of stringsrequired
Example: []
library_items[].​relateable.​enroll_productsArray of strings
Example: []
library_items[].​relateable.​enrollment_packsArray of strings
Example: []
library_items[].​relateable.​user_idstring
library_items[].​relateable.​media_typestring
library_items[].​relateable.​media_formatstring
library_items[].​relateable.​video_urlstring
library_items[].​relateable.​pdf_urlstring
library_items[].​relateable.​kindstring
library_items[].​relateable.​visibilitystring
library_items[].​relateable.​watchstring
library_items[].​relateable.​video_statusstring
library_items[].​relateable.​durationinteger(int32)
library_items[].​relateable.​cta_urlstring
library_items[].​relateable.​cta_button_textstring
library_items[].​relateable.​cta_enabledboolean
library_items[].​relateable.​cta_action_typestring
library_items[].​relateable.​video_shopping_enabledboolean
library_items[].​relateable.​attached_shareablesArray of strings
Response
application/json; charset=utf-8
{
  "id": 1276,
  "title": "Edited Title-Copy",
  "slug": "edited-title-copy",
  "share_link": null,
  "views": 0,
  "leads": 0,
  "company_library": null,
  "affiliate_id": 2707,
  "label": null,
  "display_tag": null,
  "library_items": [
    { … },
    { … },
    { … },
    { … }
  ]
}

List Available Playlist Resources

Request

Retrieves the available resources that can be used in playlists.

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/fluid.api/company/libraries/available_resources_for_playlists \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8Array [
string
]
Response
application/json; charset=utf-8
[
  "Product",
  "Giveaway",
  "Medium",
  "Simulator",
  "Promotion",
  "CustomPage",
  "Library",
  "EnrollmentPack"
]

Media

Handle media assets such as images, videos, and documents that are used throughout the application. Includes functionality for upload, storage, and delivery of media content.

Operations

Messages

Messages are the core units of communication within Fluid’s platform, facilitating interactions between participants in a conversation. Each message can originate from either a user or a contact or an automated bot, allowing for dynamic exchanges ranging from simple text messages to more complex data payloads.

Messages support various use cases, whether it's delivering personalized responses via Response Bots, broadcasting announcements from Broadcast Bots, or regular user-to-user communication. The flexible structure of messages ensures that they can be tailored to suit different needs, providing a robust foundation for real-time interaction, automation, and seamless integration within the broader conversation framework.

Operations

Orders

Manage company orders using API endpoints.

Operations

Points

Manage points

Operations

ProductRedirects

Handle product URL redirects to maintain SEO value and ensure proper routing when product URLs change or products are moved within your catalog.

Operations

Products

Product API that can be used by external applications or admins.

Operations

Recipients

Manage Users for the company. Using this api you can list, create, update and delete the users for the company.

Operations

Social Media

Social Media is used to store the username for the companies various social media accounts.

Tiles

Tiles are a crucial feature in our admin portal, designed to facilitate Single Sign On (SSO) flows for users within the app. Each Tile represents a redirecting button within the user's app that links to a specific URL, with the addition of a temporary authorization token (auth_token) as a parameter.

Here's how the process works:

  1. In the admin portal, a new Tile is created. Each Tile is essentially a shortcut to a specific URL, such as https://www.example.com.
  2. The Tile appears in the user's app interface as a button, featuring a representative image. This makes it easy for users to identify and access.
  3. When an authorized User clicks on the Tile in app, an authorization token (auth_token) is generated and appended to the URL as a parameter. For example, https://www.example.com?auth_token=ABC123.
  4. When the user clicks on the Tile (button), they are automatically redirected to the URL embedded in the Tile, carrying the auth_token along.
  5. The user's browser then visits the URL, and the auth_token is passed to the link.
  6. The User Show API endpoint accepts the auth_token to fetch the user's details. This data can be utilized to automatically sign the user into their account, eliminating the need for manual login. Alternatively, it can be used to generate an app-in-an-app experience where the user navigates within a portion of your app as an authenticated user.

This Tile functionality streamlines the user experience, granting a smoother navigation process and easing user access with a Single Sign On (SSO) flow.

Note: auth_token expires after 30 minutes.

Operations

Users

Manage Users for the company. Using this api you can list, create, update and delete the users for the company.

Operations

Variants

Manage product variants including different sizes, colors, or other attributes that define unique versions of a product.

Operations

Webhooks

Webhook Events are generated by some Fluid resources when certain actions
are completed, such as the creation of an order, abandonment of cart, or
the deactivation of an user. By requesting events, your app can know
when certain actions have occurred in the fluid.

Webhook Overview

Operations

Get Company Social Media Usernames

Request

Returns the social media usernames for the company.

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/fluid.api/api/company/settings/social_media

Responses

Successful response

Bodyapplication/json
facebookstring
Example: "company_facebook"
twitterstring
Example: "company_twitter"
instagramstring
Example: "company_instagram"
linkedinstring
Example: "company_linkedin"
youtubestring
Example: "company_youtube"
tiktokstring
Example: "company_tiktok"
pintereststring
Example: "company_pinterest"
Response
application/json
{
  "facebook": "company_facebook",
  "twitter": "company_twitter",
  "instagram": "company_instagram",
  "linkedin": "company_linkedin",
  "youtube": "company_youtube",
  "tiktok": "company_tiktok",
  "pinterest": "company_pinterest"
}

Update Company Social Media Usernames

Request

Updates the social media usernames for the company.

Bodyapplication/jsonrequired
social_mediaobject
curl -i -X PUT \
  https://docs.fluid.app/_mock/docs/apis/fluid.api/api/company/settings/social_media \
  -H 'Content-Type: application/json' \
  -d '{
    "social_media": {
      "facebook": "updated_facebook",
      "twitter": "updated_twitter",
      "instagram": "updated_instagram",
      "linkedin": "updated_linkedin",
      "youtube": "updated_youtube",
      "tiktok": "updated_tiktok",
      "pinterest": "updated_pinterest"
    }
  }'

Responses

Successful update

Bodyapplication/json
facebookstring
Example: "updated_facebook"
twitterstring
Example: "updated_twitter"
instagramstring
Example: "updated_instagram"
linkedinstring
Example: "updated_linkedin"
youtubestring
Example: "updated_youtube"
tiktokstring
Example: "updated_tiktok"
pintereststring
Example: "updated_pinterest"
Response
application/json
{
  "facebook": "updated_facebook",
  "twitter": "updated_twitter",
  "instagram": "updated_instagram",
  "linkedin": "updated_linkedin",
  "youtube": "updated_youtube",
  "tiktok": "updated_tiktok",
  "pinterest": "updated_pinterest"
}

Customer Notes

Operations

Customers

Operations