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.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32074243","collectionId":"3268f07f-366c-4d1f-bed8-9c26203714b0","publishedId":"2sAY519fyh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-07T17:12:51.000Z"},"item":[{"name":"Company Admin API","item":[{"name":"Products","item":[{"name":"index","event":[{"listen":"test","script":{"id":"dfac6132-6279-4e5d-9b76-7a312d929c57","exec":["var template = `","","","| ID | ","Active | ","Title | ","Price | ","Display Price | ","Shipping | ","Country Code | ","Views | ","Leads | ","In Stock | ","
|---|---|---|---|---|---|---|---|---|---|
| {{id}} | ","{{active}} | ","{{title}} | ","{{price}} | ","{{display_price}} | ","{{shipping}} | ","{{country_code}} | ","{{views}} | ","{{leads}} | ","{{in_stock}} | ","
This endpoint retrieves the list of products for the company.
\nlang (string): The language code of the desired language.
If lang is not specified, the company's default language is used.
This is the 2 letter ISO language code. Examples: 'en', 'es', 'fr'
\nlang can be upper case or lower case
country_code (string): The country code for specifying the country. The currency and pricing will change depending on the country selected.
If country_code is not specified, the company's default country is used.
This is the 2 letter ISO country code. Examples: 'us', 'ca', 'es', 'fr'
\ncountry_code can be upper case or lower case
status (string): The status of the products.
Available statuses are ['active', 'draft', 'archived', 'all']
If status is not specified, the default status is 'active'
category_title (string): Case-sensitive title of category to filter by.
Retreives all products that are included in the specified category, and sub categories.
\nDo not use category_title if you are using category_id
category_id (integer): id of category to filter by.
Retreives all products that are included in the specified category, and sub categories.
\nDo not use category_id if you are using category_title
availability (string): Filter for the availability of the product.
Options are ['all', 'in_stock', 'keep_selling'].
If availablility is not specified, the default is 'all'.
collection_id (integer or array of integers): Filter by a collection or multiple collections.
order_by (string): Specify how the results are ordered.
Available order_by values are ['title', 'price', 'cv', 'created_at']
You can also add asc or desc to the string to specify the direction.
If you do not specify a direction, but you send a order_by value, it will default to asc.
If order_by is not specified, the default order is PRIORITY DESC
(To change the priority of a product, use the send_to_top API to set a product to the highest priority and move it to the top of the default order.)
\nAn array with details of products and their associated variants, variant_countries (pricing in different countries), collections, and images.
\n","urlObject":{"path":["api","company","v1","products"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"0bdd34a6-c882-480d-8830-27f4f3006f31","name":"index","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"country_code","value":"us","type":"text"},{"key":"status","value":"all","type":"text"},{"key":"lang","value":"en","type":"text"},{"key":"order_by","value":"price asc","type":"text"},{"key":"collection_id","value":"47","type":"text","disabled":true},{"key":"category_id","value":"40","type":"text"}]},"url":"fluid.lvh.me:3000/api/company/v1/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: mikeball AVOID eager loading detected Product =\\u003e [:reviews]\\n Remove from your query: .includes([:reviews])\"]"},{"key":"X-bullet-console-text","value":"[\"user: mikeball\\nAVOID eager loading detected\\n Product =\\u003e [:reviews]\\n Remove from your query: .includes([:reviews])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/v2/product_serializer.rb:41:in `sort_by'\\n /Users/mikeball/repos/fluid/app/serializers/v2/product_serializer.rb:41:in `as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:23:in `block in collection_as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:22:in `map'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:22:in `collection_as_hash'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/v1/base_controller.rb:68:in `render_models'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/v1/products_controller.rb:24:in `index'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"360192e94e40c977cada093467977519\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"02d28fe9-72e1-427b-85d9-7e66b676389a"},{"key":"X-Runtime","value":"0.799261"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=38.22, instantiation.active_record;dur=39.44, render.active_model_serializers;dur=0.21, process_action.action_controller;dur=379.68"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"981"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"products\": [\n {\n \"id\": 2260,\n \"slug\": \"dice-product\",\n \"category_id\": 40,\n \"active\": true,\n \"status\": \"active\",\n \"title\": \"Dice Product in English\",\n \"description\": \"Retrieve the details of a specific Product.
\n:id_or_slug (integor or string) Must be sent in the URL (Path).
id. Otherwise it will find the producting using the slug of the product.lang (string): The language code of the desired language.
If lang is not specified, the company's default language is used.
This is the 2 letter ISO language code. Examples: 'en', 'es', 'fr'
\nlang can be upper case or lower case
country_code (string): The country code for specifying the country. The currency and pricing will change depending on the country selected.
If country_code is not specified, the company's default country is used.
This is the 2 letter ISO country code. Examples: 'us', 'ca', 'es', 'fr'
\ncountry_code can be upper case or lower case
Details of the Product with associated variants, variant_countries (pricing in different countries), collections, and images.
\n","urlObject":{"path":["api","company","v1","products",":id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"46464bb7-7861-4fdc-903f-49cf4b8e4e99","type":"any","value":"","key":"id"}]}},"response":[{"id":"f4c43a86-ce15-420c-99e0-8db7334d84dc","name":"show","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"lang","value":"en","type":"text"},{"key":"country_code","value":"us","type":"text"}]},"url":"fluid.lvh.me:3000/api/company/v1/products/2200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: mikeball USE eager loading detected VariantCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\"]"},{"key":"X-bullet-console-text","value":"[\"user: mikeball\\nUSE eager loading detected\\n VariantCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/v2/variant_serializer.rb:18:in `block in variant_countries_in_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/variant_serializer.rb:17:in `variant_countries_in_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/variant_serializer.rb:12:in `as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:23:in `block in collection_as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:22:in `map'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:22:in `collection_as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/product_serializer.rb:41:in `as_hash'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/v1/products_controller.rb:196:in `render_product'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/v1/products_controller.rb:31:in `show'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"23300416d8b1ef629cf9cdf0b35117c7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f205d4e8-9233-402d-8152-85c346af9c90"},{"key":"X-Runtime","value":"0.103936"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=32.52, instantiation.active_record;dur=1.03, render.active_model_serializers;dur=0.20, process_action.action_controller;dur=60.68"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"914"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"product\": {\n \"id\": 2200,\n \"slug\": \"red-card\",\n \"category_id\": null,\n \"active\": true,\n \"status\": \"active\",\n \"title\": \"red card\",\n \"description\": \"Create a new Product.
\nAll of these paramaters must be nested underneath a product. See the example request.
sku (string) required - The default SKU for the product. You can add more variants with their SKU after product is created.
title (string) required - The product title.
image_url (string) required - A URL for the default image.
price (decimal) required
country_code paramater.shipping (decimal) requried - The shipping price.
status (string) requried - The status of the product.
Available statuses are ['active', 'draft', 'archived']
The default status is 'draft'
Optional Parameters
\ndescription (string): The description for the product.
introduction (string): Brief description of the product.
feature_text (string): Detailed information about the product, like tech specs or nutrition information.
upc (string): The UPC of the product.
category_id (integer): The id of the category to assign to the product.
subscription_price (decimal): The recurring monthly price. (If the product is a subscription.)
public (boolean): The product is available to the public. true or false
truein_stock (boolean): If in_stock is false, it won't be available for purchase, unless you have set keep_selling to true.
truekeep_selling (boolean): This allows you to keep selling items that are on backorder (out of stock). You can mark a product as in_stock: false, and set keep_selling: true and the item will still be available for people to purchase.
falseno_index (boolean): If set to true, it tells search engines not to include this product/page in their search results.
Must be implemented in the HTML of the platofrm displaying the product.
\nDefault is false.
Details of the newly created Product with associated variants, variant_countries (pricing in different countries), collections, and images.
\n","urlObject":{"path":["api","company","v1","products"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"9214059c-18ee-4116-b22a-a8b5c56ea173","name":"create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"sku\": \"PSKU83983\", //required\n \"title\": \"CM Test Product Name\", //required\n \"description\": \"test product description changed\", //optional\n \"image_url\": \"https://cdn.testimageurl.product\", //required\n \"price\": 99.8, //required\n \"shipping\": 4, //required\n \"status\": \"draft\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"teoma.lvh.me:3000/api/company/v1/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"1fd575ab78f52bcfe31839a04e224eac\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"17d9a593-c997-477c-a975-c2027a589e64"},{"key":"X-Runtime","value":"1.085867"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=151.66, instantiation.active_record;dur=34.10, unpermitted_parameters.action_controller;dur=0.00, transaction.active_record;dur=256.36, render.active_model_serializers;dur=0.14, process_action.action_controller;dur=504.88"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"848"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"product\": {\n \"id\": 7661,\n \"slug\": \"cm-test-product-name-22c87051-2d35-4076-886e-ac3eafc808b6\",\n \"category_id\": null,\n \"active\": false,\n \"status\": \"draft\",\n \"title\": \"CM Test Product Name\",\n \"description\": \"test product description changed\",\n \"introduction\": null,\n \"feature_text\": null,\n \"stripped\": \"test product description changed\",\n \"review_count\": 0,\n \"sku\": \"PSKU83983\",\n \"upc\": null,\n \"hs_code\": null,\n \"image_url\": \"https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL\",\n \"compressed_image_url\": null,\n \"image_path\": null,\n \"external_url\": null,\n \"price\": \"99.8\",\n \"display_price\": \"Rs.99.80 (NPR)\",\n \"subscription_price\": \"0.0\",\n \"currency_code\": \"NPR\",\n \"tax_category_id\": 5364,\n \"public\": true,\n \"in_stock\": true,\n \"keep_selling\": false,\n \"track_quantity\": true,\n \"no_index\": false,\n \"commission\": \"10.0\",\n \"affiliate_commission\": null,\n \"integration_id\": null,\n \"external_id\": null,\n \"last_synced_at\": null,\n \"category\": \"null\",\n \"collections\": [],\n \"images\": [],\n \"options\": [],\n \"variants\": [\n {\n \"id\": 29018,\n \"is_master\": true,\n \"title\": null,\n \"image_url\": null,\n \"buyable\": true,\n \"allow_subscription\": true,\n \"subscription_only\": false,\n \"shipping_included_in_price\": false,\n \"images\": [],\n \"variant_countries\": {\n \"BT\": {\n \"id\": 3247076,\n \"active\": true,\n \"currency_code\": \"BTN\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"Nu.99.80 (BTN)\",\n \"display_subscription_price\": \"Nu.0.00 (BTN)\",\n \"display_wholesale\": \"Nu.0.00 (BTN)\",\n \"display_wholesale_subscription_price\": \"Nu.0.00 (BTN)\"\n },\n \"IN\": {\n \"id\": 3247077,\n \"active\": true,\n \"currency_code\": \"INR\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"₹99.80 (INR)\",\n \"display_subscription_price\": \"₹0.00 (INR)\",\n \"display_wholesale\": \"₹0.00 (INR)\",\n \"display_wholesale_subscription_price\": \"₹0.00 (INR)\"\n },\n \"US\": {\n \"id\": 3247078,\n \"active\": true,\n \"currency_code\": \"USD\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"$99.80 (USD)\",\n \"display_subscription_price\": \"$0.00 (USD)\",\n \"display_wholesale\": \"$0.00 (USD)\",\n \"display_wholesale_subscription_price\": \"$0.00 (USD)\"\n },\n \"NP\": {\n \"id\": 3247079,\n \"active\": true,\n \"currency_code\": \"NPR\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"Rs.99.80 (NPR)\",\n \"display_subscription_price\": \"Rs.0.00 (NPR)\",\n \"display_wholesale\": \"Rs.0.00 (NPR)\",\n \"display_wholesale_subscription_price\": \"Rs.0.00 (NPR)\"\n },\n \"AF\": {\n \"id\": 3247080,\n \"active\": true,\n \"currency_code\": \"AFN\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"؋99.80 (AFN)\",\n \"display_subscription_price\": \"؋0.00 (AFN)\",\n \"display_wholesale\": \"؋0.00 (AFN)\",\n \"display_wholesale_subscription_price\": \"؋0.00 (AFN)\"\n }\n }\n }\n ]\n }\n }\n}"}],"_postman_id":"2bd95e93-01f4-470d-9268-6c7ea8691c14"},{"name":"update","id":"649d5122-e822-41a9-a1ac-9c9f53e2ec54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"sku\": \"PSKU83983\", //required\n \"title\": \"Test Product Name\", //required\n \"description\": \"test product description\", //optional\n \"image_url\": \"https://cdn.testimageurl.product\", //required\n \"active\": false, //required\n \"price\": 99.8, //required\n \"shipping\": 4 //required\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/v1/products/:id_or_sku","description":"Update an existing Product.
\n:id_or_sku (integer or string) required - This must be in the URL path.All of these paramaters must be nested underneath a product. See the example request.
\ntitle (string): The product title.
image_url (string): A URL for the default image.
price (decimal)
country_code paramater.shipping (decimal): The shipping price.
status (string): The status of the product.
Available statuses are ['active', 'draft', 'archived']
The default status is 'draft'
slug (string): A slug you can use in the product URL to improve SEO.
title, but it can be customized.description (string): The description for the product.
introduction (string): Brief description of the product.
feature_text (string): Detailed information about the product, like tech specs or nutrition information.
upc (string): The UPC of the product.
category_id (integer): The id of the category to assign to the product.
subscription_price (decimal): The recurring monthly price. (If the product is a subscription.)
public (boolean): The product is available to the public. true or false
truein_stock (boolean): If in_stock is false, it won't be available for purchase, unless you have set keep_selling to true.
truekeep_selling (boolean): This allows you to keep selling items that are on backorder (out of stock). You can mark a product as in_stock: false, and set keep_selling: true and the item will still be available for people to purchase.
falseno_index (boolean): If set to true, it tells search engines not to include this product/page in their search results.
Must be implemented in the HTML of the platofrm displaying the product.
\nDefault is false.
Details of the updated Product with associated variants, variant_countries (pricing in different countries), collections, and images.
\n","urlObject":{"path":["api","company","v1","products",":id_or_sku"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"type":"any","value":"","key":"id_or_sku"}]}},"response":[{"id":"4ae1ea8e-e3b9-497d-ac5e-512794a32ccc","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"sku\": \"PSKU83983\", //required\n \"title\": \"Test Product Name\", //required\n \"description\": \"test product description\", //optional\n \"image_url\": \"https://cdn.testimageurl.product\", //required\n \"country_code\": \"US\", //required\n \"active\": false, //required\n \"price\": 99.8, //required\n \"shipping\": 4 //required\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/v1/products/PSKU83983"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: mikeball USE eager loading detected VariantCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\"]"},{"key":"X-bullet-console-text","value":"[\"user: mikeball\\nUSE eager loading detected\\n VariantCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/v2/variant_serializer.rb:18:in `block in variant_countries_in_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/variant_serializer.rb:17:in `variant_countries_in_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/variant_serializer.rb:12:in `as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:23:in `block in collection_as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:22:in `map'\\n /Users/mikeball/repos/fluid/app/serializers/v2/base_serializer.rb:22:in `collection_as_hash'\\n /Users/mikeball/repos/fluid/app/serializers/v2/product_serializer.rb:41:in `as_hash'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/v1/products_controller.rb:201:in `render_product'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/v1/products_controller.rb:100:in `update'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:99:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:98:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"5ecbb7d7c3144fbcb282fbb3535a13ba\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"7155fb63-daff-4bc7-bc51-151ef3f2288f"},{"key":"X-Runtime","value":"0.332210"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=34.70, instantiation.active_record;dur=157.39, unpermitted_parameters.action_controller;dur=0.00, transaction.active_record;dur=58.99, render.active_model_serializers;dur=0.28, process_action.action_controller;dur=280.50"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"837"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"product\": {\n \"id\": 7658,\n \"slug\": \"cm-test-product-name-41130673-d0d4-4895-90f2-d9bdce8d1b91\",\n \"category_id\": null,\n \"active\": false,\n \"status\": \"draft\",\n \"title\": \"Test Product Name\",\n \"description\": \"test product description\",\n \"introduction\": null,\n \"feature_text\": null,\n \"stripped\": \"test product description\",\n \"review_count\": 0,\n \"sku\": \"PSKU83983\",\n \"upc\": null,\n \"hs_code\": null,\n \"image_url\": \"https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL\",\n \"compressed_image_url\": null,\n \"image_path\": null,\n \"external_url\": null,\n \"price\": \"99.8\",\n \"display_price\": \"Rs.99.80 (NPR)\",\n \"subscription_price\": \"0.0\",\n \"currency_code\": \"NPR\",\n \"tax_category_id\": 5364,\n \"public\": true,\n \"in_stock\": true,\n \"keep_selling\": false,\n \"track_quantity\": true,\n \"no_index\": false,\n \"commission\": \"10.0\",\n \"affiliate_commission\": null,\n \"integration_id\": null,\n \"external_id\": null,\n \"last_synced_at\": null,\n \"category\": \"null\",\n \"collections\": [],\n \"images\": [],\n \"options\": [],\n \"variants\": [\n {\n \"id\": 29015,\n \"is_master\": true,\n \"title\": null,\n \"image_url\": null,\n \"buyable\": true,\n \"allow_subscription\": true,\n \"subscription_only\": false,\n \"shipping_included_in_price\": false,\n \"images\": [],\n \"variant_countries\": {\n \"BT\": {\n \"id\": 3247063,\n \"active\": true,\n \"currency_code\": \"BTN\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"Nu.99.80 (BTN)\",\n \"display_subscription_price\": \"Nu.0.00 (BTN)\",\n \"display_wholesale\": \"Nu.0.00 (BTN)\",\n \"display_wholesale_subscription_price\": \"Nu.0.00 (BTN)\"\n },\n \"IN\": {\n \"id\": 3247064,\n \"active\": true,\n \"currency_code\": \"INR\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"₹99.80 (INR)\",\n \"display_subscription_price\": \"₹0.00 (INR)\",\n \"display_wholesale\": \"₹0.00 (INR)\",\n \"display_wholesale_subscription_price\": \"₹0.00 (INR)\"\n },\n \"US\": {\n \"id\": 3247065,\n \"active\": true,\n \"currency_code\": \"USD\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"$99.80 (USD)\",\n \"display_subscription_price\": \"$0.00 (USD)\",\n \"display_wholesale\": \"$0.00 (USD)\",\n \"display_wholesale_subscription_price\": \"$0.00 (USD)\"\n },\n \"NP\": {\n \"id\": 3247066,\n \"active\": true,\n \"currency_code\": \"NPR\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"Rs.99.80 (NPR)\",\n \"display_subscription_price\": \"Rs.0.00 (NPR)\",\n \"display_wholesale\": \"Rs.0.00 (NPR)\",\n \"display_wholesale_subscription_price\": \"Rs.0.00 (NPR)\"\n },\n \"AF\": {\n \"id\": 3247067,\n \"active\": true,\n \"currency_code\": \"AFN\",\n \"price\": \"99.8\",\n \"shipping\": \"4.0\",\n \"shipping_time\": null,\n \"subscription_price\": \"0.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"compare_price\": \"0.0\",\n \"display_price\": \"؋99.80 (AFN)\",\n \"display_subscription_price\": \"؋0.00 (AFN)\",\n \"display_wholesale\": \"؋0.00 (AFN)\",\n \"display_wholesale_subscription_price\": \"؋0.00 (AFN)\"\n }\n }\n }\n ]\n }\n }\n}"}],"_postman_id":"649d5122-e822-41a9-a1ac-9c9f53e2ec54"},{"name":"add_to_collection","id":"ee1eaaed-b9f3-441a-b8db-1535ed8c4e40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"collection_id","value":"47","type":"text"}]},"url":"fluid.lvh.me:3000/api/company/v1/products/2200/add_to_collection","description":"Add a Produt to a Collection.
\n:id (integer) required - The id of the product you want to assign to a collection.
collection_id (integer) required - The id of the collection.
Remove a Produt from a Collection.
\n:id (integer) required - The id of the product you want to remove from a collection.
collection_id (integer) required - The id of the collection.
Change the priority attribute of a product to the highest priority. This will move the product to the top of the default order in the index API.
\n:id (integer) required - The id of the product you want to remove from a collection.
Make a copy of an existing product. The new
\n:id (integer) required - The id of the product you want to copy.
Delete an existing Product.
\n:id (integer) required - The id of the product you want to delete.
Success or failure message.
\n","urlObject":{"path":["api","company","v1","products",":id_or_sku"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"726c055a-4ffc-49fe-ae56-b9382ff449dd","type":"any","value":"","key":"id_or_sku"}]}},"response":[{"id":"a251fefe-6bc2-488d-85f7-60cc08fee10c","name":"destroy","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"sku\": \"PSKU83983\", //required\n \"title\": \"Test Product Name\", //required\n \"description\": \"test product description\", //optional\n \"image_url\": \"https://cdn.testimageurl.product\", //required\n \"country_code\": \"US\", //required\n \"active\": false, //required\n \"price\": 99.8, //required\n \"shipping\": 4 //required\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"fluid.lvh.me:3000/api/company/v1/products/:id","host":["fluid.lvh.me:3000"],"path":["api","company","v1","products",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"a7d7109c2bb14e21851b17966d297a62\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ebd07db5-732c-44da-92f5-ee22d4b9f47a"},{"key":"X-Runtime","value":"0.307213"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=115.76, instantiation.active_record;dur=11.00, transaction.active_record;dur=166.43, enqueue.active_job;dur=0.34, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=257.32"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"81"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"product deleted\"\n }\n}"}],"_postman_id":"22cbaa9a-a5c9-4016-baf3-fd06fa911545"},{"name":"search_by_external_id","id":"41b4707c-a28f-4b44-8f91-e4c8f2e10910","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\": 4334246 // Required\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/v1/products/find_by_external_id","description":"This endpoint finds products from external_id.
\nexternal_id (numeric, required): External ID.Details of the products.
\n","urlObject":{"path":["api","company","v1","products","find_by_external_id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"41b4707c-a28f-4b44-8f91-e4c8f2e10910"}],"id":"e9b30b4c-8d1e-45c6-bf90-205986f75a91","description":"Product API that can be used by external applications or admins.
\n","_postman_id":"e9b30b4c-8d1e-45c6-bf90-205986f75a91","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Collections","item":[{"name":"index","event":[{"listen":"test","script":{"id":"dfac6132-6279-4e5d-9b76-7a312d929c57","exec":["var template = `","","","| ID | ","Active | ","Title | ","Price | ","Display Price | ","Shipping | ","Country Code | ","Views | ","Leads | ","In Stock | ","
|---|---|---|---|---|---|---|---|---|---|
| {{id}} | ","{{active}} | ","{{title}} | ","{{price}} | ","{{display_price}} | ","{{shipping}} | ","{{country_code}} | ","{{views}} | ","{{leads}} | ","{{in_stock}} | ","
This endpoint retrieves the list of collections.
\npublic (string): Filter the results by their public attribute.
Options are: ['true', 'false', 'all']
If public is not specified, the defaut is 'true'
An array with details of collections.
\n","urlObject":{"path":["api","company","v1","collections"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"5248f825-94dc-44a2-a765-937b6523d161","name":"index","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"fluid.lvh.me:3000/api/company/v1/collections?public=all","host":["fluid.lvh.me:3000"],"path":["api","company","v1","collections"],"query":[{"key":"public","value":"all"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"1f38cec26d0858939cb56009c4a58e48\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3e5445ac-7a6a-49e3-91e2-6936d0aa3cc2"},{"key":"X-Runtime","value":"0.527258"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=59.62, instantiation.active_record;dur=38.14, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=128.37"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"233"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"collections\": [\n {\n \"id\": 47,\n \"title\": \"Test Collection\",\n \"slug\": \"test-collection-d33a2aa6-0e4b-4793-99bf-b241993fcabb\",\n \"description\": null,\n \"image_path\": null,\n \"image_url\": null,\n \"position\": null,\n \"public\": true\n },\n {\n \"id\": 48,\n \"title\": \"Test Collection\",\n \"slug\": \"test-collection-64c656e3-ae5b-4fd1-a981-d876e6f28130\",\n \"description\": null,\n \"image_path\": null,\n \"image_url\": null,\n \"position\": null,\n \"public\": true\n },\n {\n \"id\": 50,\n \"title\": \"Test Collection 4\",\n \"slug\": \"test-collection-4\",\n \"description\": null,\n \"image_path\": null,\n \"image_url\": \"\",\n \"position\": null,\n \"public\": true\n }\n ]\n }\n}"},{"id":"c1e5c6c6-9416-4c10-8e3d-f17a9c4a611a","name":"index","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"fluid.lvh.me:3000/api/company/v1/collections?public=all","host":["fluid.lvh.me:3000"],"path":["api","company","v1","collections"],"query":[{"key":"public","value":"all"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"d31099ef16ea05f7d9442d8c04134fa2\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3be242bc-7525-4d53-ad12-127859e371f9"},{"key":"X-Runtime","value":"0.679830"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=16.02, instantiation.active_record;dur=165.84, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=227.30"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"384"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"collections\": [\n {\n \"id\": 56,\n \"title\": \"Collection is now public!\",\n \"slug\": \"test-collection-ftw\",\n \"description\": \"This is a great collection of incredible products!\",\n \"image_path\": \"\",\n \"image_url\": \"https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1\",\n \"position\": 1,\n \"public\": true\n },\n {\n \"id\": 48,\n \"title\": \"Test Collection\",\n \"slug\": \"test-collection-64c656e3-ae5b-4fd1-a981-d876e6f28130\",\n \"description\": null,\n \"image_path\": null,\n \"image_url\": null,\n \"position\": null,\n \"public\": true\n },\n {\n \"id\": 50,\n \"title\": \"Test Collection 4\",\n \"slug\": \"test-collection-4\",\n \"description\": null,\n \"image_path\": null,\n \"image_url\": \"\",\n \"position\": null,\n \"public\": true\n },\n {\n \"id\": 55,\n \"title\": \"Test Collection\",\n \"slug\": \"test-collection-2b637e1b-3524-4e20-afbe-8dba8000d1bb\",\n \"description\": \"true\",\n \"image_path\": \"\",\n \"image_url\": \"\",\n \"position\": null,\n \"public\": false\n },\n {\n \"id\": 49,\n \"title\": \"Test Collection\",\n \"slug\": \"test-collection-3\",\n \"description\": \"true\",\n \"image_path\": \"\",\n \"image_url\": \"\",\n \"position\": null,\n \"public\": false\n }\n ]\n }\n}"}],"_postman_id":"bda5da8f-abb7-4807-b508-2591252400fd"},{"name":"show","event":[{"listen":"test","script":{"id":"dfac6132-6279-4e5d-9b76-7a312d929c57","exec":["var template = `","","","| ID | ","Active | ","Title | ","Price | ","Display Price | ","Shipping | ","Country Code | ","Views | ","Leads | ","In Stock | ","
|---|---|---|---|---|---|---|---|---|---|
| {{id}} | ","{{active}} | ","{{title}} | ","{{price}} | ","{{display_price}} | ","{{shipping}} | ","{{country_code}} | ","{{views}} | ","{{leads}} | ","{{in_stock}} | ","
This endpoint retrieves a Collection object.
\nid for a Collection.
\nA Collection object.
\n","urlObject":{"path":["api","company","v1","collections",":id_or_slug"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"85daa5a9-7e2d-4489-b2e5-46fc1b7518e7","type":"any","value":"","key":"id_or_slug"}]}},"response":[{"id":"82cb3178-e3bd-4082-8569-4a9b50417c44","name":"show","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"fluid.lvh.me:3000/api/company/v1/collections/:id_or_slug","host":["fluid.lvh.me:3000"],"path":["api","company","v1","collections",":id_or_slug"],"variable":[{"key":"id_or_slug","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"a15bbd35a8811a22142d8b0faf1d5281\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"68c2f8b7-a4fb-467e-935a-6203656aeeaf"},{"key":"X-Runtime","value":"0.591936"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=62.27, instantiation.active_record;dur=28.86, render.active_model_serializers;dur=0.03, process_action.action_controller;dur=122.30"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"149"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"collection\": {\n \"id\": 49,\n \"title\": \"Test Collection\",\n \"slug\": \"test-collection-3\",\n \"description\": \"true\",\n \"image_path\": \"\",\n \"image_url\": \"\",\n \"position\": null,\n \"public\": false\n }\n }\n}"}],"_postman_id":"ff2f4281-176e-4294-8e18-a302d7e77947"},{"name":"create","id":"ffc49b71-a1bc-43b2-97b2-9f1f5fa8924f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"collection\": {\n \"title\": \"Test Collection FTW\",\n \"description\": \"This is a great collection of incredible products!\",\n \"image_url\": \"https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1\",\n \"image_path\": \"\",\n \"position\": 3,\n \"public\": true\n }\n}"},"url":"fluid.lvh.me:3000/api/company/v1/collections","description":"Create a new Collection.
\nAll of these paramaters must be nested underneath a collection. See the example request.
title (string) required - The title for the collection.description (string): The description of the collection.
slug (string): A slug you can use in the collection URL to improve SEO.
title, but it can be customized.image_url (string): A URL for the image to display for the collection.
position (integer): Used when sorting the collections in the Collections index API.
1 will apear higher in the results than 10.public (boolean): Choose to make the collection public or not.
Update a Collection.
\nAll of these paramaters must be nested underneath a collection. See the example request.
title (string): The title for the collection.
description (string): The description of the collection.
slug (string): A slug you can use in the collection URL to improve SEO.
title, but it can be customized.image_url (string): A URL for the image to display for the collection.
position (integer): Used when sorting the collections in the Collections index API.
1 will apear higher in the results than 10.public (boolean): Choose to make the collection public or not.
Delete a Collection.
\n:id (integer) required - The id of the collection. This must be in the URL path.Products can be organized under a collection or multiple collections.
\n","_postman_id":"950391dd-77c1-4723-88e1-dcdc5ecaec0a","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Categories","item":[{"name":"index","event":[{"listen":"test","script":{"id":"dfac6132-6279-4e5d-9b76-7a312d929c57","exec":["var template = `","","","| ID | ","Active | ","Title | ","Price | ","Display Price | ","Shipping | ","Country Code | ","Views | ","Leads | ","In Stock | ","
|---|---|---|---|---|---|---|---|---|---|
| {{id}} | ","{{active}} | ","{{title}} | ","{{price}} | ","{{display_price}} | ","{{shipping}} | ","{{country_code}} | ","{{views}} | ","{{leads}} | ","{{in_stock}} | ","
This endpoint retrieves a list of categories.
\nparent_id (integer): Retrieve the sub-categories from their parent category id.
parent_id.public (string): Filter the results by their public attribute.
Options are: ['true', 'false', 'all']
If public is not specified, the defaut is 'true'
include_children (boolean): Include any sub-categories organized underneath another category.
falsesource_type (string): The type of objects the categories are related to.
Options are: ['product', 'medium', 'custom_page', 'library', 'promotion']
If source_type is not specified, the default is 'product'
title (string): Parameter to filter the categories by title
An array with details of categories.
\n","urlObject":{"path":["api","company","v1","categories"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"00171636-6b4a-428e-b3e9-313b83088804","name":"index","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"public","value":"all","type":"text"},{"key":"include_children","value":"true","type":"text"},{"key":"parent_id","value":"40","type":"text","disabled":true},{"key":"source_type","value":"all","type":"text"}]},"url":"fluid.lvh.me:3000/api/company/v1/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"50bfd8f7a0c5cf2fafa063be54b4d946\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"25640332-b1a9-48aa-908f-4798e57251d1"},{"key":"X-Runtime","value":"0.498740"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=54.97, instantiation.active_record;dur=26.21, render.active_model_serializers;dur=0.03, process_action.action_controller;dur=113.54"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"285"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"categories\": [\n {\n \"id\": 40,\n \"title\": \"Updated Category Title\",\n \"description\": null,\n \"public\": false,\n \"source_type\": \"product\",\n \"image_url\": \"\",\n \"position\": 1,\n \"parent_id\": null,\n \"has_children\": true,\n \"sub_categories\": [\n {\n \"id\": 95,\n \"title\": \"Test Sub Category\",\n \"description\": \"Another great category. Underneath \\\"tops\\\".\",\n \"public\": true,\n \"source_type\": null,\n \"image_url\": \"\",\n \"position\": 1,\n \"parent_id\": 40,\n \"has_children\": false\n }\n ]\n },\n {\n \"id\": 96,\n \"title\": \"Another Category\",\n \"description\": \"More great products\",\n \"public\": true,\n \"source_type\": null,\n \"image_url\": \"\",\n \"position\": 1,\n \"parent_id\": null,\n \"has_children\": false,\n \"sub_categories\": []\n }\n ]\n }\n}"}],"_postman_id":"7730a35e-0fc5-4856-8ee4-e7b9062e3540"},{"name":"show","event":[{"listen":"test","script":{"id":"dfac6132-6279-4e5d-9b76-7a312d929c57","exec":["var template = `","","","| ID | ","Active | ","Title | ","Price | ","Display Price | ","Shipping | ","Country Code | ","Views | ","Leads | ","In Stock | ","
|---|---|---|---|---|---|---|---|---|---|
| {{id}} | ","{{active}} | ","{{title}} | ","{{price}} | ","{{display_price}} | ","{{shipping}} | ","{{country_code}} | ","{{views}} | ","{{leads}} | ","{{in_stock}} | ","
This endpoint retrieves a Category object.
\n:id (integer) - The id for the category. This must be in the URL path.
include_children (boolean) - Optional parameter to include any sub-categories organized underneath another category.
falseA Category object.
\n","urlObject":{"path":["api","company","v1","categories",":id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"cb131a0f-d2a0-48fa-8472-63ac90b85b53","type":"any","value":"","key":"id"}]}},"response":[{"id":"0c310849-318d-47e6-b188-ee60cdfe93c8","name":"show","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"include_children","value":"true","type":"text"}]},"url":{"raw":"fluid.lvh.me:3000/api/company/v1/categories/:id","host":["fluid.lvh.me:3000"],"path":["api","company","v1","categories",":id"],"query":[{"key":"","value":"true","disabled":true}],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"7fecc779744742c99f00341a6062fc66\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3369279a-cda2-4051-a5ce-7268961c9c9c"},{"key":"X-Runtime","value":"0.079611"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=4.09, instantiation.active_record;dur=0.47, render.active_model_serializers;dur=0.09, process_action.action_controller;dur=10.96"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"272"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"category\": {\n \"id\": 40,\n \"title\": \"Updated Category Title\",\n \"description\": null,\n \"public\": false,\n \"source_type\": \"product\",\n \"image_url\": \"\",\n \"position\": 1,\n \"parent_id\": null,\n \"has_children\": true,\n \"sub_categories\": [\n {\n \"id\": 95,\n \"title\": \"Test Sub Category\",\n \"description\": \"Another great category. Underneath \\\"tops\\\".\",\n \"public\": true,\n \"source_type\": null,\n \"image_url\": \"\",\n \"position\": 1,\n \"parent_id\": 40,\n \"has_children\": false\n },\n {\n \"id\": 98,\n \"title\": \"Another Test Sub Category\",\n \"description\": \"Another great category. Underneath \\\"tops\\\".\",\n \"public\": true,\n \"source_type\": \"product\",\n \"image_url\": \"\",\n \"position\": 1,\n \"parent_id\": 40,\n \"has_children\": false\n }\n ]\n }\n }\n}"}],"_postman_id":"bf3caa99-4b04-456f-92d3-786dc5f15840"},{"name":"create","id":"f859a943-f84f-40ee-88ae-146ed3b701f5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \"title\": \"Another Test Sub Category\",\n \"description\": \"Another great category. Underneath \\\"tops\\\".\",\n \"image_url\": \"\",\n \"position\": 1,\n \"public\": true,\n \"parent_id\": 40\n }\n}"},"url":"fluid.lvh.me:3000/api/company/v1/categories","description":"Create a new Category.
\nAll of these paramaters must be nested underneath a category. See the example request.
title (string) required - The title for the category.description (string): The description of the category.
image_url (string): A URL for the image to display for the collection.
position (integer): Used when sorting the categories in the Categories Index API.
1 will apear higher in the results than 10.public (boolean): Choose to make the category public or not.
parent_id (integer): The id of the parent cateogry. You can create Parent Category and Sub-Category relationships.
source_type (string): The type of object the category relates to.
Options are: ['product', 'medium', 'custom_page', 'library', 'promotion']
If source_type is not specified, the default is 'product'
Update a Category.
\nAll of these paramaters must be nested underneath a category. See the example request.
title (string): The title for the category.
description (string): The description of the category.
image_url (string): A URL for the image to display for the category.
position (integer): Used when sorting the categories in the Categories Index API.
1 will apear higher in the results than 10.public (boolean): Choose to make the category public or not.
parent_id (integer): The id of the parent cateogry. You can create Parent Category and Sub-Category relationships.
source_type (string): The type of object the category relates to.
Options are: ['product', 'medium', 'custom_page', 'library', 'promotion']
If source_type is not specified, the default is 'product'
This endpoint allows updating a specific cart identified by the provided cart_token. The request should be a HTTP PUT to fluid.lvh.me:3000/api/company/carts/xxyy.json. The request body should be in raw format and include the following fields:
event_id (string): The ID of the webhook event.date (string): The date of the cart update.customer_code (string): The ID of the guest or customer.currency_code (string): The currency code for the cart.country_code (string): The country code for the cart.ip (string): The IP address associated with the cart.abandoned (string): The date and time when the cart was abandoned.amount_total (number): The total amount for the cart.sub_total (number): The subtotal amount for the cart.tax_total (number): The total tax amount for the cart.shipping_total (number): The total shipping amount for the cart.discount_total (number): The total discount amount for the cart.cv_total (number): The total CV (Commissionable Volume) for the cart.qv_total (number): The total QV (Qualifying Volume) for the cart.fulfillment (string): The fulfillment method for the cart.payment_token (null): The payment token for the cart.payment_total (number): The total payment amount for the cart.repeat_order (boolean): Indicates if the order is a repeat order.shipping_options (array): An array of shipping options with code, name, price, delivery date, and surcharge.customer (object): Information about the customer including id, first name, last name, email, country, phone, and affiliate status.sponsor (object): Information about the sponsor including id, first name, email, phone, country, and active status.addresses (object): Object containing shipping and billing addresses with name, address1, address2, city, state, postal code, and country code.discounts (array): An array of discounts.lines (array): An array of line items with quantity, external ID, variant ID, and options.The response to the request will have a status code of 200 and will include the updated cart object with the respective fields described.
\n","urlObject":{"path":["api","company","carts","xxyy.json"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"970119d0-c082-4ada-a931-06aff3f9bf43","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"event_id\": \"webhook_event_id\", \n \"date\": \"2023-03-17T10:00:28+00:00\",\n \"customer_code\": \"Guest or customer id\",\n \"currency_code\": \"USD\",\n \"country_code\": \"NP\",\n \"ip\": \"10.2.4.14\",\n \"abandoned\": \"2023-04-17T10:00:28+00:00\",\n \"amount_total\": 52.23,\n \"sub_total\": 20,\n \"tax_total\": 10.23,\n \"shipping_total\": 14,\n \"discount_total\": 2.00,\n \"cv_total\": 200,\n \"qv_total\": 0,\n \"fulfillment\": \"fedex-ground\",\n \"payment_token\": null,\n \"payment_total\": 0.00,\n \"repeat_order\": true,\n \"shipping_options\": [\n {\n \"code\": \"fedex-ground\",\n \"name\": \"FedEx Ground\",\n \"price\": 14,\n \"delivery_date\": \"2023-05-06\",\n \"surcharge\": 10\n },\n {\n \"code\": \"ups_express\",\n \"name\": \"UPS 2-day Express Saver\",\n \"price\": 5.79,\n \"delivery_date\": \"2023-05-03\",\n \"surcharge\": 3\n }\n ],\n \"customer\": {\n \"id\": 32, // optional\n \"first_name\": \"Subas\",\n \"last_name\": \"Poudel\",\n \"email\": \"danphecoder@gmail.com\", \n \"country\": \"NP\",\n \"phone\": \"\",\n \"affiliate\": false\n },\n \"sponsor\": {\n \"id\": 44, //optional\n \"first_name\": \"Ankeet\",\n \"email\": \"ankeet@isawesome.com\",\n \"phone\": \"\",\n \"country\": \"NP\",\n \"active\": true\n },\n \"addresses\": {\n \"ship_to\": {\n \"name\": \"Customer Name\",\n \"address1\": \"1145 S 800 E Ste 110\",\n \"address2\": \"line 2\",\n \"city\": \"Orem\",\n \"state\": \"UT\",\n \"postal_code\": \"84097-7227\",\n \"country_code\": \"US\"\n },\n \"bill_to\": {\n \"name\": \"Customer Name\",\n \"address1\": \"1145 S 800 E Ste 110\",\n \"address2\": \"line 2\",\n \"city\": \"Orem\",\n \"state\": \"UT\",\n \"postal_code\": \"84097-7227\",\n \"country_code\": \"US\"\n }\n },\n \"discounts\": [],\n \"lines\": [\n {\n \"quantity\": 1,\n \"external_id\": \"2481\", // required\n \"variant\": {\n \"id\": 27265, // optional\n \"options\": [\n {\n \"id\": 1,\n \"type\": \"size\",\n \"value\": \"large\",\n \"presentation\": \"Large\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/carts/xxyy.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Tue, 19 Dec 2023 09:01:16 GMT"},{"key":"Report-To","value":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1702976477&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=lf3PfWsPYhD9TwkKV02DJJgVDXWqHVy6aoJ4ku7NAaE%3D\"}]}"},{"key":"Reporting-Endpoints","value":"heroku-nel=https://nel.heroku.com/reports?ts=1702976477&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=lf3PfWsPYhD9TwkKV02DJJgVDXWqHVy6aoJ4ku7NAaE%3D"},{"key":"Nel","value":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"Etag","value":"W/\"a1d32c54f5f2598d37cc994176956fc3\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"c29a14ff-088b-4291-8017-9eb6ee90b4cb"},{"key":"X-Runtime","value":"0.180549"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"cart\": {\n \"date\": \"2023-12-19T09:01:17.190Z\",\n \"customer_code\": 7319,\n \"currency_code\": \"USD\",\n \"country_code\": \"USA\",\n \"ip\": \"139.5.71.59\",\n \"abandoned\": null,\n \"source\": \"web\",\n \"total\": \"38.23\",\n \"sub_total\": \"20.0\",\n \"tax_total\": \"10.23\",\n \"shipping_total\": \"0.0\",\n \"enrollment_fee\": 0,\n \"discount_total\": 0,\n \"cv_total\": 0,\n \"fulfillment\": \"fedex-ground\",\n \"payment_token\": null,\n \"payment_total\": \"28.0\",\n \"subscription\": false,\n \"customer\": {\n \"email\": null,\n \"external_id\": null\n },\n \"sponsor\": {},\n \"addresses\": {\n \"ship_to\": {\n \"name\": \"Customer Name\",\n \"line1\": \"1145 S 800 E Ste 110\",\n \"line2\": \"line 2\",\n \"city\": \"Orem\",\n \"region\": \"UT\",\n \"postal_code\": \"84097-7227\",\n \"country\": \"US\"\n },\n \"bill_to\": {\n \"name\": \"Customer Name\",\n \"line1\": \"1145 S 800 E Ste 110\",\n \"line2\": \"line 2\",\n \"city\": \"Orem\",\n \"region\": \"UT\",\n \"postal_code\": \"84097-7227\",\n \"country\": \"US\"\n }\n },\n \"lines\": [\n {\n \"id\": 2481,\n \"images\": [\n \"https://ik.imagekit.io/fluid/s3/NjRJdhqcSR2b9QWyWDIz_Man_T-shirt.jpg\"\n ],\n \"item_id\": 8305,\n \"item_code\": \"\",\n \"title\": \"Man T-shirt\",\n \"description\": \"what is this tshirt all about. Is it good or is it bad\",\n \"quantity\": 1,\n \"amount\": 20,\n \"tax_code\": \"PF050621\",\n \"subscription\": false,\n \"cv\": 0,\n \"qv\": 0,\n \"tax\": \"0.0\",\n \"shipping\": \"0.0\",\n \"prices\": {\n \"price\": \"20.0\",\n \"subscription_price\": \"10.0\",\n \"wholesale\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\"\n },\n \"stock\": 2,\n \"track_stock\": true,\n \"variant\": {\n \"id\": 27265,\n \"display\": \"L\",\n \"options\": [\n {\n \"id\": 39,\n \"type\": \"size\",\n \"value\": \"l\",\n \"presentation\": \"L\"\n }\n ]\n }\n }\n ],\n \"cart_token\": \"HuSmS99wrjLfeehQgYLMjKHG\",\n \"cart_id\": 6583\n }\n}"}],"_postman_id":"df7fafc5-76cc-49ae-a3ef-111e0a112850"}],"id":"cb3c1983-07bc-4918-9928-3be487143d86","description":"Carts api that can be used for api call by webhooks of external applications or admins.
\n","_postman_id":"cb3c1983-07bc-4918-9928-3be487143d86","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Users","item":[{"name":"index","id":"9a0a9987-b6f2-4049-91f0-2f9475aec1f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/users?page=1","description":"This endpoint retrieves a list of company users.
\nMethod: GET
\nURL: fluid.lvh.me:3000/api/company/users
\nQuery Parameters:
\nStatus: 200 OK
\nBody:
\nAn array of user objects, each containing the following fields:
\nid (number): The user ID.
\nexternal_id (string, optional): The external ID of the user.
\nusername (string): The username of the user.
\nactive (boolean): Indicates if the user is active.
\nshare_guid(string): Unique shareable identifier for credit
\naffiliate (object):
\nid (number): The affiliate ID.
\nemail (string): The email of the affiliate.
\ncredit(string): unique identifier for affiliate
\nuser (object):
\nemail (string): The email of the user.
\nfirst_name (string): The first name of the user.
\nlast_name (string): The last name of the user.
\navatar (string): The avatar URL of the user.
\nphone (string): The phone number of the user.
\ngoogle_id (string): The Google ID of the user.
\nbio (string): The bio of the user.
\nfacebook (string): The Facebook profile URL of the user.
\ninstagram (string): The Instagram profile URL of the user.
\ntwitter (string): The Twitter profile URL of the user.
\nlinkedin (string): The LinkedIn profile URL of the user.
\nwhatsapp (string): The WhatsApp number of the user.
\nwechat (string): The WeChat ID of the user.
\nyoutube (string): The YouTube channel URL of the user.
\nzip_code (string): The ZIP code of the user.
\ndob (string): The date of birth of the user.
\ngender (string): The gender of the user.
\ntime_zone (string): The time zone of the user.
\nlanguage (object):
\nname (string): The name of the user's language.
\niso (string): The ISO code of the user's language.
\ncountry (object):
\nname (string): The name of the user's country.
\niso (string): The ISO code of the user's country.
\nThis API endpoint allows you to create a new user associated with a company. The request should be sent as an HTTP POST to fluid.lvh.me:3000/api/company/users/ with the required parameters in the request body.
\naffiliate: This is an object containing unique lookup parameters to associate the user with an affiliate. At least one of the following unique lookups is required: id, external_id, username, or email.username: The username of the user.external_id: The external ID of the user.active: A boolean value indicating whether the user is active.email: The email address of the user (required).first_name: The first name of the user.last_name: The last name of the user.avatar: The avatar of the user.phone: The phone number of the user.google_id: The Google ID of the user.bio: The bio of the user.facebook: The Facebook profile of the user.instagram: The Instagram profile of the user.twitter: The Twitter profile of the user.linkedin: The LinkedIn profile of the user.whatsapp: The WhatsApp number of the user.wechat: The WeChat ID of the user.youtube: The YouTube channel of the user.zip_code: The zip code of the user.dob: The date of birth of the user.gender: The gender of the user.time_zone: The time zone of the user.push_notifications: Notification preference for push notifications.email_notifications: Notification preference for email notifications.sms_notifications: Notification preference for SMS notifications.language_code: The language code for the user.country_code: The country code for the user.Upon successful creation, the API returns a status code of 201 along with the ID and other details of the newly created user.
\nExample Response:
\n{\n \"id\": 0,\n \"external_id\": \"\",\n \"username\": \"\",\n \"active\": true,\n \"affiliate\": {},\n \"user\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"\",\n \"phone\": \"\",\n \"google_id\": \"\",\n \"bio\": \"\",\n \"facebook\": \"\",\n \"instagram\": \"\",\n \"twitter\": \"\",\n \"linkedin\": \"\",\n \"whatsapp\": \"\",\n \"wechat\": \"\",\n \"youtube\": \"\",\n \"zip_code\": \"\",\n \"dob\": null,\n \"gender\": \"\",\n \"time_zone\": \"\",\n \"language\": {\n \"name\": \"\",\n \"iso\": \"\"\n },\n \"country\": {\n \"name\": \"\",\n \"iso\": \"\"\n }\n }\n}\nThis endpoint makes an HTTP GET request to retrieve user information for a specific company user with the ID 3470. The response will include details such as the user's ID, username, activity status, and user profile information like email, first name, last name, language, and country.
\nThe request does not include any payload or request body.
\nid (number): The unique identifier for the user.
external_id (string, nullable): The external identifier for the user.
username (string, nullable): The username of the user.
active (boolean): Indicates whether the user is active or not.
affiliate (object): Details about the user's affiliate.
share_guid (string): Unique shareable identifier for credit attribution
user (object): Additional user profile information including email, first name, last name, avatar, phone, social media handles, zip code, date of birth, gender, time zone, language, and country.
Example Response:
\n{\n \"id\": 3470,\n \"external_id\": null,\n \"username\": null,\n \"active\": true,\n \"affiliate\": {},\n \"share_guid\": \"mike\",\n \"user\": {\n \"email\": \"pralishkayastha@gmail.com\",\n \"first_name\": \"Yucatán\",\n \"last_name\": \"résumé\",\n \"avatar\": null,\n \"phone\": null,\n \"google_id\": null,\n \"bio\": null,\n \"facebook\": null,\n \"instagram\": null,\n \"twitter\": null,\n \"linkedin\": null,\n \"whatsapp\": null,\n \"wechat\": null,\n \"youtube\": null,\n \"zip_code\": null,\n \"dob\": null,\n \"gender\": null,\n \"time_zone\": null,\n \"language\": {\n \"name\": \"English\",\n \"iso\": \"en\"\n },\n \"country\": {\n \"name\": \"United States\",\n \"iso\": \"US\"\n }\n }\n}\n\nThis endpoint allows updating user information for a specific affiliate within the company. The request should be a PUT method to the specified URL with the affiliate ID in the path. The request body should contain the affiliate details along with the user's first name, last name, avatar, phone, social media handles, date of birth, gender, time zone, and notification preferences.
\naffiliate: Object containing unique lookup details for the affiliate (id, external_id, username, email)first_name: String, the first name of the userlast_name: String, the last name of the useravatar: String, URL of the user's avatarphone: String, the user's phone numbergoogle_id: String, Google ID of the userbio: String, a brief bio of the userfacebook: String, Facebook username of the userinstagram: String, Instagram username of the usertwitter: String, Twitter handle of the userlinkedin: String, LinkedIn profile of the userwhatsapp: String, WhatsApp number of the userwechat: String, WeChat ID of the useryoutube: String, YouTube channel of the userzip_code: String, the user's zip codedob: String (YYYY-MM-DD), the user's date of birthgender: String, the user's gendertime_zone: String, the user's time zonepush_notifications: String, user's preference for push notificationsemail_notifications: String, user's preference for email notificationssms_notifications: String, user's preference for SMS notificationsUpon successful execution, the response will have a status code of 200 and will return the updated user and affiliate details in the JSON format, including their IDs, email, first name, last name, avatar, phone, social media handles, date of birth, gender, time zone, language, and country.
\n","urlObject":{"path":["api","company","users","affiliate_id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"22806dc7-27b5-446c-9f4b-31f7d0d7962c","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"affiliate\": { // ONE OF THESE UNIQUE LOOKUPS ARE REQUIRED TO ASSOCIATE AN AFFILIATE\n \"id\": 3355, // Fluid UserCompany ID\n \"external_id\": null, // Unique external_id that matches external system\n \"username\": null, // Unique username from external system\n \"email\": null // Email of affiliate as recorded in Fluid\n },\n \"first_name\": \"testfirst\",\n \"last_name\": \"testlast\",\n \"avatar\": \"\",\n \"phone\": \"+14844145967\", // This phone number needs to to valid\n \"google_id\": \"julies.home\",\n \"bio\": \"hi im jules\",\n \"facebook\": \"jle\",\n \"instagram\": \"jules\",\n \"twitter\": \"jj\",\n \"linkedin\": \"ju\",\n \"whatsapp\": \"ul\",\n \"wechat\": \"9865326598\",\n \"youtube\": \"juleshome\",\n \"zip_code\": \"97655\",\n \"dob\": \"1997-08-08\",\n \"gender\": \"female\",\n \"time_zone\": \"CST\",\n \"push_notifications\": \"\",\n \"email_notifications\": \"\",\n \"sms_notifications\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/users/affiliate_id"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Tue, 19 Dec 2023 09:29:23 GMT"},{"key":"Report-To","value":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1702978163&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=rMalVFvJCxoa2CVv356EFlYOSeKECCseud4K1IznGT8%3D\"}]}"},{"key":"Reporting-Endpoints","value":"heroku-nel=https://nel.heroku.com/reports?ts=1702978163&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=rMalVFvJCxoa2CVv356EFlYOSeKECCseud4K1IznGT8%3D"},{"key":"Nel","value":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"Etag","value":"W/\"ed18ad2c9a74bd2892c64fab289ab51c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"eabb3b2d-55ca-4428-bfab-6d14c7f4bed7"},{"key":"X-Runtime","value":"0.072781"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3484,\n \"external_id\": null,\n \"username\": \"\",\n \"active\": true,\n \"affiliate\": {\n \"id\": 3355,\n \"email\": \"nitesh@tester.com\"\n },\n \"user\": {\n \"email\": \"juliete1411232111@google.com\",\n \"first_name\": \"testfirst\",\n \"last_name\": \"testlast\",\n \"avatar\": \"\",\n \"phone\": \"+14844145967\",\n \"google_id\": \"julies.home\",\n \"bio\": \"hi im jules\",\n \"facebook\": \"jle\",\n \"instagram\": \"jules\",\n \"twitter\": \"jj\",\n \"linkedin\": \"ju\",\n \"whatsapp\": \"ul\",\n \"wechat\": \"9865326598\",\n \"youtube\": \"juleshome\",\n \"zip_code\": \"97655\",\n \"dob\": \"1997-08-08\",\n \"gender\": \"female\",\n \"time_zone\": \"CST\",\n \"language\": {\n \"name\": \"English\",\n \"iso\": \"en\"\n },\n \"country\": {\n \"name\": \"United States\",\n \"iso\": \"US\"\n }\n }\n}"}],"_postman_id":"c4455a8c-27cc-4395-9b81-ca3b31e96adf"},{"name":"delete","id":"f6c49c63-2989-47f5-80e6-8ca2b03d979d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/users/123","description":"Endpoint to delete a user's record associated with the company, authenticated by its token.
\n","urlObject":{"path":["api","company","users","123"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"d5cba9c1-4ab9-42cc-8666-3f835485b9bb","name":"delete","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/users/123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"8b63967b1ad26414b56c327d2b1b66d2\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"2553abbc-f75f-4d2d-970b-5ef7662e6454"},{"key":"X-Runtime","value":"1.055724"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"User deleted successfully."}],"_postman_id":"f6c49c63-2989-47f5-80e6-8ca2b03d979d"}],"id":"6aa8e0ca-7121-4faa-a365-00c659021e3e","description":"Manage Users for the company. Using this api you can list, create, update and delete the users for the company.
\n","_postman_id":"6aa8e0ca-7121-4faa-a365-00c659021e3e","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Recipients","item":[{"name":"show","event":[{"listen":"prerequest","script":{"id":"b7f1641c-3ee9-4217-a3e5-794723b529e0","exec":[""],"type":"text/javascript","packages":{}}}],"id":"de8adf0c-2010-47ab-b63d-dd6ce148b42e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/recipients/63","description":"This endpoint makes an HTTP GET request to retrieve recipient's information for a specific company recipient with the ID 63.
\nThe request does not include any payload or request body.
\nemail (string): Email of the recipient
\nfirst_name (string, nullable): The first name for the recipient.
\nlast_name (string, nullable): The last name of the recipient.
\nphone (number, nullable): The phone number of the recipient.
\nExample Response:
\n{\n \"email\": \"john.doe@gmail.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"4085552442\"\n}\n\nManage Users for the company. Using this api you can list, create, update and delete the users for the company.
\n","_postman_id":"175c6908-255b-4a73-9abc-ceb91959e2df","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Orders","item":[{"name":"index","id":"a4ae29c5-a0b4-4af3-ac95-5beab0644e4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token","password":"company_token"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"fluid.lvh.me:3000/api/company/orders.json","description":"This API endpoint makes an HTTP GET request to retrieve a list of company orders in JSON format. The response contains an array of order objects, each with various fields describing the order details. Below is a description of the possible fields and their types in the API response:
\nPlease note that the actual values for the fields will be specific to each order and customer.
\n","urlObject":{"path":["api","company","orders.json"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"f79f07d7-94fb-472c-a23a-f8b4de140bb1","name":"index","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"fluid.lvh.me:3000/api/company/orders.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Tue, 19 Dec 2023 07:03:25 GMT"},{"key":"Report-To","value":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1702969394&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=%2ForUuNt0FykSCIXVw94zSxu5FpzK%2FuHr3Mbi5L%2BoAxk%3D\"}]}"},{"key":"Reporting-Endpoints","value":"heroku-nel=https://nel.heroku.com/reports?ts=1702969394&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=%2ForUuNt0FykSCIXVw94zSxu5FpzK%2FuHr3Mbi5L%2BoAxk%3D"},{"key":"Nel","value":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"Etag","value":"W/\"24c99e93f65bef295eaed537e878713f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f545ebd0-0946-4adf-9a69-d893834c15d4"},{"key":"X-Runtime","value":"11.518927"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 8768,\n \"order_number\": \"F32799720937756\",\n \"amount\": \"16900.0\",\n \"shipping\": \"650.0\",\n \"tax\": \"260.0\",\n \"subtotal\": \"12740.0\",\n \"first_name\": \"Bishal\",\n \"last_name\": \"Nepal\",\n \"email\": \"bnepal05579887@gmail.com\",\n \"phone\": null,\n \"tracking\": null,\n \"cv\": 5,\n \"qv\": 0,\n \"status\": \"awaiting_shipment\",\n \"order_type\": \"purchased\",\n \"rating\": 2,\n \"review\": \"\",\n \"referrer\": \"Bishal Nepal\",\n \"friendly_status\": \"paid\",\n \"type\": null,\n \"created_at\": \"2023-03-15T11:10:53.263Z\",\n \"currency_code\": \"NPR\",\n \"currency_symbol\": \"Rs.\",\n \"display_amount\": \"Rs.16,900.00 (NPR)\",\n \"display_subtotal\": \"Rs.12,740.00 (NPR)\",\n \"display_tax\": \"Rs.260.00 (NPR)\",\n \"display_shipping\": \"Rs.650.00 (NPR)\",\n \"display_refunds\": \"(0 CV, 0 QV) -Rs.0.00 (NPR)\",\n \"display_discount\": \"Rs.0.00 (NPR)\",\n \"order_thumbnail\": \"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg\",\n \"sale_date\": null,\n \"recognized_ship_date\": null,\n \"refundable\": true,\n \"max_refundable_amount\": \"16900.0\",\n \"max_refundable_tax\": \"260.0\",\n \"max_refundable_shipping\": \"650.0\",\n \"max_refundable_product_price\": \"12740.0\",\n \"display_enrollment_fee\": \"Rs.3,250.00 (NPR)\",\n \"ship_to\": {\n \"id\": 980199006,\n \"name\": \"Bishal Nepal\",\n \"address1\": \"jhapa\",\n \"address2\": null,\n \"address3\": null,\n \"city\": \"damak\",\n \"state\": \"Province 1\",\n \"postal_code\": \"mechi\",\n \"country_code\": null,\n \"country\": {\n \"id\": 141,\n \"iso_name\": \"NEPAL\",\n \"iso\": \"NP\",\n \"iso3\": \"NPL\",\n \"name\": \"Nepal\",\n \"numcode\": 524,\n \"active\": true,\n \"currency_code\": \"NPR\",\n \"currency_symbol\": \"Rs.\",\n \"separator\": \".\",\n \"delimiter\": \",\",\n \"address3\": false,\n \"state\": true,\n \"passport\": false,\n \"itn\": false,\n \"tax_rate\": 0,\n \"default\": false,\n \"created_at\": \"2022-05-09T05:12:21.806Z\",\n \"updated_at\": \"2022-05-09T05:12:21.806Z\",\n \"geo_entity_id\": 28\n },\n \"default\": false\n },\n \"contact\": {\n \"id\": 6557,\n \"token\": \"h59g4H8EExXpmNYmhq4woiMh\",\n \"first_name\": \"Bishal\",\n \"last_name\": \"Nepal\",\n \"avatar_url\": null,\n \"status\": null,\n \"email\": \"bnepal05579887@gmail.com\",\n \"email2\": null,\n \"phone\": null,\n \"phone2\": null,\n \"phone_id\": null,\n \"address\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"language_id\": null,\n \"country_id\": null,\n \"lead_type\": null,\n \"ip\": null,\n \"requested_at\": null,\n \"best_time\": null,\n \"time_zone\": null,\n \"reason\": null,\n \"income\": null,\n \"hours\": null,\n \"invest\": null,\n \"interest\": null,\n \"full_name\": \"Bishal Nepal\"\n },\n \"items\": [\n {\n \"id\": 8803,\n \"quantity\": 1,\n \"price\": 12740,\n \"ordered_variant\": \"\",\n \"sku\": \"sketch12\",\n \"product\": {\n \"id\": 2240,\n \"active\": true,\n \"title\": \"sketch\",\n \"description\": {\n \"id\": 4836,\n \"name\": \"description\",\n \"body\": \"This endpoint allows you to create a new order for a company. The HTTP POST request should be sent to fluid.lvh.me:3000/api/company/orders.json with a payload containing order details such as order number, customer information, affiliate details, shipping address, items, and amount paid.
\norder_number (required, string): A unique identifier for the order in the external system.customer_email (required, string): Email of the customer.customer_firstname (string): First name of the customer.customer_lastname (string): Last name of the customer.affiliate (object): An object containing the email of the affiliate as recorded in Fluid.email (string): Email of the affiliate.ship_to (object): An object containing the shipping address details.address1 (string): First line of the address.city (string): City of the address.state (string): State of the address.postal_code (string): Postal code of the address.items (array of objects): An array of items included in the order.sku (string): Stock Keeping Unit of the item.name (string): Name of the item.image_url (string): URL of the image of the item.quantity (number): Quantity of the item.unit_price (number): Price per unit of the item.amount_paid (required, number): Total amount paid for the order.The response will contain the details of the created order, including the order ID, order number, amount, shipping details, customer information, and item details.
\nExample Response:
\n{\n \"id\": 0,\n \"order_number\": \"K5124124\",\n \"amount\": \"\",\n \"shipping\": \"\",\n \"tax\": \"\",\n \"subtotal\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": null,\n ...\n}\n\nThis endpoint makes an HTTP GET request to retrieve information about a specific company order. The request should include the order ID in the URL path.
\nid (number): The unique identifier of the order.order_number (string): The order number associated with the order.amount (string): The total amount of the order.shipping (string): The shipping cost for the order.tax (string): The tax amount for the order.subtotal (string): The subtotal amount of the order.first_name (string): The first name of the customer.last_name (string): The last name of the customer.email (string): The email address of the customer.phone (string): The phone number of the customer.tracking (string): The tracking information related to the order.cv (number): CV information.qv (number): QV information.status (string): The status of the order.order_type (string): The type of the order.rating (number): The rating associated with the order.review (string): The review provided for the order.referrer (string): The referrer of the order.friendly_status (string): The friendly status of the order.type (string): The type of the order.created_at (string): The creation date of the order.currency_code (string): The currency code used for the order.currency_symbol (string): The currency symbol used for the order.display_amount (string): The displayed amount of the order.display_subtotal (string): The displayed subtotal amount of the order.display_tax (string): The displayed tax amount of the order.display_shipping (string): The displayed shipping amount of the order.display_refunds (string): The displayed refund amount of the order.display_discount (string): The displayed discount amount of the order.order_thumbnail (string): The thumbnail associated with the order.sale_date (string): The sale date of the order.recognized_ship_date (string): The recognized shipping date of the order.refundable (boolean): Indicates if the order is refundable.max_refundable_amount (string): The maximum refundable amount for the order.max_refundable_tax (string): The maximum refundable tax amount for the order.max_refundable_shipping (string): The maximum refundable shipping amount for the order.max_refundable_product_price (string): The maximum refundable product price for the order.display_enrollment_fee (string): The displayed enrollment fee for the order.ship_to (object): The shipping information associated with the order.contact (object): The contact information of the customer.items (array): An array of items included in the order.tracking_informations (array): An array of tracking information related to the order.Each item in the items array includes detailed information about the ordered products, such as their quantity, price, variants, and related product details.
This endpoint makes an HTTP PUT request to update information about a specific company order. The request should include the order ID in the URL path, and additional information pertaining to order that needs to be updated should be sent on body.
\nid (number): The unique identifier of the order.order_number (string): The order number associated with the order.amount (string): The total amount of the order.shipping (string): The shipping cost for the order.tax (string): The tax amount for the order.subtotal (string): The subtotal amount of the order.first_name (string): The first name of the customer.last_name (string): The last name of the customer.email (string): The email address of the customer.phone (string): The phone number of the customer.tracking (string): The tracking information related to the order.cv (number): CV information.qv (number): QV information.status (string): The status of the order.order_type (string): The type of the order.rating (number): The rating associated with the order.review (string): The review provided for the order.referrer (string): The referrer of the order.friendly_status (string): The friendly status of the order.type (string): The type of the order.created_at (string): The creation date of the order.currency_code (string): The currency code used for the order.currency_symbol (string): The currency symbol used for the order.display_amount (string): The displayed amount of the order.display_subtotal (string): The displayed subtotal amount of the order.display_tax (string): The displayed tax amount of the order.display_shipping (string): The displayed shipping amount of the order.display_refunds (string): The displayed refund amount of the order.display_discount (string): The displayed discount amount of the order.order_thumbnail (string): The thumbnail associated with the order.sale_date (string): The sale date of the order.recognized_ship_date (string): The recognized shipping date of the order.refundable (boolean): Indicates if the order is refundable.max_refundable_amount (string): The maximum refundable amount for the order.max_refundable_tax (string): The maximum refundable tax amount for the order.max_refundable_shipping (string): The maximum refundable shipping amount for the order.max_refundable_product_price (string): The maximum refundable product price for the order.display_enrollment_fee (string): The displayed enrollment fee for the order.ship_to (object): The shipping information associated with the order.contact (object): The contact information of the customer.items (array): An array of items included in the order.tracking_informations (array): An array of tracking information related to the order.Each item in the items array includes detailed information about the ordered products, such as their quantity, price, variants, and related product details.
This endpoint is used to delete a specific order belonging to a company. The HTTP DELETE request should be made to the specified URL with the order ID included in the endpoint. The request does not require a request body as the order ID is included in the URL.
\nDELETEfluid.lvh.me:3000/api/company/orders/8768.jsonThe response will indicate whether the order was deleted successfully or not. Possible response examples include:
\nManage company orders using API endpoints.
\n","_postman_id":"2d0c39bb-5241-4482-9858-f4a5a40ea0ae","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Orders V2","item":[{"name":"index","id":"a9d92705-4944-4cb3-9f2a-4aae40404549","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/v2/orders?search_query=:query&per_page=:per_page&page=:page_number","urlObject":{"path":["api","v2","orders"],"host":["fluid.lvh.me:3000"],"query":[{"disabled":true,"key":"unfulfilled","value":"true"},{"disabled":true,"key":"unpaid","value":"true"},{"disabled":true,"key":"archived","value":"true"},{"disabled":true,"key":"sorted_by","value":"created_at_desc"},{"key":"search_query","value":":query"},{"key":"per_page","value":":per_page"},{"key":"page","value":":page_number"}],"variable":[]}},"response":[{"id":"d088224b-d614-4d61-9de8-159192ce2627","name":"index","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/v2/orders?search_query=F1134797746806&per_page=10&page=1&date=01/07/2020-01/07/2024&status=awaiting_shipment&countries=US,NP&cart_source=mobile&type=member_order","host":["fluid.lvh.me:3000"],"path":["api","v2","orders"],"query":[{"key":"search_query","value":"F1134797746806","description":"Space separated terms. Can be order's email, phone, first_name, last_name, email, phone, order_number, external_id, products' sku, products' title, customer's first_name, customer's last_name customer's id"},{"key":"unfulfilled","value":"true","description":"Awaiting Shipment","disabled":true},{"key":"unpaid","value":"true","description":"Awaiting Payment","disabled":true},{"key":"archived","value":"true","description":"Archived orders","disabled":true},{"key":"sorted_by","value":"created_at_desc","disabled":true},{"key":"per_page","value":"10"},{"key":"page","value":"1"},{"key":"date","value":"01/07/2020-01/07/2024","description":"start_date-end_date, start_date-, -end_date\ndate format in mm/dd/yy"},{"key":"status","value":"awaiting_shipment","description":"\"awaiting_payment\", \"awaiting_shipment\", \"shipped\", \"delivered\", \"archived\", \"cancelled\", \"failed_payment\""},{"key":"countries","value":"US,NP","description":"comma separated iso"},{"key":"cart_source","value":"mobile","description":"mobile,web"},{"key":"type","value":"member_order","description":"\"sample_order\", \"customer_order\", \"member_order\", \"enrollment_order\", \"autoship_order\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"0aa295f5b854f10f0d5b207ec5bafce6\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"73e5ade8-20d6-4ffb-be52-b2f7c83db9da"},{"key":"X-Runtime","value":"2.757233"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=166.70, instantiation.active_record;dur=192.74, render.active_model_serializers;dur=0.18, process_action.action_controller;dur=1198.01"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"278"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"orders\": [\n {\n \"id\": 130,\n \"order_number\": \"F1134797746806\",\n \"created_at\": \"2024-11-12T09:23:55.352Z\",\n \"customer\": \"Sachin Germany\",\n \"channel\": \"Channel 2\",\n \"total\": \"565.0\",\n \"payment_status\": \"Paid\",\n \"fulfillment_status\": \"Unfulfilled\",\n \"items\": 1,\n \"delivery_status\": \"In Transit\",\n \"delivery_method\": \"Postal\",\n \"tags\": \"Tag 2\"\n }\n ],\n \"meta\": {\n \"total_count\": 1,\n \"total_pages\": 1,\n \"current_page\": 1\n }\n }\n}"}],"_postman_id":"a9d92705-4944-4cb3-9f2a-4aae40404549"},{"name":"stats","id":"e3b38327-7b40-41c0-97ab-33a0692389a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/v2/orders/stats","urlObject":{"path":["api","v2","orders","stats"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"77dc35dd-39ce-4e14-9151-69008de98701","name":"stats","originalRequest":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/v2/orders/stats"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"56b7ed9c941483035ee2bdcae4148bf5\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"554785ce-f6e9-4d9c-82f9-9c89cebdc57a"},{"key":"X-Runtime","value":"0.113601"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=3.90, instantiation.active_record;dur=0.47, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=20.77"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"88"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"total_orders\": 122,\n \"total_cancelled_orders\": 0\n }\n}"}],"_postman_id":"e3b38327-7b40-41c0-97ab-33a0692389a6"},{"name":"show","id":"ef15d84f-b2de-4e3c-b49b-37278c4cdb63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/v2/orders/:id","urlObject":{"path":["api","v2","orders",":id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"type":"any","value":"130","key":"id"}]}},"response":[{"id":"3274c2bd-e689-48b2-8cf2-2bb259f9b54d","name":"show","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/v2/orders/:id","host":["fluid.lvh.me:3000"],"path":["api","v2","orders",":id"],"variable":[{"key":"id","value":"130"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"8d2d79fb2869d6bfc8cc3485dc2a42c7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"12822a39-29d0-4e2a-ae22-999663e4463d"},{"key":"X-Runtime","value":"2.383523"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=184.67, instantiation.active_record;dur=234.80, render.active_model_serializers;dur=0.19, process_action.action_controller;dur=974.81"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"543"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"order\": {\n \"order_number\": \"F1134797746806\",\n \"created_at\": \"2024-11-12T09:23:55.352Z\",\n \"customer\": {\n \"full_name\": \"Sachin Germany\",\n \"email\": \"sachin4@germany.com\"\n },\n \"total\": \"€565,00 (EUR)\",\n \"sub_total\": \"€560,00 (EUR)\",\n \"shipping\": {\n \"amount\": \"€0,00 (EUR)\",\n \"surcharge\": \"€0,00 (EUR)\"\n },\n \"items_count\": 1,\n \"items\": [\n {\n \"title\": \"Zip Pack Sample Pack (30)\",\n \"sku\": \"FL145123ZP\",\n \"thumbnail\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/980190962/gotime.png\",\n \"price\": \"€560,00 (EUR)\",\n \"tax\": \"€0,00 (EUR)\",\n \"quantity\": 1,\n \"hs_code\": \"2202.10.0020\"\n }\n ],\n \"tax\": \"€0,00 (EUR)\",\n \"discount\": \"€0,00 (EUR)\",\n \"transaction_fee\": \"€0,00 (EUR)\",\n \"dynamic_charges\": {\n \"Handling\": \"€5,00 (EUR)\"\n },\n \"shipping_address\": {\n \"address1\": \"Pasewalker Straße 55\",\n \"address2\": null,\n \"city\": \"Pforzheim Eutingen\",\n \"state\": \"Baden-Wurttemberg\",\n \"postal_code\": \"75181\",\n \"subdivision_code\": null,\n \"country_code\": \"DE\"\n },\n \"billing_address\": {\n \"address1\": \"Pasewalker Straße 55\",\n \"address2\": null,\n \"city\": \"Pforzheim Eutingen\",\n \"state\": \"Baden-Wurttemberg\",\n \"postal_code\": \"75181\",\n \"subdivision_code\": null,\n \"country_code\": \"DE\"\n }\n }\n }\n}"}],"_postman_id":"ef15d84f-b2de-4e3c-b49b-37278c4cdb63"},{"name":"cancel","id":"6cf695f7-75fe-4fda-8ec5-b3005b67c033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"PATCH","header":[],"url":"fluid.lvh.me:3000/api/v2/orders/:id/cancel","urlObject":{"path":["api","v2","orders",":id","cancel"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"b4352e73-87e5-40e9-90e8-88f4c5589013","type":"any","value":"128","key":"id"}]}},"response":[{"id":"15e11fa6-28c4-406d-ad4e-20463314e4b0","name":"cancel","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"fluid.lvh.me:3000/api/v2/orders/:id/cancel","host":["fluid.lvh.me:3000"],"path":["api","v2","orders",":id","cancel"],"variable":[{"key":"id","value":"128"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"6c83aaa3f1f6f6e3fbe2d9bd0092593f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"923896d9-9d6e-4694-869d-17036f3fb935"},{"key":"X-Runtime","value":"2.817312"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=212.67, instantiation.active_record;dur=157.04, start_transaction.active_record;dur=0.03, transaction.active_record;dur=1872.70, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=1465.40"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"89"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"Order cancelled successfully\"\n }\n}"},{"id":"2110978c-4c04-4fa0-818c-b0be818148a9","name":"error","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"fluid.lvh.me:3000/api/v2/orders/:id/cancel","host":["fluid.lvh.me:3000"],"path":["api","v2","orders",":id","cancel"],"variable":[{"key":"id","value":"130"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"3118c6e8-5fce-4b7e-bb17-541a29e47be5"},{"key":"X-Runtime","value":"0.557645"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.10, sql.active_record;dur=74.48, instantiation.active_record;dur=2.90, render.active_model_serializers;dur=0.54, process_action.action_controller;dur=275.85"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"fail\",\n \"data\": {\n \"error\": \"Order cannot be cancelled\"\n }\n}"}],"_postman_id":"6cf695f7-75fe-4fda-8ec5-b3005b67c033"},{"name":"clone","id":"de999416-8732-4c9d-a220-db4407a71474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"POST","header":[],"url":"fluid.lvh.me:3000/api/orders/:id/clone","urlObject":{"path":["api","orders",":id","clone"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"f8db0019-aac8-4278-936c-7e5bf462c724","type":"any","value":"136","key":"id"}]}},"response":[{"id":"5965de7f-6713-4011-b561-2686789d2bb5","name":"clone","originalRequest":{"method":"POST","header":[],"url":{"raw":"fluid.lvh.me:3000/api/orders/:id/clone","host":["fluid.lvh.me:3000"],"path":["api","orders",":id","clone"],"variable":[{"key":"id","value":"136"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"c24231157eaca11f93af9711cc861fbe\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"199c006d-5c25-46ae-bd31-c72cd080b377"},{"key":"X-Runtime","value":"3.190115"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.03, sql.active_record;dur=145.08, instantiation.active_record;dur=131.75, start_transaction.active_record;dur=0.04, transaction.active_record;dur=1165.09, broadcast.action_cable;dur=44.81, render.active_model_serializers;dur=1265.53, process_action.action_controller;dur=2773.86"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"6715"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 141,\n \"products\": [\n {\n \"id\": 70,\n \"company_id\": 980190962,\n \"title\": \"Synergistic Steel Clock72\",\n \"description\": {\n \"id\": 79,\n \"name\": \"description\",\n \"body\": \"Orders V2 API
\n","_postman_id":"582f3eb0-ae57-466d-b1ce-fa19f6d4eb30","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Contacts","item":[{"name":"create","id":"b248e71b-1257-4d88-8726-71f5ab6d0f3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"first_name\": \"contact_first_name\", //required.\n \"last_name\": \"contact_last_name\", //required.\n \"language_code\": \"en\",\n \"country_code\": \"US\",\n \"status\": \"cold\", // either 'cold' or 'hot' if provided.\n \"email\": \"contact_email@gmail.com\",\n \"email2\": \"contact_email_2@gmail.com\",\n \"phone\": \"+00198338838838\",\n \"phone2\": \"+0019485858758\",\n \"address\": \"N Main Street\",\n \"address2\": \"Apt No. 010\",\n \"city\": \"N Main\",\n \"state\": \"GA\",\n \"postal_code\": \"3884\",\n \"avatar_url\": \"https://cdn.contact_image_url.com/image.jpg\",\n \"lead_type\": null,\n \"best_time\": null,\n \"time_zone\": null,\n \"reason\": null,\n \"income\": null,\n \"hours\": null,\n \"invest\": null,\n \"interest\": null,\n \"affiliate\": { //optional, if not provided, empty ({}) or all the values are null, then contact will be created under company to assign as a lead\n \"id\": null,\n \"external_id\": null,\n \"username\": null,\n \"email\": \"tingeym2@gmail.com\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/contacts","urlObject":{"path":["api","company","contacts"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"5c30079e-fb1f-438c-a3a7-062ed9269b4f","name":"create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"first_name\": \"Ash\", //required.\n \"last_name\": \"Ketchum\", //required.\n \"language_code\": \"en\",\n \"country_code\": \"US\",\n \"status\": \"cold\", // either 'cold' or 'hot' if provided.\n \"email\": \"contact_email@gmail.com\",\n \"email2\": \"contact_email_2@gmail.com\",\n \"phone\": \"+00198338838838\",\n \"phone2\": \"+0019485858758\",\n \"address\": \"N Main Street\",\n \"address2\": \"Apt No. 010\",\n \"city\": \"N Main\",\n \"state\": \"GA\",\n \"postal_code\": \"3884\",\n \"avatar_url\": \"https://cdn.contact_image_url.com/image.jpg\",\n \"lead_type\": null,\n \"best_time\": null,\n \"time_zone\": null,\n \"reason\": null,\n \"income\": null,\n \"hours\": null,\n \"invest\": null,\n \"interest\": null,\n \"affiliate\": { //optional, if not provided, empty ({}) or all the values are null, then contact will be created under company to assign as a lead\n \"id\": null,\n \"external_id\": null,\n \"username\": null,\n \"email\": \"tingeym2@gmail.com\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/contacts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"20fd1168b808ca957e4fcb6236731d5f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"65815c9e-ddd1-4d05-a072-6e770083366e"},{"key":"X-Runtime","value":"1.281519"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 28,\n \"token\": \"jmUbn5Ge7cGykVFL4CCWecnQ\",\n \"first_name\": \"Ash\",\n \"last_name\": \"Ketchum\",\n \"avatar_url\": \"https://cdn.contact_image_url.com/image.jpg\",\n \"status\": \"cold\",\n \"email\": \"contact_email@gmail.com\",\n \"email2\": \"contact_email_2@gmail.com\",\n \"phone\": \"+00198338838838\",\n \"phone2\": \"+0019485858758\",\n \"phone_id\": null,\n \"address\": \"N Main Street\",\n \"address2\": \"Apt No. 010\",\n \"city\": \"N Main\",\n \"state\": \"GA\",\n \"postal_code\": \"3884\",\n \"language_id\": 980190962,\n \"country_id\": 214,\n \"lead_type\": null,\n \"ip\": null,\n \"requested_at\": null,\n \"best_time\": null,\n \"time_zone\": null,\n \"reason\": null,\n \"income\": null,\n \"hours\": null,\n \"invest\": null,\n \"interest\": null,\n \"full_name\": \"Ash Ketchum\",\n \"activities\": []\n}"}],"_postman_id":"b248e71b-1257-4d88-8726-71f5ab6d0f3d"}],"id":"803d1df9-9966-42e0-a777-7402a85df905","_postman_id":"803d1df9-9966-42e0-a777-7402a85df905","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Activities","item":[{"name":"create","id":"7338a667-b7aa-4c75-a59f-09d6459a1a95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"activity\": {\n \"title\": \"hello activity\", //required\n \"description\": \"hello activity description here.\",\n \"affiliate\": { // required, one of the key/value\n \"id\": null,\n \"external_id\": \"sammysample12\", // primary key on external systems\n \"username\": null,\n \"email\": null,\n \"legacy_number\": \"150010\" // legacy number from external system\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/activities","urlObject":{"path":["api","company","activities"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"2016a98c-85fb-44ce-9c48-5b5c17e5c9a6","name":"create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"activity\": {\n \"title\": \"hello world\", //required\n \"description\": \"happy new year.\",\n \"affiliate\": { // required, one of the key/value\n \"id\": null,\n \"external_id\": \"sammysample12\", // primary key on external systems\n \"username\": null,\n \"email\": \"tingeym2@gmail.com\",\n \"legacy_number\": \"150010\" // legacy number from external system\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/activities"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"c2953196a771bd3b85cca717c42f42fe\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"2db90184-e265-4c37-8ae6-d313f1ba6859"},{"key":"X-Runtime","value":"0.066838"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 17,\n \"user_id\": 1,\n \"title\": \"hello world\",\n \"description\": \"happy new year.\",\n \"read_at\": null,\n \"created_at\": \"2024-01-04T08:06:12.267Z\",\n \"relation_type\": null,\n \"company_id\": 980190962,\n \"relation\": null,\n \"contact\": null,\n \"visitor\": null\n}"}],"_postman_id":"7338a667-b7aa-4c75-a59f-09d6459a1a95"}],"id":"91af0f9a-f647-457a-884f-71516f13c1c7","_postman_id":"91af0f9a-f647-457a-884f-71516f13c1c7","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Points","item":[{"name":"index","id":"628661f3-f69b-4915-b72c-c41a0b68c176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/points?username=sammysample12","urlObject":{"path":["api","company","points"],"host":["fluid.lvh.me:3000"],"query":[{"disabled":true,"key":"id","value":""},{"disabled":true,"key":"external_id","value":""},{"key":"username","value":"sammysample12"},{"disabled":true,"key":"email","value":""}],"variable":[]}},"response":[{"id":"80e77dd3-66a2-4ec1-9546-642983e67901","name":"index","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"}],"url":{"raw":"fluid.lvh.me:3000/api/company/points?username=sammysample12","host":["fluid.lvh.me:3000"],"path":["api","company","points"],"query":[{"key":"id","value":"","disabled":true},{"key":"external_id","value":"","disabled":true},{"key":"email","value":"","disabled":true},{"key":"username","value":"sammysample12"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"6dc40d7516e293ceec97d604852b6de5\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"9090dbfb-abf5-4d65-aaa8-977398aac0b1"},{"key":"X-Runtime","value":"0.026985"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 62,\n \"points\": 122,\n \"slug\": \"best\",\n \"point_type\": \"fantasy\",\n \"title\": \"We rock\",\n \"description\": \"We make earning fun\",\n \"created_at\": \"2024-01-04T08:11:23.388Z\"\n },\n {\n \"id\": 61,\n \"points\": 25,\n \"slug\": \"order\",\n \"point_type\": \"fantasy\",\n \"title\": \"a placed an order on Fluid\",\n \"description\": \"Order ID: 54. Amount: 120.96\",\n \"created_at\": \"2023-12-27T12:48:04.375Z\"\n }\n]"}],"_postman_id":"628661f3-f69b-4915-b72c-c41a0b68c176"},{"name":"show","id":"bc3f109f-deb7-4dde-b738-5ae662e95a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"fluid.lvh.me:3000/api/company/points/2","urlObject":{"path":["api","company","points","2"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"672b401c-3532-41ab-b43d-be4d9bb91134","name":"show","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"fluid.lvh.me:3000/api/company/points/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"de6633e662d43e2644c07756442aeafc\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"e5d6e62d-f160-495e-b47a-59db12c07bb5"},{"key":"X-Runtime","value":"0.902509"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"points\": 1,\n \"slug\": \"initial\",\n \"point_type\": \"giveaway\",\n \"title\": \"Welcome to Fluid's giveaways platform!\",\n \"description\": \"Welcome to Fluid! Your first point is here just because you signed up. Start sharing and see your entries explode!\",\n \"created_at\": \"2023-12-26T04:48:56.940Z\"\n}"}],"_postman_id":"bc3f109f-deb7-4dde-b738-5ae662e95a96"},{"name":"create","id":"f8e5ae28-6406-45d6-8f65-195d5859c093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"first_name\": \"Anand\",\n \"last_name\": \"Shrestha\",\n \"email\": \"anand@fluid.app\",\n \"password\": \"password321#\"\n },\n \"company\": {\n \"name\": \"ABC co. ltd\",\n \"subdomain\": \"anand\",\n \"domain\": \"https://abc.com\",\n \"color\": \"#3461FF\",\n \"onboarding_info\": {\n \"back_office\": \"exigo\",\n \"website_setup\": \"current\",\n \"checkout_experience\": \"standard\",\n \"payment_methods\": [\n \"credit-card\"\n ],\n \"usage_type\": \"business\",\n \"phone\": \"+84123456789\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company","urlObject":{"path":["api","company"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"a5038327-734a-4ef9-a784-9944d3546e9b","name":"create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"point\": {\n \"title\": \"hello point\", //required\n \"points\": 5, //required, value should be positive integer.\n \"point_type\": \"fantasy\", //optional, value can only be 'fantasy' or 'giveaway' if provided, otherwise defaults to 'giveaway' if not provided.\n \"description\": \"hello point description here.\",\n \"affiliate\": { // required, one of the key/value is required\n \"id\": null,\n \"external_id\": null,\n \"username\": \"sammysample12\",\n \"email\": null\n }\n }\n}"},"url":"fluid.lvh.me:3000/api/company/points"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"73ec7cc72b0ccac3f151f92b9c099323\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0fb00503-ad26-4425-9797-e46d5a37a500"},{"key":"X-Runtime","value":"0.204328"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 63,\n \"points\": 5,\n \"slug\": \"imported\",\n \"point_type\": \"fantasy\",\n \"title\": \"hello point\",\n \"description\": \"hello point description here.\",\n \"created_at\": \"2024-01-04T08:18:16.346Z\"\n}"}],"_postman_id":"f8e5ae28-6406-45d6-8f65-195d5859c093"},{"name":"update","id":"6a917f00-6423-4135-ad67-102124a13352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"point\": {\n \"title\": \"hello point update\", //required\n \"points\": 3, //required, value should be positive integer.\n \"point_type\": \"giveaway\", //optional, value can only be 'fantasy' or 'giveaway' if provided, otherwise defaults to 'giveaway' if not provided.\n \"description\": \"hello point description updated.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/points/69","urlObject":{"path":["api","company","points","69"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"aa1e2323-54b6-46ce-8512-8ffeb423ef4a","name":"update","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"point\": {\n \"title\": \"hello point update\", //required\n \"points\": 3, //required, value should be positive integer.\n \"point_type\": \"giveaway\", //optional, value can only be 'fantasy' or 'giveaway' if provided, otherwise defaults to 'giveaway' if not provided.\n \"description\": \"hello point description updated.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/points/63"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"0494d04de00e974a2260feb7bb2cfe50\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"51287df4-6af9-4069-b63d-dafb82a17868"},{"key":"X-Runtime","value":"0.035778"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 63,\n \"points\": 3,\n \"slug\": \"imported\",\n \"point_type\": \"giveaway\",\n \"title\": \"hello point update\",\n \"description\": \"hello point description updated.\",\n \"created_at\": \"2024-01-04T08:18:16.346Z\"\n}"}],"_postman_id":"6a917f00-6423-4135-ad67-102124a13352"},{"name":"destroy","id":"64efa34c-3a89-408c-aefc-14ae5dc0375a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"DELETE","header":[],"url":"fluid.lvh.me:3000/api/company/points/12","urlObject":{"path":["api","company","points","12"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"5d360bc2-bf97-4acb-9844-b73dfd8c7cc8","name":"destroy","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer api_token\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"fluid.lvh.me:3000/api/company/points/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"5c19c07aa88e9f5c40636bfe7724d50f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"cc0b4962-068d-4fa6-a008-64166b7440d1"},{"key":"X-Runtime","value":"0.057514"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"Point deleted successfully."}],"_postman_id":"64efa34c-3a89-408c-aefc-14ae5dc0375a"}],"id":"7151b46b-3279-4307-9f25-018021b8fc7b","_postman_id":"7151b46b-3279-4307-9f25-018021b8fc7b","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Tiles","item":[{"name":"index","id":"87f6c9c4-db8b-43ed-95d8-cc7060a7eaba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/tiles","description":"This endpoint retrieves a list of company tiles. The response will include the id, title, subtitle, image URL, icon URL, and URL for each tile. The response will be in JSON format with a status code of 200.
\n","urlObject":{"path":["api","company","tiles"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"87f6c9c4-db8b-43ed-95d8-cc7060a7eaba"},{"name":"create","id":"c3b9006e-5ee5-4a19-b8aa-a2c2a3b8a39c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tile\": {\n \"title\": \"ADSite\", // Required\n \"url\": \"https://www.anupamdahal.com.np\", // Required\n \"subtitle\": \"Personal Portfolio\",\n \"image_url\": \"https://miracleanupam.github.io/favicon.ico\",\n \"icon_url\": \"\",\n \"active\": true,\n \"available_countries\": [\"us\", \"in\", \"npl\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/tiles","description":"This HTTP POST request is used to create a new tile for a company. The request should be made to fluid.lvh.me:3000/api/company/tiles.
The request should include a JSON payload with the following parameters:
\ntitle (string, required): The title of the tile.url (string, required): The URL associated with the tile.subtitle (string): The subtitle of the tile.image_url (string): The URL of the image associated with the tile.icon_url (string): The URL of the icon associated with the tile.active (boolean): Indicates whether the tile is active or not.image_path (string): The path of the image associated with the tile.country_ids (array of integers): An array of country IDs associated with the tile.Upon successful creation, the API returns a JSON response with the following parameters:
\nid (integer): The unique identifier of the created tile.title (string): The title of the tile.subtitle (string): The subtitle of the tile.image_url (string): The URL of the image associated with the tile.icon_url (string): The URL of the icon associated with the tile.url (string): The URL associated with the tile.The response status code is 200, and the content type is application/json.
This HTTP PATCH request is used to update a specific tile associated with a company. The request should be sent to /api/company/tiles/:id, where :id is the ID of the tile being updated. The request body should be in raw format and include the \"tile\" object with the properties to be updated such as \"title\", \"url\", \"subtitle\", \"image_url\", \"icon_url\", \"active\", \"image_path\", and \"country_ids\".
The request should include a JSON payload with the following parameters:
\ntitle (string, required): The title of the tile.url (string, required): The URL associated with the tile.subtitle (string): The subtitle of the tile.image_url (string): The URL of the image associated with the tile.icon_url (string): The URL of the icon associated with the tile.active (boolean): Indicates whether the tile is active or not.image_path (string): The path of the image associated with the tile.country_ids (array of integers): An array of country IDs associated with the tile.Upon successful creation, the API returns a JSON response with the following parameters:
\nid (integer): The unique identifier of the created tile.title (string): The title of the tile.subtitle (string): The subtitle of the tile.image_url (string): The URL of the image associated with the tile.icon_url (string): The URL of the icon associated with the tile.url (string): The URL associated with the tile.The response status code is 200, and the content type is application/json.
This endpoint retrieves the details of a specific company tile with the ID :id. The response will include the ID, title, subtitle, image URL, icon URL, and a URL associated with the tile. The response will be in JSON format.
\n","urlObject":{"path":["api","company","tiles","60"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"65273c7d-bdfe-46aa-a650-47dd0dc759e2"},{"name":"destroy","id":"cad8d8bf-5cca-4709-a7af-2a1d1bbc0693","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/tiles/10","description":"Endpoint to delete an title of the company.
\n","urlObject":{"path":["api","company","tiles","10"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"cad8d8bf-5cca-4709-a7af-2a1d1bbc0693"}],"id":"731b24f8-e9f3-4131-92d9-0f58216bf0d7","description":"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.
\nHere's how the process works:
\nhttps://www.example.com.https://www.example.com?auth_token=ABC123.auth_token along.auth_token is passed to the link.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.
\nNote: auth_token expires after 30 minutes.
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.
This endpoint allows you to add a new event for the company.
\ntitle (required, string): The title of the event.description (required, string): Description of the event.start_date (required, string): Start date of the event.end_date (required, string): End date of the event.start_time (string): Start time of the event.end_time (string): End time of the event.time_zone (required, string): Time zone of the event.url (string): URL related to the event.alert (boolean): Indicates if there is an alert for the event.active (boolean): Indicates if the event is active.venue (string): Venue of the event.country_ids (array): Array of country IDs associated with the event.images_attributes (array): Array of images with their URLs and positions.image_url is required to associate an image with the event. position should be used to define the order of images if multiple images are specified.id (number): The ID of the created event.title (string): The title of the event.description (object): Details of the event description.url (string): URL related to the event.start (string): Start date and time of the event.end (string): End date and time of the event.alert (boolean): Indicates if there is an alert for the event.active (boolean): Indicates if the event is active.color (string): Color code associated with the event.time_zone (string): Time zone of the event.images (array): Array of images with different sizes.venue (string): Venue of the event.{\n \"event\": {\n \"title\": \"API Event: Table\",\n \"description\": \"API Event 004 ko Description\",\n \"start_date\": \"2024-03-28\",\n \"end_date\": \"2024-04-01\",\n \"start_time\": \"2024-02-17 9:56:0\",\n \"end_time\": \"2024-03-17 19:56:0\",\n \"time_zone\": \"Asia/Kathmandu\",\n \"url\": \"https://google.com\",\n \"color\": \"#3c36cc\",\n \"alert\": true,\n \"active\": true,\n \"venue\": \"Pokhara\",\n \"country_ids\": [214],\n \"images_attributes\": [\n {\n \"image_url\": \"https://images.furnituredealer.net/img/products/liberty_furniture/color/double bridge--816253672_152-cd-gts-b6.jpg\",\n \"position\": 1\n },\n {\n \"image_url\": \"https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg\"\n }\n ]\n }\n}\n\n{\n \"id\": 123,\n \"title\": \"API Event: Table\",\n \"description\": {\n \"id\": 456,\n \"name\": \"Event 004\",\n \"body\": \"API Event 004 ko Description\",\n \"record_type\": \"event\",\n \"record_id\": 123,\n \"created_at\": \"2024-03-28T12:00:00Z\",\n \"updated_at\": \"2024-04-01T12:00:00Z\",\n \"locale\": \"en\"\n },\n \"url\": \"https://google.com\",\n \"start\": \"2024-03-28T09:56:00Z\",\n \"end\": \"2024-04-01T19:56:00Z\",\n \"alert\": true,\n \"active\": true,\n \"color\": \"#3c36cc\",\n \"time_zone\": \"Asia/Kathmandu\",\n \"images\": [\n {\n \"mini\": \"https://mini-image-url.com\",\n \"detail\": \"https://detail-image-url.com\",\n \"full\": \"https://full-image-url.com\"\n }\n ],\n \"venue\": \"Pokhara\"\n}\n\nThis endpoint makes an HTTP GET request to retrieve a list of events associated with the company. The response will be in JSON format and will include an array of event objects, each containing various details such as ID, title, description, URL, start and end times, alert status, activity status, color, time zone, status, image URL, and venue information.
\n","urlObject":{"path":["api","company","events"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb1bc88a-a46c-4921-b26c-ac4d72ad17e2"},{"name":"update","id":"665ef78b-4a16-4d01-b77d-1f38930c3342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"event\": {\n \"title\": \"Type Race\",\n \"description\": \"Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month.\",\n // \"start_date\": \"2024-3-28\",\n // \"end_date\": \"2024-04-18\",\n // \"start_time\": \"19:56:0\",\n // \"end_time\": \"19:56:0\",\n // \"time_zone\": \"Asia/Kathmandu\", // https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\n // \"url\": \"https://google.com\",\n // \"active\": true,\n // \"venue\": \"Pokhara\",\n \"available_countries\": [\"npl\", \"us\"]\n // \"images_attributes\": [\n // {\n // \"id\": 14,\n // \"position\": 1\n // },\n // {\n // \"id\": 15,\n // \"position\": 0\n // }\n // ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/events/79","description":"This HTTP PATCH request is used to update the details of a specific event for a company. The request should be made to the endpoint /api/company/events/20. The request body should include the details of the event to be updated, such as title, description, start date, end date, time zone, URL, alert status, active status, venue, and country IDs.
title: (string) The title of the event.description: (string) The description of the event.start_date: (string) The start date of the event.end_date: (string) The end date of the event.start_time: (string) The start time of the event.end_time: (string) The end time of the event.time_zone: (string) The time zone of the event.url: (string) The URL related to the event.alert: (boolean) Indicates if the event has an alert.active: (boolean) Indicates if the event is active.venue: (string) The venue of the event.country_ids: (array) An array of country IDs associated with the event.images_attributes: (array) An array of image attributes including ID and position. To edit the image attributes, id is needed. To delete the image from the event, \"_destroy\": true should be set.Upon successful execution, the server responds with a status code of 200 and a JSON object containing the updated details of the event, including its ID, title, description, URL, start and end dates, alert and active status, time zone, color, image URLs, and venue.
\nExample Response:
\n{\n \"id\": 0,\n \"title\": \"\",\n \"description\": {\n \"id\": 0,\n \"name\": \"\",\n \"body\": \"\",\n \"record_type\": \"\",\n \"record_id\": 0,\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"locale\": null\n },\n \"url\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"alert\": true,\n \"active\": true,\n \"color\": \"\",\n \"time_zone\": \"\",\n \"status\": null,\n \"image_url\": \"\",\n \"images\": [\n {\n \"id\": 0,\n \"position\": 0,\n \"mini\": \"\",\n \"detail\": \"\",\n \"full\": \"\"\n }\n ],\n \"venue\": \"\"\n}\n\nEndpoint to delete an event of the company.
\n","urlObject":{"path":["api","company","events","78"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"272eff3a-4f14-4978-9647-2ba59fdb9c47"},{"name":"show","id":"48bc60ed-485f-4b3d-a00d-b6a58be042ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/events/79","description":"This endpoint retrieves the details of a specific event for a company.
The response will include the event's ID, title, description, URL, start and end date, alert status, activity status, color, and time zone.
Endpoint to send notifications of the event to concerned parties.
\ncountry_ids (array): Array of country ids whose affiliates should be notified.This endpoint makes an HTTP GET request to retrieve a list of pages for a company. The response will be a JSON array containing information about each page, including its ID, title, slug, share link, HTML code, publish status, associated countries, view and lead counts, image URL, and related prompts. Each country object within the \"countries\" array includes details such as ISO name, currency information, and tax rate. The \"prompts\" array provides details about any prompts associated with the page.
\n","urlObject":{"path":["api","company","pages"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"b029e8ae-372b-439d-ac06-f6cf3b63b750"},{"name":"create","id":"2b78faa8-44a6-4325-a530-0c6833087a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"en\", // Default: 'en'\n \"page\": {\n \"title\": \"El Condor Pasa\", // Required\n \"html_code\": \"Es un detalles
\", // Required\n \"image_url\": \"https://wallup.net/wp-content/uploads/2019/09/841798-lamborghini-aventador-super-veloce-cars-supercars-red.jpg\",\n \"active\": true,\n \"use_fluid_menu\": true,\n \"default\": true,\n \"use_for_shop\": true,\n \"use_search_engine\": false,\n \"available_countries\": [\"us\", \"in\", \"fin\"]\n // \"label_id\": 15,\n // \"prompts_attributes\": [\n // {\n // \"title\": \"rojo rojo\",\n // \"content\": \"rojo rojo\"\n // },\n // {\n // \"title\": \"verde verde\",\n // \"content\": \"verde verde\"\n // }\n // ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/pages","description":"This HTTP POST request is used to create pages for a company. The request should be sent to fluid.lvh.me:3000/api/company/pages with a payload in the raw request body type. The payload should include the language, title, HTML code, image URL, and other optional attributes for the page. The response will include the ID, title, slug, share link, HTML code, and other details of the created page.
lang (string, default: 'en'): The language of the page.
page (object, required): The page object containing the title, HTML code, image URL, and other optional attributes.
title (string, required): The title of the page.
html_code (string, required): The HTML code for the page content.
image_url (string): The URL of the image associated with the page.
publish (boolean): Indicates whether the page should be published.
use_fluid_menu (boolean): Indicates whether to use a fluid menu for the page.
default (boolean): Indicates whether the page is the default page.
use_for_shop (boolean): Indicates whether the page is used for the shop.
use_search_engine (boolean): Indicates whether the page is used for search engine optimization.
country_ids (array): An array of country IDs associated with the page.
prompts_attributes (array): An array of prompts with title and content attributes. title and content should be present to add a new prompt.
id (integer): The ID of the created page.
\ntitle (string): The title of the page.
\nslug (string): The slug of the page.
\nshare_link (string): The share link of the page.
\nhtml_code (string): The HTML code of the page.
\npublish (boolean): Indicates whether the page is published.
\ncountries (array): An array of country details associated with the page.
\nstripped_description (string): The stripped description of the page.
\nviews (integer): The number of views for the page.
\nleads (integer): The number of leads for the page.
\nimage_url (string): The URL of the image associated with the page.
\nlabel (string): The label of the page.
\ndisplay_tag (string): The display tag of the page.
\nprompts (array): An array of prompts with title and content attributes.
\nAPI Endpoint to retrieve the details of specific event.
\n","urlObject":{"path":["api","company","pages","80"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0405623-78f0-4949-bcf7-1f4d7d783d88"},{"name":"update","id":"0950f9ec-293e-4a6f-a273-428939665303","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"es\", // Default: 'en'\n \"page\": {\n \"title\": \"El Pais\",\n \"html_code\": \"Hola, Espanol, que tal?
\",\n // \"image_url\": \"https://wallup.net/wp-content/uploads/2019/09/841798-lamborghini-aventador-super-veloce-cars-supercars-red.jpg\",\n \"active\": true,\n \"use_fluid_menu\": true,\n \"default\": true,\n \"use_for_shop\": true,\n \"use_search_engine\": false,\n \"available_countries\": [\"ind\"],\n \"label_id\": 16\n // \"prompts_attributes\": [\n // {\n // \"id\": 14,\n // \"_destroy\": true\n // }\n // ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/pages/80","description":"This endpoint allows updating a page for a company. The HTTP PUT request is sent to the specified URL with the ID of the page to be updated. The request body should contain the details of the page to be updated, including the title, HTML code, image URL, and various configuration options.
\nlang (string, optional): Language code for the page. Default value is 'en'.
page (object): Object containing the details of the page to be updated.
title (string): The title of the page.
html_code (string): The HTML code for the page content.
image_url (string): The URL of the image to be associated with the page.
publish (boolean): Indicates whether the page should be published.
use_fluid_menu (boolean): Indicates whether to use a fluid menu for the page.
default (boolean): Indicates whether the page should be set as the default page.
use_for_shop (boolean): Indicates whether the page should be used for the shop.
use_search_engine (boolean): Indicates whether the page should be indexed by search engines.
country_ids (array of integers): Array of country IDs for which the page is applicable.
label_id (integer): The ID of the label associated with the page.
prompts_attributes (array of objects): Array of prompts attributes for the page. title and content should be present to add a new prompt. id and `\"_destroy\": true\" should be present to delete the prompt.
The response to the request will have a status code of 200 and a content type of application/json with details of modified page.
\n","urlObject":{"path":["api","company","pages","80"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"0950f9ec-293e-4a6f-a273-428939665303"},{"name":"destroy","id":"e35dac1f-05ee-45c7-8d9d-5c9d096061f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"DELETE","header":[],"url":"fluid.lvh.me:3000/api/company/pages/80","description":"Endpoint to destroy page of the company.
\n","urlObject":{"path":["api","company","pages","80"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"e35dac1f-05ee-45c7-8d9d-5c9d096061f3"},{"name":"send to top","id":"02751cae-ef30-47c4-a610-14f73d43ab67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/pages/80/send_to_top","description":"Endpoint to send the page to the top.
\n","urlObject":{"path":["api","company","pages","80","send_to_top"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"02751cae-ef30-47c4-a610-14f73d43ab67"},{"name":"duplicate","id":"a733a3cf-cb36-43b9-9af9-9e35e9ce4fae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"es\" // Required, Ensure that the lang parameter matches the available lang settings in page being duplicated\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/pages/80/duplicate","description":"Endpoint to duplicate the specified page.
\n","urlObject":{"path":["api","company","pages","80","duplicate"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"a733a3cf-cb36-43b9-9af9-9e35e9ce4fae"}],"id":"323cd3b5-eb19-46b7-9f7c-22e44a6d6948","_postman_id":"323cd3b5-eb19-46b7-9f7c-22e44a6d6948","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Libraries","item":[{"name":"index","id":"85bd4c7d-5799-4ef7-bb6f-93859a2162fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/libraries","description":"This API endpoint makes an HTTP GET request to retrieve a list of libraries. The response will contain an array of library items, each with an ID, title, slug, share link, views, leads, and a list of related items.
\n","urlObject":{"path":["api","company","libraries"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"e0ae5a52-0806-4b81-b987-452d8e6f56e0","name":"index","originalRequest":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/libraries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: mikeball USE eager loading detected AccessCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\",\"user: mikeball USE eager loading detected Library =\\u003e [:labeling]\\n Add to your query: .includes([:labeling])\",\"user: mikeball USE eager loading detected Library =\\u003e [:label]\\n Add to your query: .includes([:label])\"]"},{"key":"X-bullet-console-text","value":"[\"user: mikeball\\nUSE eager loading detected\\n AccessCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:169:in `country_code'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:13:in `index'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Library =\\u003e [:labeling]\\n Add to your query: .includes([:labeling])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/concerns/label_concern.rb:9:in `label'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:13:in `index'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Library =\\u003e [:label]\\n Add to your query: .includes([:label])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/concerns/label_concern.rb:9:in `label'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:13:in `index'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"e50a3684cd5d82c3ab48a4e26ce54e0c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3460ede8-c115-4ac7-9478-7ec9785f45a0"},{"key":"X-Runtime","value":"0.676072"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=223.65, instantiation.active_record;dur=94.23, render.active_model_serializers;dur=526.95, process_action.action_controller;dur=589.22"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"1525"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 361,\n \"title\": \"New library\",\n \"slug\": \"new-library\",\n \"share_link\": null,\n \"views\": 0,\n \"leads\": 0,\n \"company_library\": null,\n \"affiliate_id\": 2707,\n \"label\": null,\n \"display_tag\": null,\n \"library_items\": []\n },\n {\n \"id\": 363,\n \"title\": \"Very fresh\",\n \"slug\": \"very-fresh\",\n \"share_link\": null,\n \"views\": 0,\n \"leads\": 0,\n \"company_library\": null,\n \"affiliate_id\": 2707,\n \"label\": null,\n \"display_tag\": null,\n \"library_items\": [\n {\n \"id\": 362,\n \"order\": null,\n \"relateable_type\": \"Product\",\n \"relateable\": {\n \"id\": 1981,\n \"active\": true,\n \"title\": \"In iste aliquip aliq\",\n \"description\": {\n \"id\": 2025,\n \"name\": \"description\",\n \"body\": \"This API endpoint retrieves the details of a specific library by making an HTTP GET request to the specified URL. The request should include the company library ID as part of the URL path. Upon a successful execution, the server responds with a status code of 200 and the content in JSON format. The response contains information about the company library, including its ID, title, slug, share link, views, leads, and a list of library items. Each library item includes details such as ID, order, relateable type, and information about the related media, including its ID, type, format, URLs, description, visibility, leads, language, and other attributes.
\n","urlObject":{"path":["api","company","libraries",":id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"3b523a0e-f098-4dc5-8ea2-2b948c1a1462","type":"any","value":"","key":"id"}]}},"response":[{"id":"5651839a-3e22-42a6-9310-c1ff0c1948f8","name":"show","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"fluid.lvh.me:3000/api/company/libraries/:id","host":["fluid.lvh.me:3000"],"path":["api","company","libraries",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"ae0653d7bf61008d3edbd98bb83de970\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"4aad2705-33c2-4b11-89bf-3200f6802f0c"},{"key":"X-Runtime","value":"0.046192"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=2.71, instantiation.active_record;dur=0.34, render.active_model_serializers;dur=2.36, process_action.action_controller;dur=9.20"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"155"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 361,\n \"title\": \"New library\",\n \"slug\": \"new-library\",\n \"share_link\": null,\n \"views\": 0,\n \"leads\": 0,\n \"company_library\": null,\n \"affiliate_id\": 2707,\n \"label\": null,\n \"display_tag\": null,\n \"library_items\": []\n}"}],"_postman_id":"afdd128c-41a2-4d09-aff5-4b96362af48d"},{"name":"create","id":"e30d567b-a238-4efd-81fd-21392fdec056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"library\": {\n \"title\": \"Library from API\", // Required\n \"affiliate_id\": 1,\n // \"company_library\": true,\n \"library_items_attributes\": [\n {\n \"relateable_type\": \"Product\",\n \"relateable_id\": 1,\n \"order\": 3\n },\n {\n \"relateable_type\": \"Medium\",\n \"relateable_id\": 1,\n \"order\": 2\n },\n {\n \"relateable_type\": \"Product\",\n \"relateable_id\": 2,\n \"order\": 1\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/libraries","description":"This HTTP POST request is used to create a new tile for a company. The request should be made to /api/company/libraries.
The request should include a JSON payload with the following parameters:
\ntitle (string, required): The title of the library.affiliate_id (number): The id of affiliate associated with the library. Required if company_library flag is not set.company_library (boolean): true if the library is a company library.library_items_attributes (array): Details of resources to be included in the library. Each resource should contain the following.relateable_type (string, required): The type of resource to be included in the library.relateable_id (number, required): The id of the resource to be included in the library.order (number): The order at which the resource should be placed in the library.The available resource types can be obtained from /api/company/libraries/available_resources_for_playlists.
Upon successful creation, the API returns a JSON response with the following parameters:
\nid (integer): The unique identifier of the created library.
title (string): The title of the library.
slug (string): The slug value of the tile.
share_link (string): The URL to be used to share the libraries.
views (numeric): The number of times the library has been viewed.
leads (numeric): The number of leads obtained from the library.
company_library (boolean): Flag to denote if the library is a company library.
affiliate_id (number): The id of affiliate associated with the library.
library_items (array): Details of all the resources included in the library.
The response status code is 200, and the content type is application/json.
This HTTP POST request is used to create a new tile for a company. The request should be made to /api/company/libraries/:library_id.
The request should include a JSON payload with the following parameters:
\ntitle (string): The title of the library.
affiliate_id (number): The id of the affiliated associated with the library. Required if company_library flag is not set.
company_library (boolean): true if the library is a company library.
library_items_attributes (array): Details of resources to be included in the library. Each resource should contain the following.
id(number, required): ID for the library item.
relateable_type (string): The type of resource to be included in the library. If present, relateable_id should also be present.
relateable_id (number): The id of the resource to be included in the library. If present, relateable_type should also be present.
order (number): The order at which the resource should be placed in the library.
The available resource types can be obtained from /api/company/libraries/available_resources_for_playlists.
Upon successful creation, the API returns a JSON response with the following parameters:
\nid (integer): The unique identifier of the created library.
title (string): The title of the library.
slug (string): The slug value of the tile.
share_link (string): The URL to be used to share the libraries.
views (numeric): The number of times the library has been viewed.
leads (numeric): The number of leads obtained from the library.
affiliate_id (number): The id of the affiliated associated with the library.
library_items (array): Details of all the resources included in the library.
The response status code is 200, and the content type is application/json.
This endpoint allows the user to add an item to a specific library within the company.
\nPUT /api/company/libraries/:library_id/add_item_to_library
library_item.relateable_type (string, required): The type of the item to be added.library_item.relateable_id (number, required): The ID of the item to be added.library_item.order (number): The order in which the item should appear in the library.The response will be in JSON format and will include the details of the added item in the library.
\nid (number): The ID of the added item.title (string): The title of the added item.slug (string): The slug of the added item.share_link (string): The share link of the added item.views (number): The number of views for the added item.leads (number): The number of leads for the added item.company_library (boolean): Indicates if the item is in the company library.library_items (array): An array containing the details of the added item, including its ID, order, relateable type, and relateable details such as ID, media type, media format, image URL, video URL, PDF URL, title, description, and other attributes.This endpoint is used to delete a specific library item associated with a company.
\n/api/company/libraries/:library_id/destroy_library_itemlibrary_item_id: The ID of the library item to be deleted.JSON object with the details of the library.
\n","urlObject":{"path":["api","company","libraries",":id","destroy_library_item"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"8b16c22a-33c3-482e-9995-bffd3123782c","type":"any","value":"","key":"id"}]}},"response":[{"id":"b3b3b8b5-9757-4473-97f9-6de0a6f68b94","name":"remove_item","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"library_item_id\": 1355\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"fluid.lvh.me:3000/api/company/libraries/:id/destroy_library_item","host":["fluid.lvh.me:3000"],"path":["api","company","libraries",":id","destroy_library_item"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: mikeball USE eager loading detected Product =\\u003e [:rich_text_translations]\\n Add to your query: .includes([:rich_text_translations])\",\"user: mikeball USE eager loading detected Product =\\u003e [:country]\\n Add to your query: .includes([:country])\",\"user: mikeball USE eager loading detected Product =\\u003e [:primary_image]\\n Add to your query: .includes([:primary_image])\",\"user: mikeball USE eager loading detected Product =\\u003e [:access_countries]\\n Add to your query: .includes([:access_countries])\",\"user: mikeball USE eager loading detected Product =\\u003e [:company]\\n Add to your query: .includes([:company])\",\"user: mikeball USE eager loading detected Product =\\u003e [:variants]\\n Add to your query: .includes([:variants])\",\"user: mikeball Need Counter Cache with Active Record size Product =\\u003e [:reviews]\",\"user: mikeball USE eager loading detected Product =\\u003e [:reviews]\\n Add to your query: .includes([:reviews])\",\"user: mikeball USE eager loading detected Product =\\u003e [:labeling]\\n Add to your query: .includes([:labeling])\",\"user: mikeball USE eager loading detected Product =\\u003e [:label]\\n Add to your query: .includes([:label])\",\"user: mikeball USE eager loading detected Product =\\u003e [:images]\\n Add to your query: .includes([:images])\",\"user: mikeball USE eager loading detected Product =\\u003e [:countries]\\n Add to your query: .includes([:countries])\",\"user: mikeball USE eager loading detected Product =\\u003e [:options]\\n Add to your query: .includes([:options])\",\"user: mikeball USE eager loading detected Product =\\u003e [:prompts]\\n Add to your query: .includes([:prompts])\",\"user: mikeball USE eager loading detected Product =\\u003e [:enroll_products]\\n Add to your query: .includes([:enroll_products])\",\"user: mikeball USE eager loading detected Product =\\u003e [:enrollment_packs]\\n Add to your query: .includes([:enrollment_packs])\",\"user: mikeball USE eager loading detected AccessCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\",\"user: mikeball USE eager loading detected VariantCountry =\\u003e [:country]\\n Add to your query: .includes([:country])\"]"},{"key":"X-bullet-console-text","value":"[\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:rich_text_translations]\\n Add to your query: .includes([:rich_text_translations])\\nCall stack\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:country]\\n Add to your query: .includes([:country])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:152:in `country'\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:204:in `default_variant'\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:104:in `variant_country'\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:112:in `price'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:primary_image]\\n Add to your query: .includes([:primary_image])\\nCall stack\\n /Users/mikeball/repos/fluid/app/models/product.rb:596:in `image_thumbnail_url'\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:190:in `image'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:access_countries]\\n Add to your query: .includes([:access_countries])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/product_serializer.rb:169:in `country_code'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:company]\\n Add to your query: .includes([:company])\\nCall stack\\n /Users/mikeball/repos/fluid/app/models/product.rb:131:in `company_default_country'\\n /Users/mikeball/repos/fluid/app/models/product.rb:626:in `price_range'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:variants]\\n Add to your query: .includes([:variants])\\nCall stack\\n /Users/mikeball/repos/fluid/app/models/product.rb:628:in `price_range'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nNeed Counter Cache with Active Record size\\n Product =\\u003e [:reviews]\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:reviews]\\n Add to your query: .includes([:reviews])\\nCall stack\\n /Users/mikeball/repos/fluid/app/models/product.rb:500:in `review_count'\\n /Users/mikeball/repos/fluid/app/models/product.rb:516:in `hide_reviews?'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:labeling]\\n Add to your query: .includes([:labeling])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/concerns/label_concern.rb:9:in `label'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:label]\\n Add to your query: .includes([:label])\\nCall stack\\n /Users/mikeball/repos/fluid/app/serializers/concerns/label_concern.rb:9:in `label'\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:images]\\n Add to your query: .includes([:images])\\nCall stack\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:countries]\\n Add to your query: .includes([:countries])\\nCall stack\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:options]\\n Add to your query: .includes([:options])\\nCall stack\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\",\"user: mikeball\\nUSE eager loading detected\\n Product =\\u003e [:prompts]\\n Add to your query: .includes([:prompts])\\nCall stack\\n /Users/mikeball/repos/fluid/app/controllers/api/company/libraries_controller.rb:71:in `destroy_library_item'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:94:in `block in switch_locale'\\n /Users/mikeball/repos/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/mikeball/repos/fluid/app/controllers/api/base_controller.rb:93:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"6fa5eb00c7b290dd80caf6696a821396\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"055b58b7-3a7a-442e-ab09-8fa893c26da7"},{"key":"X-Runtime","value":"0.250872"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=27.14, instantiation.active_record;dur=4.38, transaction.active_record;dur=7.59, render.active_model_serializers;dur=145.11, process_action.action_controller;dur=163.32"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"2296"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1275,\n \"title\": \"Edited Title\",\n \"slug\": \"library-from-api\",\n \"share_link\": null,\n \"views\": 0,\n \"leads\": 0,\n \"company_library\": true,\n \"affiliate_id\": 2707,\n \"label\": null,\n \"display_tag\": null,\n \"library_items\": [\n {\n \"id\": 1354,\n \"order\": 1,\n \"relateable_type\": \"Product\",\n \"relateable\": {\n \"id\": 2198,\n \"active\": true,\n \"title\": \"not again\",\n \"description\": {\n \"id\": 4729,\n \"name\": \"description\",\n \"body\": \"This endpoint allows the user to clone a company library with the specified ID.
\naffiliate_id (number) - The ID of the user.id (number) - The ID of the cloned library.title (string) - The title of the cloned library.slug (string) - The slug of the cloned library.share_link (string) - The share link of the cloned library.views (number) - The number of views of the cloned library.leads (number) - The number of leads of the cloned library.company_library (boolean) - Flag that denotes if the library is a company library.library_items (array) - The array of items in the cloned library, including their details.This endpoint makes an HTTP GET request to retrieve the available resources for playlists. The response will be in JSON format with a status code of 200.
\n","urlObject":{"path":["api","company","libraries","available_resources_for_playlists"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"ab082791-5f6a-4444-8e69-8742fb64eba4","name":"list_shareables","originalRequest":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/libraries/available_resources_for_playlists"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"1db659595e4482939cd5de911fb7bb32\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3b96f6d1-b1f3-49ff-a9a4-df23d5aeaf1d"},{"key":"X-Runtime","value":"0.056563"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.22, sql.active_record;dur=1.01, instantiation.active_record;dur=0.23, render.active_model_serializers;dur=0.03, process_action.action_controller;dur=6.19"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"110"}],"cookie":[],"responseTime":null,"body":"[\n \"Product\",\n \"Giveaway\",\n \"Medium\",\n \"Simulator\",\n \"Promotion\",\n \"CustomPage\",\n \"Library\",\n \"EnrollmentPack\"\n]"}],"_postman_id":"97387a82-4e77-4424-93d3-44d8887247a7"},{"name":"destroy","id":"854b1cb2-b855-42e7-bbd3-609e5635e111","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/libraries/:id","description":"This endpoint sends an HTTP DELETE request to the specified URL to delete a specific library with the ID (18 in this instance).
\nThe last execution of this request returned a 200 status code with a JSON response containing a success message.
\n","urlObject":{"path":["api","company","libraries",":id"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[{"id":"e7dc408d-943a-40a5-a0dc-4761c59e049f","type":"any","value":"","key":"id"}]}},"response":[{"id":"4a42ae34-66a6-4b6b-abe2-958d0b726321","name":"destroy","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"fluid.lvh.me:3000/api/company/libraries/:id","host":["fluid.lvh.me:3000"],"path":["api","company","libraries",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"c3682e483d72414446bc535431f4fdfa\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"51b711b8-2ea0-4832-a4c8-c0f732e16522"},{"key":"X-Runtime","value":"0.239871"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=100.45, instantiation.active_record;dur=0.63, enqueue.active_job;dur=8.81, transaction.active_record;dur=153.50, process_action.action_controller;dur=194.86"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"55"}],"cookie":[],"responseTime":null,"body":"Library deleted successfully."}],"_postman_id":"854b1cb2-b855-42e7-bbd3-609e5635e111"}],"id":"4c0eac9c-c20c-4e3c-a684-46eee0dd54fa","_postman_id":"4c0eac9c-c20c-4e3c-a684-46eee0dd54fa","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"ProductRedirects","item":[{"name":"index","id":"208caccb-e644-42ea-addb-9d9b9781c57d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/products/144/product_redirects","description":"This endpoint retrieves the external product redirects for various countries.
\nDetails of the external redirects for the product.
\n","urlObject":{"path":["api","company","products","144","product_redirects"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"208caccb-e644-42ea-addb-9d9b9781c57d"},{"name":"show","id":"020a563c-0b65-437b-bf90-e4f4d4780780","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/products/144/product_redirects/9","description":"This endpoint retrieves the external product redirect with given id.
\nDetails of the external redirect for the product with given id.
\n","urlObject":{"path":["api","company","products","144","product_redirects","9"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"020a563c-0b65-437b-bf90-e4f4d4780780"},{"name":"create","id":"74c5baa5-6779-4b88-884f-fb41e010fd3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product_redirect\": {\n \"country\": \"fin\",\n \"external_url\": \"https://hoas.fi\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/products/144/product_redirects","description":"This endpoint creates an external product redirect for a specific country.
\nproduct_redirect (object, required): Detail of the external product redirect for the product.country (string, required): Country code of the country. Can be in iso or iso3 formats. For eg, us or usa.external_url (string, required): The URL to redirect to.Details of the newly created external redirect for the product.
\n","urlObject":{"path":["api","company","products","144","product_redirects"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"74c5baa5-6779-4b88-884f-fb41e010fd3b"},{"name":"update","id":"e636fad6-e2c4-4fd4-a499-de93751e482a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"product_redirect\": {\n // \"country\": \"us\",\n \"external_url\": \"https://space.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/products/144/product_redirects/9","description":"This endpoint updates an external product redirect with given id.
\nproduct_redirect (object, required): Detail of the external product redirect for the product.country (string): Country code of the country. Can be in iso or iso3 formats. For eg, us or usa.external_url (string): The URL to redirect to.Details of the external redirect for the product.
\n","urlObject":{"path":["api","company","products","144","product_redirects","9"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"e636fad6-e2c4-4fd4-a499-de93751e482a"},{"name":"destroy","id":"0c6c976b-9047-4f73-bcb9-cfa755fe4f16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"DELETE","header":[],"url":"fluid.lvh.me:3000/api/company/products/144/product_redirects/9","description":"This endpoint deletes an external product redirect with given id.
\nSuccess or Failure Message
\n","urlObject":{"path":["api","company","products","144","product_redirects","9"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c6c976b-9047-4f73-bcb9-cfa755fe4f16"}],"id":"b992beb3-d00e-4406-898a-e26fbc2d1e8c","_postman_id":"b992beb3-d00e-4406-898a-e26fbc2d1e8c","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Variants","item":[{"name":"index","id":"d209d6d2-a01b-417c-8efa-bcbd15563142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/products/144/variants","description":"This endpoint retrieves the variants for product with given id.
\nDetails of the variants for the product with given id.
\n","urlObject":{"path":["api","company","products","144","variants"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"d209d6d2-a01b-417c-8efa-bcbd15563142"},{"name":"show","id":"cf43a7c3-33ea-41d8-b06e-ab4813f73256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/products/149/variants/334","description":"This endpoint retrieves the variant for product with given id.
\nDetails of the variant for the product with given id.
\n","urlObject":{"path":["api","company","products","149","variants","334"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf43a7c3-33ea-41d8-b06e-ab4813f73256"},{"name":"create","id":"5f327588-3dde-4c23-b604-741ce5f733e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"variant\": {\n \"sku\": \"NSXM10000\",\n \"inventory_quantity\": 8000,\n \"images_attributes\": [\n {\n \"image_url\": \"https://hello.com/noice.jpg\"\n }\n ],\n \"weight\": 25,\n \"weight1\": 35,\n \"weight2\": 45,\n \"unit_of_weight1\": \"kg\",\n \"unit_of_weight2\": \"lb\",\n \"height\": 4,\n \"width\": 8,\n \"length\": 5,\n \"unit_of_size\": \"in\",\n \"customs_information_shipping\": true,\n \"country_of_origin\": \"np\",\n \"physical\": true,\n \"unit_of_weight\": \"kg\",\n \"hs_code\": \"978978\",\n \"track_quantity\": true,\n \"keep_selling\": true,\n \"active\": true,\n \"allow_subscription\": true,\n \"bar_code\": \"788o798\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"value\": \"Yellow\"\n },\n {\n \"name\": \"Size\",\n \"value\": \"Large\"\n }\n ],\n \"variant_countries_attributes\": [{\n \"country_id\": 214,\n \"active\": true,\n \"cv\": 4,\n \"qv\": 6,\n \"shipping\": 10,\n \"tax\": 12,\n \"price\": 1000,\n \"subscription_price\": 950,\n \"wholesale\": 920,\n \"wholesale_subscription_price\": 900,\n \"compare_price\": 940,\n \"cost_of_goods_sold\": 50\n }]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/products/149/variants","description":"This endpoint creates a variant for product with given id.
\nvariant (object, required): Details of the variant.sku (string): SKU of the variant.inventory_quantity (integer): Available stock of the variant in inventory.options (array): If the product has multiple variants option, the variant should have a value corresponding to every option specified for product variants.name (string): Name of the variant option.value (string): Value for that variant option.weight (numeric): Weight of the variant.weight1 (numeric): Weight of the variant.weight2 (numeric): Weight of the variant.unit_of_weight (string): Unit of weight of the variant.unit_of_weight1 (string): Unit of weight of the variant.unit_of_weight2 (string): Unit of weight of the variant.height (numeriic): Height of the variant.width (numeric): Width of the variant.length (numeric): Length of the variant.unit_of_size (numeric): Unit of Size.customs_information_shipping (boolean): # FILLMEcountry_of_origin (string): Country code. Iso format. eg. us.physical (boolean): Flag to denote whether the variant is physical product.hs_code (string): # FILLMEtrack_quantity (boolean): Flag to denote whether to track the inventory quantity.keep_selling (boolean): Flag to denote whether to keep selling when the stock runs out.active (boolean): Flag to denote whether the variant is active or not.allow_subscription (boolean): Flag to denote whether subscriptions are possible for this variant.bar_code (string): # FILLMEimages_attributes (array): Details of images for the variant.image_url (string, required): The URL of the image to be used.variant_countries_attributes (array): Details of the variants specific to various countries.country_id (integer): Id of the country.active (boolean): Flag to denote variant should be active in given country.cv (integer): CV for the variant in the given country.qv (integer): QV for the variant in the given country.shipping (integer): Shipping cost for the variant in the given country.tax (integer): Tax for the variant in the given country.price (numeric): Price for the variant in the given country.subscription_price (numeric): Subscription Price for the variant in the given country.wholesale (numeric): Wholesale price for the variant in the given country.wholesale_subscription_price (numeric): Wholesale subscription price for the variant in the given country.compare_price (numeric): #FILLMEcost_of_goods_sold (numeric): #FILLMEDetails of the variants for the product with given id.
\n","urlObject":{"path":["api","company","products","149","variants"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f327588-3dde-4c23-b604-741ce5f733e9"},{"name":"update","id":"11ed7fdc-9ca1-49cc-9bdb-6e63adef8e6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"variant\": {\n \"sku\": \"NSXM00000\",\n \"inventory_quantity\": 800,\n \"images_attributes\": [\n {\n \"image_url\": \"https://m.media-amazon.com/images/M/MV5BMjExMTg5OTU0NF5BMl5BanBnXkFtZTcwMjMxMzMzMw@@._V1_.jpg\"\n }\n ],\n \"weight\": 25,\n \"weight1\": 35,\n \"weight2\": 45,\n \"unit_of_weight1\": \"kg\",\n \"unit_of_weight2\": \"lb\",\n \"height\": 4,\n \"width\": 8,\n \"length\": 5,\n \"unit_of_size\": \"in\",\n \"customs_information_shipping\": true,\n \"country_of_origin\": \"np\",\n \"physical\": true,\n \"unit_of_weight\": \"kg\",\n \"hs_code\": \"978978\",\n \"track_quantity\": true,\n \"keep_selling\": true,\n \"active\": true,\n \"allow_subscription\": true,\n \"bar_code\": \"788o798\",\n \"variant_countries_attributes\": [\n {\n \"country_id\": 214,\n \"active\": true,\n \"cv\": 4,\n \"qv\": 6,\n \"shipping\": 10,\n \"tax\": 12,\n \"price\": 2000,\n \"subscription_price\": 950,\n \"wholesale\": 920,\n \"wholesale_subscription_price\": 900,\n \"compare_price\": 940,\n \"cost_of_goods_sold\": 50\n }, \n {\n \"country_id\": 92,\n \"active\": true,\n \"cv\": 4,\n \"qv\": 6,\n \"shipping\": 10,\n \"tax\": 12,\n \"price\": 2000,\n \"subscription_price\": 950,\n \"wholesale\": 920,\n \"wholesale_subscription_price\": 900,\n \"compare_price\": 940,\n \"cost_of_goods_sold\": 50\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/products/149/variants/334","description":"This endpoint updates a variant for product with given id.
\nvariant (object, required): Details of the variant.id (integer, required): Id of the variant.sku (string): SKU of the variant.inventory_quantity (integer): Available stock of the variant in inventory.weight (numeric): Weight of the variant.weight1 (numeric): Weight of the variant.weight2 (numeric): Weight of the variant.unit_of_weight (string): Unit of weight of the variant.unit_of_weight1 (string): Unit of weight of the variant.unit_of_weight2 (string): Unit of weight of the variant.height (numeriic): Height of the variant.width (numeric): Width of the variant.length (numeric): Length of the variant.unit_of_size (numeric): Unit of Size.customs_information_shipping (boolean): # FILLMEcountry_of_origin (string): Country code. Iso format. eg. us.physical (boolean): Flag to denote whether the variant is physical product.hs_code (string): # FILLMEtrack_quantity (boolean): Flag to denote whether to track the inventory quantity.keep_selling (boolean): Flag to denote whether to keep selling when the stock runs out.active (boolean): Flag to denote whether the variant is active or not.allow_subscription (boolean): Flag to denote whether subscriptions are possible for this variant.bar_code (string): # FILLMEimages_attributes (array): Details of images for the variant. If id is present, updates the image, else creates it. To remove an image for the variant, _destroy flag must be set.id (integer): Id of the image.image_url (string, required): The URL of the image to be used._destroy (boolean): Flag to remove the image.variant_countries_attributes (array): Details of the variants specific to various countries.country_id (integer): Id of the country.active (boolean): Flag to denote variant should be active in given country.cv (integer): CV for the variant in the given country.qv (integer): QV for the variant in the given country.shipping (integer): Shipping cost for the variant in the given country.tax (integer): Tax for the variant in the given country.price (numeric): Price for the variant in the given country.subscription_price (numeric): Subscription Price for the variant in the given country.wholesale (numeric): Wholesale price for the variant in the given country.wholesale_subscription_price (numeric): Wholesale subscription price for the variant in the given country.compare_price (numeric): #FILLMEcost_of_goods_sold (numeric): #FILLMEDetails of the variants for the product with given id.
\n","urlObject":{"path":["api","company","products","149","variants","334"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"11ed7fdc-9ca1-49cc-9bdb-6e63adef8e6c"},{"name":"destroy","id":"a83dc983-9b28-4457-9a49-129b3fbde7b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"DELETE","header":[],"url":"fluid.lvh.me:3000/api/company/products/149/variants/334","description":"This endpoint deletes a variant for product with given id.
\nSuccess or Failure Message
\n","urlObject":{"path":["api","company","products","149","variants","334"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"a83dc983-9b28-4457-9a49-129b3fbde7b4"}],"id":"2b7f31b5-a33f-422a-a8e4-72f64bbd4f38","_postman_id":"2b7f31b5-a33f-422a-a8e4-72f64bbd4f38","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Media","item":[{"name":"index","id":"97a9169b-f15c-4bda-b3de-f0f587e63956","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"api_token\n"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/media","description":"This endpoint retrieves media.
\nDetails of media.
\n","urlObject":{"path":["api","company","media"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"148ddfab-5ca5-4f00-8fb5-9f2bb223f474","name":"index","originalRequest":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/media"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"etag","value":"W/\"c9ef3ce6fac84a14c452c143c454d20b\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"b64ca9d4-300f-42e9-9030-95f38e1b2760"},{"key":"x-runtime","value":"3.356724"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"content-encoding","value":"gzip"},{"key":"x-cloud-trace-context","value":"8ca0432e41da5aaa1bae6b3040c4544b"},{"key":"date","value":"Fri, 19 Jul 2024 20:31:17 GMT"},{"key":"server","value":"Google Frontend"},{"key":"via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 8504,\n \"user_id\": null,\n \"media_type\": \"share\",\n \"media_format\": \"png\",\n \"image_url\": \"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/JqmCfzdPTQCdVtPKnHIA_fluid+logo.png\",\n \"video_url\": \"\",\n \"pdf_url\": \"\",\n \"title\": \"test\",\n \"description\": {\n \"id\": 23647,\n \"name\": \"description\",\n \"body\": \"This endpoint retrieves the media with given id.
\nDetails of the media with given id.
\n","urlObject":{"path":["api","company","media","6"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"2cca208a-053e-413a-bc1c-adaf11b4cd4a","name":"show","originalRequest":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/media/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"etag","value":"W/\"f83b15e3834c81cedcc1256de677619b\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"cfafadbe-8fdb-464e-b068-a7c8178793c1"},{"key":"x-runtime","value":"0.052864"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"content-encoding","value":"gzip"},{"key":"x-cloud-trace-context","value":"afa9d4346952711458148f7808affef3"},{"key":"date","value":"Fri, 19 Jul 2024 20:38:22 GMT"},{"key":"server","value":"Google Frontend"},{"key":"via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"user_id\": null,\n \"media_type\": \"training\",\n \"media_format\": \"mp4\",\n \"image_url\": \"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/e8phkIMDRVywwuq67sPb_AzTQlNIQw6rTejzR2Fig_lotion_bottles.jpg\",\n \"video_url\": \"https://cdn.filestackcontent.com/Tj1fbDRtQ7uXT0FynG0s\",\n \"pdf_url\": \"\",\n \"title\": \"Go Time Product Training\",\n \"description\": {\n \"id\": 20,\n \"name\": \"description\",\n \"body\": \"GO time provides healthy energy! It supports weight loss, energy, and hydration. Click on the attachment link to download the PDF version\",\n \"record_type\": \"Medium\",\n \"record_id\": 6,\n \"created_at\": \"2021-06-08T04:23:35.771Z\",\n \"updated_at\": \"2021-06-08T04:23:35.771Z\",\n \"locale\": null\n },\n \"stripped\": \"GO time provides healthy energy! It supports weight loss, energy, and hydration. Click on the attachment link to download the PDF version\",\n \"kind\": null,\n \"active\": true,\n \"visibility\": null,\n \"share_link\": null,\n \"views\": 0,\n \"leads\": 0,\n \"language_id\": 980190962,\n \"watch\": null,\n \"video_status\": null,\n \"duration\": 556,\n \"cta_url\": null,\n \"cta_button_text\": null,\n \"cta_enabled\": false,\n \"cta_action_type\": \"visit_on_click\",\n \"video_shopping_enabled\": false,\n \"prompts_enabled\": false,\n \"subtitles\": {},\n \"label\": null,\n \"display_tag\": null,\n \"attached_shareables\": []\n}"}],"_postman_id":"fe4ad199-633c-4ac3-a1ef-98e84bb1d445"},{"name":"create","id":"347350d5-0857-487f-bded-effe7a8a486f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"api_token\n"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"medium\": {\n \"title\": \"Subtitles Test\", // Required\n \"language\": \"en\",\n \"media_type\": \"share\", // share, training, update, upload // Required\n \"description\": \"This is the body text of the medium\", // Required\n // \"image_url\": \"https://www.electronicworldtv.co.uk/blog/wp-content/uploads/2011/08/history-of-the-tv.jpg\",\n \"video_url\": \"https://videos.pexels.com/video-files/20576968/20576968-hd_1920_1080_25fps.mp4\",\n // \"pdf_url\": \"https://pdfobject.com/pdf/sample.pdf\",\n // \"powerpoint_url\": \"https://scholar.harvard.edu/files/torman_personal/files/samplepptx.pptx\",\n \"available_countries\": [\"npl\", \"us\", \"ind\", \"fi\"],\n \"tags_attributes\": [\n {\n \"name\": \"meds\"\n }\n ],\n \"label\": {\n // \"id\": 14\n \"title\": \"AD\"\n },\n \"category\": \"media_category\",\n\n // CTA Section\n \"cta_enabled\": true,\n \"cta_action_type\": \"visit_on_click\", // \"visit_on_click\", \"lead_capture\", \"auto_redirect\"\n \"cta_button_text\": \"Learn More\",\n \"cta_url\": \"https://google.com\",\n \"display_shop\": true,\n\n // Video Shopping Section\n \"video_shopping_enabled\": true,\n \"attached_shareables_attributes\": [\n {\n \"attachment_type\": \"Product\",\n // \"attachment_id\": 4,\n \"timestamp\": \"00:00:05\"\n },\n {\n \"attachment_type\": \"Product\",\n \"attachment_id\": 7\n // \"timestamp\": \"00:00:18\"\n }\n ],\n \"subtitles\": [\n {\n \"lang\": \"en\"\n // \"src\": \"https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt\"\n },\n {\n \"lang\": \"de\",\n \"src\": \"https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt\"\n }\n ],\n \"prompts_attributes\": [\n {\n \"title\": \"This is a Prompt\",\n \"content\": \"This is an example content of a prompt.\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/media","description":"This endpoint creates a media.
\nmedia (object, required): Detail of the media.
title (string, required): Title of the media.
language (string): Iso of the language. eg. en.
media_type (sting, required): The type of media. Allowed values are share, training, update, upload.
description (string, required): Description of the media.
image_url (string): URL of the image if the media is an image. To create a image media, video_url, pdf_url, powerpoint_url must be omitted. This field can also be used to set the thumbnail of other media types. Use of image_url along with video_url for example, creates a video media with the thumbnail from image_url.
video_url (string): URL of the video for video media. Use image_url in conjuction to set custom thumbnail.
pdf_url (string): URL of the PDF for PDF media. Use image_url in conjuction to set custom thumbnail.
ppt_url (string): URL of the powerpoint for powerpoint media. Use image_url in conjuction to set custom thumbnail.
available_countries (array): List of countries where the media should be available. The countries should be specified in iso formats. For eg. ['us', 'npl', 'fin', 'in'].
tags_attributes (array): Details of the tags the media should be tagged with.
name (string): Name of the tag. Finds or creates the tag.label (object): Details of label to be assigned to the media. Assigns a label only if a label with given id or title is found, does not create a new one.
title (string): Title of the label.
id (integer): Id of the label to be assigned.
category (string): The name of the category the media should be included in. Assigns the category if the category by the name is found. It does not create a category if corresponding category is not found.
cta_enabled (boolean): Flag to set where the CTA Actions are enabled. Default is false.
cta_action_type (string): Available values are visit_on_click, leads_capture, auto_redirect.
cta_url (string): URL to redirect to. Required if cta_enabled is true.
display_shop (boolean): Flag to specify if the media should be shown in shop. Default is false.
video_shopping_enabled (boolean): Flag to specify if video shopping should be enabled for the media. Only works if it is a video media.
attached_shareables_attributes (array): Details of the video timestamps and shareables to be included to the media as a part of video shopping. If any of the following attributes are missing, it is skipped.
attachment_type (string): Type of the shareable. For now, only 'Product' is accepted.attachment_id (integer): Id of the shareable.
timestamp (string): Timestamp where the attached shareable should be shown. It should conform to the format HH:MM:SS and should be a valid timestamp for the video.
subtitles (array): Details of subtitles.
lang (string, required): Language of the subtitle. In iso format. For eg. en.src (string): URL of the subtitle file.
prompt_attributes (array): Details for prompts for the media.
title (string): Title of the prompt.
content (string): Content of the prompt.
Details of the newly created media.
\n","urlObject":{"path":["api","media"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"347350d5-0857-487f-bded-effe7a8a486f"},{"name":"update","id":"18190556-25fe-4de8-a24f-e32eccc666a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"medium\": {\n // \"title\": \"The Video\",\n // \"language\": \"en\",\n // \"media_type\": \"share\", // share, training, update, upload\n // \"description\": \"This is the edited body text of the medium\",\n // // \"image_url\": \"https://www.electronicworldtv.co.uk/blog/wp-content/uploads/2011/08/history-of-the-tv.jpg\",\n // \"video_url\": \"https://videos.pexels.com/video-files/20576968/20576968-hd_1920_1080_25fps.mp4\",\n // // \"pdf_url\": \"https://pdfobject.com/pdf/sample.pdf\",\n // \"available_countries\": [\"npl\", \"us\", \"ind\"],\n // \"tags_attributes\": [\n // {\n // \"name\": \"scenic\"\n // }\n // // {\n // // \"id\": 7,\n // // \"_destroy\": true\n // // }\n // ],\n // \"label\": {\n // // \"id\": 14\n // \"title\": \"AD\"\n // },\n // \"category\": \"media_category\",\n\n // // CTA Section\n // \"cta_enabled\": true,\n // \"cta_action_type\": \"visit_on_click\", // \"visit_on_click\", \"lead_capture\", \"auto_redirect\"\n // \"cta_button_text\": \"Buy Now\",\n // \"cta_url\": \"https://google.com\",\n // \"display_shop\": true,\n\n // // Video Shopping Section\n \"video_shopping_enabled\": true,\n \"attached_shareables_attributes\": [\n {\n \"attachment_type\": \"Product\",\n \"attachment_id\": 27,\n \"timestamp\": \"00:00:05\"\n },\n // {\n // \"id\": 63,\n // \"_destroy\": true\n // },\n {\n \"attachment_type\": \"Product\",\n \"attachment_id\": 4,\n \"timestamp\": \"00:00:15\"\n }\n ],\n \"subtitles\": [\n {\n \"lang\": \"en\",\n \"src\": \"https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt\"\n },\n {\n \"lang\": \"de\",\n \"src\": \"\"\n }\n ]\n // \"prompts_attributes\": [\n // {\n // \"title\": \"This is a Prompt\",\n // \"content\": \"This is an example content of a prompt.\"\n // }\n // ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/media/53","description":"This endpoint updates the media with given id.
\nmedia (object, required): Detail of the media.
title (string, required): Title of the media.
language (string): Iso of the language. eg. en.
media_type (sting, required): The type of media. Allowed values are share, training, update, upload.
description (string, required): Description of the media.
image_url (string): URL of the image if the media is an image. To create a image media, video_url, pdf_url, powerpoint_url must be omitted. This field can also be used to set the thumbnail of other media types. Use of image_url along with video_url for example, creates a video media with the thumbnail from image_url.
video_url (string): URL of the video for video media. Use image_url in conjuction to set custom thumbnail.
pdf_url (string): URL of the PDF for PDF media. Use image_url in conjuction to set custom thumbnail.
ppt_url (string): URL of the powerpoint for powerpoint media. Use image_url in conjuction to set custom thumbnail.
available_countries (array): List of countries where the media should be available. The countries should be specified in iso formats. For eg. ['us', 'npl', 'fin', 'in']. Pass empty array [] to reset available countries.
tags_attributes (array): Details of the tags the media should be tagged with.If id is present, updates the tag. Else creates it.
id (integer): Id of the tag.name (string): Name of the tag. Finds or creates the tag.label (object): Details of label to be assigned to the media. Assigns a label only if a label with given id or title is found, does not create a new one.
title (string): Title of the label.id (integer): Id of the label to be assigned.category (string): The name of the category the media should be included in. Assigns the category if the category by the name is found. It does not create a category if corresponding category is not found.
cta_enabled (boolean): Flag to set where the CTA Actions are enabled. Default is false.
cta_action_type (string): Available values are visit_on_click, leads_capture, auto_redirect.
cta_url (string): URL to redirect to. Required if cta_enabled is true.
display_shop (boolean): Flag to specify if the media should be shown in shop. Default is false.
video_shopping_enabled (boolean): Flag to specify if video shopping should be enabled for the media. Only works if it is a video media.
attached_shareables_attributes (array): Details of the video timestamps and shareables to be included to the media as a part of video shopping. While updating the media if attachment_type, attachment_id or timestamp is missing, it is skipped. Pass id and set _destroy to true to delete attached shareable.
attachment_type (string): Type of the shareable. For now, only 'Product' is accepted.attachment_id (integer): Id of the shareable.timestamp (string): Timestamp where the attached shareable should be shown. It should conform to the format HH:MM:SS and should be a valid timestamp for the video.id (integer): Id of the attached shreable object._destroy (boolean): Flag to delete attached shareable object.subtitles (array): Details of subtitles.
lang (string, required): Language of the subtitle. In iso format. For eg. en.src (string): URL of the subtitle file. Keep a blank string to remove the subtitle for given language.prompt_attributes (array): Details for prompts for the media. If id is present, updates the new prompt. Else, creates it.
id (integer): Id of the prompt.title (string): Title of the prompt.content (string): Content of the prompt.Details of the newly created media.
\n","urlObject":{"path":["api","company","media","53"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"18190556-25fe-4de8-a24f-e32eccc666a7"},{"name":"destroy","id":"0c4e44e8-e606-4f6e-910d-f04f7b72e140","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"DELETE","header":[],"url":"fluid.lvh.me:3000/api/company/media/25","description":"This endpoint deletes a media with given id.
\nSuccess or Failure Message
\n","urlObject":{"path":["api","company","media","25"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c4e44e8-e606-4f6e-910d-f04f7b72e140"},{"name":"send_to_top","id":"dfffbd12-1d04-46db-ba7d-1fa083dbcb93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/media/37/send_to_top","description":"This endpoint prioritizes the media with given id and sends it to the top.
\nSuccess or Failure message.
\n","urlObject":{"path":["api","company","media","37","send_to_top"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfffbd12-1d04-46db-ba7d-1fa083dbcb93"},{"name":"send_notifications","id":"1ffedce1-557e-4740-b112-18d6637e106d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"media\": {\n \"available_countries\": [\"us\", \"npl\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/company/media/37/send_notifications","description":"This endpoint sends the notifications to the affiliates from the provided countreis about the media.
\nmedia (object, required): Details of the media.available_countries (array, required): The countries whose affiliates should be notified. Should be an array of country isos. For eg. ['us', 'npl'].Success or Failure message.
\n","urlObject":{"path":["api","company","media","37","send_notifications"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ffedce1-557e-4740-b112-18d6637e106d"}],"id":"7caf2b0f-d418-4dbd-abf7-f2ca09a8a3f7","_postman_id":"7caf2b0f-d418-4dbd-abf7-f2ca09a8a3f7","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Inventory Levels","item":[{"name":"index","id":"afb3680e-edda-4946-a8ea-72308b14832d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/inventory_levels?variant_ids=1,2&warehouse_ids=1,2&published_to=Retail Store, Rep Store&product_tags=test&available_greater_than=0&available_less_than=10&committed_greater_than=0&committed_less_than=10&on_hand_greater_than=0&on_hand_less_than=100&unavailable_greater_than=0&unavailable_less_than=10&page_size=100&page=1&sorted_by=committed_desc","urlObject":{"path":["api","inventory_levels"],"host":["fluid.lvh.me:3000"],"query":[{"description":{"content":"comma-separated variant_ids (variant_ids or warehouse_ids required)
\n","type":"text/plain"},"key":"variant_ids","value":"1,2"},{"description":{"content":"comma-separated warehouse_ids (variant_ids or warehouse_ids required)
\n","type":"text/plain"},"key":"warehouse_ids","value":"1,2"},{"description":{"content":"coma-separated values (allowed values: Retail Store, Rep Store, Share tab)
\n","type":"text/plain"},"key":"published_to","value":"Retail Store, Rep Store"},{"key":"product_tags","value":"test"},{"key":"available_greater_than","value":"0"},{"key":"available_less_than","value":"10"},{"key":"committed_greater_than","value":"0"},{"key":"committed_less_than","value":"10"},{"description":{"content":"","type":"text/plain"},"key":"on_hand_greater_than","value":"0"},{"key":"on_hand_less_than","value":"100"},{"key":"unavailable_greater_than","value":"0"},{"key":"unavailable_less_than","value":"10"},{"key":"page_size","value":"100"},{"key":"page","value":"1"},{"description":{"content":"options: id, created_at, available, unavailable, on_hand, committed. Appedn _desc to sort in descending order. (eg: available_desc)
\n","type":"text/plain"},"key":"sorted_by","value":"committed_desc"}],"variable":[]}},"response":[{"id":"9932ac8b-195d-4f0b-be0b-5329c5d99e9a","name":"index","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/inventory_levels?variant_ids=1,2&warehouse_ids=1,2&published_to=Retail Store, Rep Store&product_tags=test&available_greater_than=0&available_less_than=10&committed_greater_than=0&committed_less_than=10&on_hand_greater_than=0&on_hand_less_than=100&unavailable_greater_than=0&unavailable_less_than=10&page_size=100&page=1&sorted_by=available_desc","host":["fluid.lvh.me:3000"],"path":["api","inventory_levels"],"query":[{"key":"variant_ids","value":"1,2","description":"comma-separated variant_ids (variant_ids or warehouse_ids required)"},{"key":"warehouse_ids","value":"1,2","description":"comma-separated warehouse_ids (variant_ids or warehouse_ids required)"},{"key":"published_to","value":"Retail Store, Rep Store","description":"coma-separated values (allowed values: Retail Store, Rep Store, Share tab)"},{"key":"product_tags","value":"test"},{"key":"available_greater_than","value":"0"},{"key":"available_less_than","value":"10"},{"key":"committed_greater_than","value":"0"},{"key":"committed_less_than","value":"10"},{"key":"on_hand_greater_than","value":"0","description":"\n"},{"key":"on_hand_less_than","value":"100"},{"key":"unavailable_greater_than","value":"0"},{"key":"unavailable_less_than","value":"10"},{"key":"page_size","value":"100"},{"key":"page","value":"1"},{"key":"sorted_by","value":"available_desc","description":"options: id, created_at, available, unavailable, on_hand, committed. Appedn _desc to sort in descending order. (eg: available_desc)\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"f5c951e75c170352ba800f5dbe5c4fb3\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"9966958d-9e58-4e07-8fe2-2e1792efd3f4"},{"key":"X-Runtime","value":"0.146020"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.03, sql.active_record;dur=23.67, instantiation.active_record;dur=2.04, unpermitted_parameters.action_controller;dur=0.04, render.active_model_serializers;dur=0.16, process_action.action_controller;dur=104.25"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"325"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"inventory_levels\": [\n {\n \"id\": 2,\n \"committed\": 3,\n \"available\": 6,\n \"on_hand\": 10,\n \"unavailable\": 1,\n \"variant\": {\n \"id\": 2,\n \"product_id\": 2,\n \"sku\": \"FL1523123MV\"\n },\n \"product\": {\n \"image\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png\",\n \"title\": \"Multi Vitamin Sample Pack\"\n }\n },\n {\n \"id\": 3,\n \"committed\": 5,\n \"available\": 4,\n \"on_hand\": 10,\n \"unavailable\": 1,\n \"variant\": {\n \"id\": 2,\n \"product_id\": 2,\n \"sku\": \"FL1523123MV\"\n },\n \"product\": {\n \"image\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png\",\n \"title\": \"Multi Vitamin Sample Pack\"\n }\n },\n {\n \"id\": 1,\n \"committed\": 1,\n \"available\": 3,\n \"on_hand\": 5,\n \"unavailable\": 1,\n \"variant\": {\n \"id\": 1,\n \"product_id\": 1,\n \"sku\": \"FL145123ZP\"\n },\n \"product\": {\n \"image\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/980190962/gotime.png\",\n \"title\": \"Zip Pack Sample Pack (30)\"\n }\n }\n ]\n }\n}"}],"_postman_id":"afb3680e-edda-4946-a8ea-72308b14832d"},{"name":"Export","id":"11c37098-52f2-478d-bc5a-00abed1df00e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/inventory_levels/export_csv?variant_ids=1,2&warehouse_ids=1,2","urlObject":{"path":["api","inventory_levels","export_csv"],"host":["fluid.lvh.me:3000"],"query":[{"key":"variant_ids","value":"1,2"},{"key":"warehouse_ids","value":"1,2"}],"variable":[]}},"response":[],"_postman_id":"11c37098-52f2-478d-bc5a-00abed1df00e"},{"name":"set","id":"529b1ede-bfee-48ce-bf87-b4426fbee0d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"inventory_level\":{\n \"variant_id\":12, //required\n \"warehouse_id\": 13, //required\n \"reason\": \"New arrivals\", // optional\n \"available\": 12, // optional, default 0\n \"committed\": 5, // optional, default 0\n \"unavailable\": 10, // optional, default 0\n \"on_hand\": 20 // optional, default 0\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000 /api/inventory_levels/set","description":"This endpoint allows you to create or update inventory levels for a specific variant in a warehouse.
\nUpdate: If an inventory level with the specified variant_id and warehouse_id exists, the supplied inventory attributes will be updated.
Create: If no such record exists, a new inventory level record will be created using the supplied attributes.
\ninventory_level (object, required): The inventory level object containing the following parameters:
variant_id (number, required): The ID of the variant.
warehouse_id (number, required): The ID of the warehouse.
reason (string, optional): The reason for the inventory level update.
available (number, optional, default 0): The available inventory quantity.
committed (number, optional, default 0): The committed inventory quantity.
unavailable (number, optional, default 0): The unavailable inventory quantity.
on_hand (number, optional, default 0): The on-hand inventory quantity.
200 OK: Inventory level successfully updated.
\n201 Created: New inventory level record successfully created.
\nThe response will be in the form of a JSON schema and may include the following fields:
\nstatus (string): The status of the response.
data (object)
inventory_level (object)
id (number): The ID of the inventory level.
available (number): The available quantity.
committed (number): The committed quantity.
unavailable (number): The unavailable quantity.
on_hand (number): The on hand quantity.
warning (string): Any warning message.
variant (object)
id (number): The ID of the variant.
sku (string): The SKU of the variant.
product (object)
id (number): The ID of the product.
title (string): The title of the product.
image_url (string): The URL of the product image.
warehouse (object)
id (number): The ID of the warehouse.
country (object)
id (number): The ID of the country.
name (string): The name of the country.
iso (string): The ISO code of the country.
address (object)
id (number): The ID of the address.
city (string): The city of the warehouse.
state (string): The state of the warehouse.
address1 (string): The address line 1 of the warehouse.
postal_code (string): The postal code of the warehouse.
The response will be in JSON format with the following schema:
\n{\n \"status\": \"string\",\n \"data\": {\n \"inventory_level\": {\n \"id\": \"integer\",\n \"available\": \"integer\",\n \"committed\": \"integer\",\n \"unavailable\": \"integer\",\n \"on_hand\": \"integer\",\n \"warning\": \"string\",\n \"variant\": {\n \"id\": \"integer\",\n \"sku\": \"string (nullable)\"\n },\n \"product\": {\n \"id\": \"integer\",\n \"title\": \"string\",\n \"image_url\": \"string\"\n },\n \"warehouse\": {\n \"id\": \"integer\",\n \"country\": {\n \"id\": \"integer\",\n \"name\": \"string\",\n \"iso\": \"string\"\n },\n \"address\": {\n \"id\": \"integer\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"address1\": \"string\",\n \"postal_code\": \"string\"\n }\n }\n }\n }\n}\n\nThe endpoint allows you to adjust the inventory levels by providing the ID of the inventory level, reason for adjustment, quantity, and adjustment attribute.
\ninventory_level (object)
id (number): The ID of the inventory level. Required.
reason (string): The reason for the adjustment. Required.
quantity (number): The quantity to be adjusted. Required.
adjustment_attribute (string): The attribute for adjustment. Required.
The response will be in the form of a JSON schema and may include the following fields:
\nstatus (string): The status of the response.
data (object)
inventory_level (object)
id (number): The ID of the inventory level.
available (number): The available quantity.
committed (number): The committed quantity.
unavailable (number): The unavailable quantity.
on_hand (number): The on hand quantity.
warning (string): Any warning message.
variant (object)
id (number): The ID of the variant.
sku (string): The SKU of the variant.
product (object)
id (number): The ID of the product.
title (string): The title of the product.
image_url (string): The URL of the product image.
warehouse (object)
id (number): The ID of the warehouse.
country (object)
id (number): The ID of the country.
name (string): The name of the country.
iso (string): The ISO code of the country.
address (object)
id (number): The ID of the address.
city (string): The city of the warehouse.
state (string): The state of the warehouse.
address1 (string): The address line 1 of the warehouse.
postal_code (string): The postal code of the warehouse.
{\n \"status\": \"string\",\n \"data\": {\n \"inventory_level\": {\n \"id\": \"integer\",\n \"available\": \"integer\",\n \"committed\": \"integer\",\n \"unavailable\": \"integer\",\n \"on_hand\": \"integer\",\n \"warning\": \"string\",//indication for out of sync inventory, i.e: on_hand != available + unavailable + committed\n \"variant\": {\n \"id\": \"integer\",\n \"sku\": \"string (nullable)\"\n },\n \"product\": {\n \"id\": \"integer\",\n \"title\": \"string\",\n \"image_url\": \"string\"\n },\n \"warehouse\": {\n \"id\": \"integer\",\n \"country\": {\n \"id\": \"integer\",\n \"name\": \"string\",\n \"iso\": \"string\"\n },\n \"address\": {\n \"id\": \"integer\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"address1\": \"string\",\n \"postal_code\": \"string\"\n }\n }\n }\n }\n}\n\nThe endpoint allows you to update multiple inventory levels at once.
\ninventory_levels (object array)
id (number): The ID of the inventory level. Required.
reason (string): The reason for the adjustment.
available (number): The available quantity.
committed (number): The committed quantity.
unavailable (number): The unavailable quantity.
on_hand (number): The on hand quantity.
The response will be in the form of a JSON schema and may include the following fields:
\nstatus (string): The status of the response.
data (object)
inventory_levels (object array)
id (number): The ID of the inventory level.
available (number): The available quantity.
committed (number): The committed quantity.
unavailable (number): The unavailable quantity.
on_hand (number): The on hand quantity.
warning (string): Any warning message.
variant (object)
id (number): The ID of the variant.
sku (string): The SKU of the variant.
product (object)
id (number): The ID of the product.
title (string): The title of the product.
image_url (string): The URL of the product image.
warehouse (object)
id (number): The ID of the warehouse.
country (object)
id (number): The ID of the country.
name (string): The name of the country.
iso (string): The ISO code of the country.
address (object)
id (number): The ID of the address.
city (string): The city of the warehouse.
state (string): The state of the warehouse.
address1 (string): The address line 1 of the warehouse.
postal_code (string): The postal code of the warehouse.
{\n \"status\": \"string\",\n \"data\": {\n \"inventory_levels\": [\n {\n \"id\": \"integer\",\n \"available\": \"integer\",\n \"committed\": \"integer\",\n \"unavailable\": \"integer\",\n \"on_hand\": \"integer\",\n \"warning\": \"string\", // indication for out of sync inventory, i.e: on_hand != available + unavailable + committed\n \"variant\": {\n \"id\": \"integer\",\n \"sku\": \"string\"\n },\n \"product\": {\n \"id\": \"integer\",\n \"title\": \"string\",\n \"image_url\": \"string\"\n },\n \"warehouse\": {\n \"id\": \"integer\",\n \"country\": {\n \"id\": \"integer\",\n \"name\": \"string\",\n \"iso\": \"string\"\n },\n \"address\": {\n \"id\": \"integer\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"address1\": \"string\",\n \"postal_code\": \"string\"\n }\n }\n }\n ]\n }\n}\n\nThis endpoint allows the client to obtain a presigned URL for uploading an inventory levels CSV file.
\nThe response will be in JSON format with the following schema:
\n{\n \"status\": \"string\",\n \"data\": {\n \"url\": \"string\" \n}\n\nImport Inventory level from CSVPOST /api/inventory_levels/import_csv
Create new inventory levels and update fields of existing inventory levels at once using a CSV file provided via a URL. The file is to be uploaded to google cloud storage which can be done by uploading content of the csv file as text to URL that you get in response of POST api/inventory_levels/presigned_csv_url . Then send the URL (without auth query params) as a param url in body to the import_csv API.
The content of the uploaded csv should have following columns with exact headers.
\nurl (string): The link of csv file uploaded to GCS. Required.Indicates that the inventory levels have been imported successfully.
\nExample Response:
\n{\n \"status\": \"string\", // Status of the request\n \"data\": {\n \"created\": \"integer\", // Number of inventory levels successfully created\n \"updated\": \"integer\", // Number of inventory levels successfully updated\n \"failed\": \"integer\", // Number of failed imports\n \"invalid_rows\": \"integer\", // Number of invalid rows in the CSV\n \"import_status_url\": \"string\" // URL for checking the import status\n }\n}\n\nGet all conversations for the user with given email.
\nfilter options available are: by status [open, closed], by kind [direct, group], and by pinned [true, false].
The data is paginated. Page number is sent on page query param.
Available conversation templates:
\nnew_messages
\npinned
\nteam_groups
\nteam_directs
\nteams
\nteams_unread
\nteams_read
\nchannels
\nsms
\nsms_read
\nsms_unread
\nemail_read
\nemail_unread
\nchannels_unread
\nchannels_read
\ncustomers
\ncustomers_unread
\ncustomers_read
\narchived_sms
\narchived_email
\narchived_directs
\narchived_groups
\narchived_teams
\narchived_channels
\narchived_customers
\nbots
\nCreate conversation for a user with given email, and include one or more recipients.
\npossible values for type are: DirectConversation, GroupConversation, ChannelConversation, EmailConversation and SmsConversation
recipients can accept an array.
\n","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}},"urlObject":{"path":["api","company","messaging","conversations.json"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"6c2e3a15-0db7-40ec-a5d0-4c027d809cf5","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"conversation\": {\n \"type\": \"DirectConversation\"\n },\n \"recipients\": [\n {\n \"uid\": 12\n }\n ],\n \"user\": {\n \"email\": \"admin@fluid.app\"\n }\n}"},"url":"fluid.lvh.me:3000/api/company/messaging/conversations.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: niroj USE eager loading detected Recipient =\\u003e [:receivable]\\n Add to your query: .includes([:receivable])\",\"user: niroj USE eager loading detected Recipient =\\u003e [:company]\\n Add to your query: .includes([:company])\"]"},{"key":"X-bullet-console-text","value":"[\"user: niroj\\nUSE eager loading detected\\n Recipient =\\u003e [:receivable]\\n Add to your query: .includes([:receivable])\\nCall stack\\n /Users/niroj/codes/offhack/fluid/app/models/conversation/conversation.rb:365:in `find_or_create_conversation'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/company/messaging/conversations_controller.rb:28:in `create'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:95:in `block in switch_locale'\\n /Users/niroj/codes/offhack/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:94:in `switch_locale'\\n\\n\",\"user: niroj\\nUSE eager loading detected\\n Recipient =\\u003e [:company]\\n Add to your query: .includes([:company])\\nCall stack\\n /Users/niroj/codes/offhack/fluid/app/models/conversation/conversation.rb:365:in `find_or_create_conversation'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/company/messaging/conversations_controller.rb:28:in `create'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:95:in `block in switch_locale'\\n /Users/niroj/codes/offhack/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:94:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"bfaea1a3882152f71a88714ab1d56b51\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"a6a62ed4-d387-4db9-9f35-065f29cc8ce2"},{"key":"X-Runtime","value":"2.267272"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=106.63, instantiation.active_record;dur=4.89, unpermitted_parameters.action_controller;dur=0.01, transaction.active_record;dur=150.39, render.active_model_serializers;dur=87.59, process_action.action_controller;dur=2183.18"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"487"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 8,\n \"name\": \"Ada Stracke\",\n \"description\": null,\n \"kind\": \"direct\",\n \"type\": \"DirectConversation\",\n \"status\": \"initiated\",\n \"created_at\": \"2024-08-19T16:58:59.023Z\",\n \"pinned\": false,\n \"unread_messages_count\": 0,\n \"sms_enabled?\": false,\n \"draft_message\": null,\n \"email_enabled?\": false,\n \"conversation_type\": \"internal\",\n \"messaging_enabled?\": true,\n \"broadcasting\": null,\n \"total_recipients\": 2,\n \"unread\": false,\n \"image_url\": null,\n \"auto_add_recipients\": true,\n \"muted\": false,\n \"announcing\": false,\n \"scheduled_messages_count\": 0,\n \"avatar_background_color\": null,\n \"avatar_emoji\": null,\n \"avatar_url\": null,\n \"recipients\": [\n {\n \"id\": 12,\n \"first_name\": \"Ada\",\n \"last_name\": \"Stracke\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 12,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": false,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Admin\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 1,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": false,\n \"status\": \"online\",\n \"last_online\": \"2024-08-19T15:02:44.914Z\",\n \"country_name\": \"United States\"\n }\n ],\n \"creator\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Admin\",\n \"image_url\": null,\n \"discarded_at\": null,\n \"blocked\": false,\n \"blocker\": false\n }\n}"}],"_postman_id":"6b1cc77b-2003-45ae-b9ba-9624dbbbe757"},{"name":"Show","id":"5d120297-fcd1-43b5-9913-2d9b80242293","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"conversation\": {\n \"type\": \"DirectConversation\"\n },\n \"recipients\": [\n {\n \"uid\": 10\n }\n ]\n}"},"url":"fluid.lvh.me:3000/api/company/messaging/conversations/1.json?user[email]=john.doe@fluid.app","description":"Get conversation details of a single conversation with id=id
\nresponse of the resource:
\n{\n \"id\": 17,\n \"name\": \"Essie Ebert\",\n \"description\": null,\n \"kind\": \"direct\",\n \"type\": \"DirectConversation\",\n \"status\": \"open\",\n \"created_at\": \"2024-06-25T02:52:02.533Z\",\n \"pinned\": false,\n \"unread_messages_count\": 0,\n \"sms_enabled?\": false,\n \"draft_message\": null,\n \"email_enabled?\": false,\n \"conversation_type\": \"internal\",\n \"messaging_enabled?\": true,\n \"broadcasting\": null,\n \"total_recipients\": 2,\n \"unread\": false,\n \"image_url\": null,\n \"auto_add_recipients\": true,\n \"muted\": false,\n \"announcing\": false,\n \"scheduled_messages_count\": 0,\n \"recipients\": [\n {\n \"id\": 10,\n \"first_name\": \"Essie\",\n \"last_name\": \"Ebert\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 10,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": false,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 123,\n \"first_name\": \"Gary\",\n \"last_name\": \"Gilbert\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 1,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": false,\n \"status\": \"offline\",\n \"last_online\": \"2024-06-30T05:55:20.602Z\",\n \"country_name\": \"United States\"\n }\n ],\n \"creator\": {\n \"id\": 123,\n \"first_name\": \"Gary\",\n \"last_name\": \"Gilbert\",\n \"image_url\": null,\n \"discarded_at\": null,\n \"blocked\": false,\n \"blocker\": false\n }\n}\n\nConversations 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.
\nThe 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.
\n","event":[{"listen":"prerequest","script":{"id":"041bb835-67ec-43f7-a189-5c6884e664d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"807a77df-a655-42dd-a9ca-0232ad1df7e4","type":"text/javascript","exec":[""]}}],"_postman_id":"85b2e64e-c140-497a-91f1-16bab86f2859","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}}},{"name":"Messages","item":[{"name":"Create","id":"6017d368-44e1-4f19-8baa-4603fa74ee8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"message\" :{\n \"body\": \"How is it going?\",\n \"theme\": \"inquiry\",\n \"type\": \"DirectMessage\",\n \"sent_at\": \"2022-02-21T11:46:42.379Z\",\n \"attachments_attributes\": [\n {\n \"filename\": \"test.jpg\",\n \"url\": \"https://picsum.photos/id/237/200/300\",\n \"kind\": \"image\"\n }\n ]\n },\n \"user\": {\n \"email\": \"admin@fluid.app\"\n } \n}"},"url":"fluid.lvh.me:3000/api/company/messaging/conversations/8/messages.json","description":"Create a message on a conversation.
\nExplanation of body of the request:
\nDirectMessage, SmsMessage, or EmailMessageattachment_attributes.get all messages for the conversation with id=
\n","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}},"urlObject":{"path":["api","company","messaging","conversations","8","messages.json"],"host":["fluid.lvh.me:3000"],"query":[{"key":"page","value":"1"},{"key":"user[email]","value":"admin@fluid.app"}],"variable":[]}},"response":[{"id":"7f9a7cf2-24eb-41b6-b5a6-67114fe02f22","name":"Index","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"fluid.lvh.me:3000/api/company/messaging/conversations/8/messages.json?page=1&user[email]=admin@fluid.app","host":["fluid.lvh.me:3000"],"path":["api","company","messaging","conversations","8","messages.json"],"query":[{"key":"page","value":"1"},{"key":"user[email]","value":"admin@fluid.app"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: niroj AVOID eager loading detected Recipient =\\u003e [:recipient_messages]\\n Remove from your query: .includes([:recipient_messages])\"]"},{"key":"X-bullet-console-text","value":"[\"user: niroj\\nAVOID eager loading detected\\n Recipient =\\u003e [:recipient_messages]\\n Remove from your query: .includes([:recipient_messages])\\nCall stack\\n /Users/niroj/codes/offhack/fluid/app/models/message/message.rb:373:in `last_seen_by_recipients'\\n /Users/niroj/codes/offhack/fluid/app/serializers/v1/message_serializer.rb:44:in `seen_by'\\n /Users/niroj/codes/offhack/fluid/app/helpers/pagination_helper.rb:18:in `paginate_json'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/company/messaging/messages_controller.rb:15:in `index'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:95:in `block in switch_locale'\\n /Users/niroj/codes/offhack/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:94:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"b9e718f4460c2085da8942c7a94c2d27\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"},{"key":"X-Runtime","value":"0.255755"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=13.92, instantiation.active_record;dur=1.33, transaction.active_record;dur=31.23, render.active_model_serializers;dur=9.56, process_action.action_controller;dur=186.19"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"495"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"pagination\": {\n \"current\": 1,\n \"previous\": null,\n \"next\": null,\n \"per_page\": 20,\n \"pages\": 1,\n \"count\": 1\n }\n },\n {\n \"items\": [\n {\n \"id\": 34,\n \"body\": \"How is it going?\",\n \"type\": \"DirectMessage\",\n \"created_at\": \"2024-08-19T17:04:58.312Z\",\n \"updated_at\": \"2024-08-19T17:04:58.702Z\",\n \"deleted_at\": null,\n \"edited_at\": null,\n \"conversation_id\": 8,\n \"seen_by\": [\n {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Admin\",\n \"image_url\": null,\n \"seen_at\": \"2024-08-19T17:04:58.562Z\"\n }\n ],\n \"attachments\": [\n {\n \"id\": 2,\n \"url\": \"https://picsum.photos/id/237/200/300\",\n \"filename\": \"test.jpg\",\n \"kind\": \"image\",\n \"image_url\": \"https://picsum.photos/id/237/200/300\",\n \"image_path\": null,\n \"content_type\": null,\n \"attachable_type\": \"Message\",\n \"attachable_id\": 34,\n \"thumbnail_url\": \"https://picsum.photos/id/237/200/300\",\n \"metadata\": null,\n \"content_size\": null\n }\n ],\n \"reaction_stats\": null,\n \"reaction\": null,\n \"metadata\": {\n \"links\": []\n },\n \"seen_by_count\": 1,\n \"emoji_only_count\": 0,\n \"mentioned_recipients\": [],\n \"sent_at\": \"2024-08-19T17:04:58.701Z\",\n \"replied_to_message\": null,\n \"sender_recipient\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Admin\",\n \"image_url\": null,\n \"discarded_at\": null,\n \"blocked\": false,\n \"blocker\": false\n }\n }\n ]\n }\n]"}],"_postman_id":"e10ee446-238b-44dc-8c2c-3244435d10a9"}],"id":"34560bce-b648-49f0-9aa8-c60b370c520c","description":"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.
\nMessages 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.
\n","event":[{"listen":"prerequest","script":{"id":"86fc25d3-4ac1-44e1-9ea0-4352a98b7fe5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"280b4141-a23c-4b0e-b7ac-aeb71df5f66d","type":"text/javascript","exec":[""]}}],"_postman_id":"34560bce-b648-49f0-9aa8-c60b370c520c","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}}},{"name":"Recipients","item":[{"name":"search","id":"9dadb33b-01db-44d7-82ff-068867fd3f9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/messaging/recipients/search.json?filters[search_query]=ada&user[email]=admin@fluid.app","description":"This endpoint allows you to search for recipients by providing a search query.
\nfilters[search_query] (string, required): The search query to filter recipients.
filters[sort_by] (string, default: first_name): Sorted by given field.
kind (string, possible values: sms, email): By default, searches for internal users only. If sms is given, searches in sms enabled recipients, if email is given searches in email enabled recipients.
\nThe response will include the details of the recipients matching the search query.
\n","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}},"urlObject":{"path":["api","company","messaging","recipients","search.json"],"host":["fluid.lvh.me:3000"],"query":[{"key":"filters[search_query]","value":"ada"},{"key":"user[email]","value":"admin@fluid.app"}],"variable":[]}},"response":[{"id":"ab50ccaf-e1e3-4b40-ac63-3a63ad38e159","name":"search","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/company/messaging/recipients/search.json?filters[search_query]=ada&user[email]=admin@fluid.app","host":["fluid.lvh.me:3000"],"path":["api","company","messaging","recipients","search.json"],"query":[{"key":"filters[search_query]","value":"ada"},{"key":"user[email]","value":"admin@fluid.app"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: niroj USE eager loading detected Recipient =\\u003e [:country]\\n Add to your query: .includes([:country])\"]"},{"key":"X-bullet-console-text","value":"[\"user: niroj\\nUSE eager loading detected\\n Recipient =\\u003e [:country]\\n Add to your query: .includes([:country])\\nCall stack\\n /Users/niroj/codes/offhack/fluid/app/models/recipient.rb:72:in `country_name'\\n /Users/niroj/codes/offhack/fluid/app/helpers/pagination_helper.rb:18:in `paginate_json'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/company/messaging/recipients_controller.rb:44:in `search'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:95:in `block in switch_locale'\\n /Users/niroj/codes/offhack/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:94:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"51b8879ec6e5da0866d4e9201477b2eb\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ae38e290-343e-4e7e-b98a-ea6f3d3d8aa2"},{"key":"X-Runtime","value":"1.265781"},{"key":"Server-Timing","value":"sql.active_record;dur=44.34, start_processing.action_controller;dur=0.01, instantiation.active_record;dur=31.75, render.active_model_serializers;dur=2.27, process_action.action_controller;dur=207.04"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"654"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"pagination\": {\n \"current\": 1,\n \"previous\": null,\n \"next\": 2,\n \"per_page\": 20,\n \"pages\": 3,\n \"count\": 60\n }\n },\n {\n \"items\": [\n {\n \"id\": 12,\n \"first_name\": \"Ada\",\n \"last_name\": \"Stracke\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 12,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 45,\n \"first_name\": \"Agripina\",\n \"last_name\": \"Gutkowski\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 45,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 39,\n \"first_name\": \"Alfonzo\",\n \"last_name\": \"Rosenbaum\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 39,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 14,\n \"first_name\": \"Bart\",\n \"last_name\": \"Macejkovic\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 14,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 3,\n \"first_name\": \"Berry\",\n \"last_name\": \"Schaefer\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 3,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 25,\n \"first_name\": \"Bessie\",\n \"last_name\": \"Howell\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 25,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 26,\n \"first_name\": \"Bobbi\",\n \"last_name\": \"Bosco\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 26,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 34,\n \"first_name\": \"Britta\",\n \"last_name\": \"Padberg\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 34,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"online\",\n \"last_online\": \"2024-08-19T15:02:44.873Z\",\n \"country_name\": null\n },\n {\n \"id\": 8,\n \"first_name\": \"Carlo\",\n \"last_name\": \"Jacobi\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 8,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 19,\n \"first_name\": \"Carolin\",\n \"last_name\": \"Reichert\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 19,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 21,\n \"first_name\": \"Cathryn\",\n \"last_name\": \"Adams\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 21,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 47,\n \"first_name\": \"China\",\n \"last_name\": \"Jacobson\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 47,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 15,\n \"first_name\": \"Ching\",\n \"last_name\": \"Lueilwitz\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 15,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 30,\n \"first_name\": \"Chong\",\n \"last_name\": \"Jacobson\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 30,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 54,\n \"first_name\": \"Contessa\",\n \"last_name\": \"Raynor\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 54,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 33,\n \"first_name\": \"Dallas\",\n \"last_name\": \"Hahn\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 33,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 24,\n \"first_name\": \"Damian\",\n \"last_name\": \"Stiedemann\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 24,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 35,\n \"first_name\": \"Deb\",\n \"last_name\": \"Ankunding\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 35,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 4,\n \"first_name\": \"Debbra\",\n \"last_name\": \"Parker\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 4,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 28,\n \"first_name\": \"Delena\",\n \"last_name\": \"Ullrich\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 28,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n }\n ]\n }\n]"}],"_postman_id":"9dadb33b-01db-44d7-82ff-068867fd3f9b"},{"name":"Index","id":"df039345-c091-4631-9b5f-e4ae134a528b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"fluid.lvh.me:3000/api/v2.0/messaging/conversations/8/recipients.json?page=1","description":"This endpoint allows you to search for recipients by providing a search query for the given conversation. It is same as recipients/search but this is for a perticular conversations
\nfilters[search_query] (string, required): The search query to filter recipients.
filters[sort_by] (string, default: first_name): Sorted by given field.
kind (string, possible values: sms, email): By default, searches for internal users only. If sms is given, searches in sms enabled recipients, if email is given searches in email enabled recipients.
\nThe response will include the details of the recipients matching the search query.
\n","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}},"urlObject":{"path":["api","v2.0","messaging","conversations","8","recipients.json"],"host":["fluid.lvh.me:3000"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"fc492e6d-9b49-4d3b-ae7b-a179bd2d4f08","name":"Index","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"fluid.lvh.me:3000/api/v2.0/messaging/conversations/8/recipients.json?page=1","host":["fluid.lvh.me:3000"],"path":["api","v2.0","messaging","conversations","8","recipients.json"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: niroj USE eager loading detected Recipient =\\u003e [:country]\\n Add to your query: .includes([:country])\"]"},{"key":"X-bullet-console-text","value":"[\"user: niroj\\nUSE eager loading detected\\n Recipient =\\u003e [:country]\\n Add to your query: .includes([:country])\\nCall stack\\n /Users/niroj/codes/offhack/fluid/app/models/recipient.rb:72:in `country_name'\\n /Users/niroj/codes/offhack/fluid/app/helpers/pagination_helper.rb:18:in `paginate_json'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/v2x0/messaging/recipients_controller.rb:15:in `index'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:95:in `block in switch_locale'\\n /Users/niroj/codes/offhack/fluid/config/initializers/locale.rb:44:in `with_locale'\\n /Users/niroj/codes/offhack/fluid/app/controllers/api/base_controller.rb:94:in `switch_locale'\\n\\n\"]"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"45db75a0f07422d4c98edd04cbf78039\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"2d1e5d5b-716e-4e00-ad87-1108ea952094"},{"key":"X-Runtime","value":"0.125561"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=5.71, instantiation.active_record;dur=0.47, render.active_model_serializers;dur=2.45, process_action.action_controller;dur=58.97"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"301"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"pagination\": {\n \"current\": 1,\n \"previous\": null,\n \"next\": null,\n \"per_page\": 20,\n \"pages\": 1,\n \"count\": 2\n }\n },\n {\n \"items\": [\n {\n \"id\": 12,\n \"first_name\": \"Ada\",\n \"last_name\": \"Stracke\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 12,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": null,\n \"country_name\": null\n },\n {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Admin\",\n \"avatar_url\": null,\n \"image_url\": null,\n \"receivable_id\": 1,\n \"receivable_type\": \"UserCompany\",\n \"discarded_at\": null,\n \"left_conversation_at\": null,\n \"blocked\": null,\n \"status\": \"offline\",\n \"last_online\": \"2024-08-19T17:06:25.243Z\",\n \"country_name\": \"United States\"\n }\n ]\n }\n]"}],"_postman_id":"df039345-c091-4631-9b5f-e4ae134a528b"},{"name":"Show","id":"4ae93d02-cac1-4555-8c5a-e64f1a7ad11d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/recipients/12","description":"This endpoint makes an HTTP GET request to retrieve recipient information for a specific company. The request should include the company ID as a parameter in the URL.
\nMethod: GET
\nURL: fluid.lvh.me:3000/api/company/recipients/10
\nThe response will have a status code of 200 and a content type of application/json. The body of the response will contain recipient information including email, first name, last name, and phone number.
\n","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}},"urlObject":{"path":["api","company","recipients","12"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"d2c6b45a-fae6-4bde-94fd-ddacc1c75659","name":"Show","originalRequest":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/recipients/12"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"1303a185c040399bbf8180dda5c66f5f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"2debbf65-eefe-4ccd-a35e-f7cff034d118"},{"key":"X-Runtime","value":"0.128720"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1.96, instantiation.active_record;dur=0.37, render.active_model_serializers;dur=0.13, process_action.action_controller;dur=29.25"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"116"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"fluid_editor_the_4th@fluid.app\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Stracke\",\n \"phone\": \"+821066871736\"\n}"}],"_postman_id":"4ae93d02-cac1-4555-8c5a-e64f1a7ad11d"}],"id":"f89d2c88-5829-4652-b09d-db49a1aa8517","description":"Recipients in Fluid’s platform represent the entities—whether users, bots, or other actors—that participate in conversations. Each recipient can be a user engaging in a chat, a Broadcast Bot delivering announcements, or a Response Bot offering automated assistance.
\nThe recipient model is designed with flexibility in mind, supporting polymorphic relationships that allow any actor to join and interact within conversations. This structure ensures that communication is fluid and dynamic, enabling a diverse range of interactions while keeping participant management straightforward and scalable. Whether you’re adding users, bots, or other agents, recipients form the backbone of the messaging and interaction system within Fluid’s platform
\n","_postman_id":"f89d2c88-5829-4652-b09d-db49a1aa8517","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":true,"source":{"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","name":"Messaging","type":"folder"}}}],"id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13","description":"The Company APIs for the Messaging System provide a comprehensive set of endpoints to facilitate seamless integration of messaging functionalities into your applications. These APIs allow developers to create and manage conversations, send and retrieve messages, and handle recipient information effectively.
\n","auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d70630df-98bf-4ccc-bc08-a1f480161d16","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"27efef4b-65bd-4cee-9215-5a0785d99f31","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2f0a6432-9d13-41f0-90f5-b7a81b501d13"},{"name":"Warehouses","item":[{"name":"index","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"b6534116-6b29-4455-93b2-5be802eec0a7"}}],"id":"358d09c3-3cba-4523-945a-aedd59263965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_token"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/company/v1/warehouses","description":"This endpoint retrieves a list of warehouses for the company.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"status\": \"string\",\n \"data\": {\n \"warehouses\": [\n {\n \"id\": \"number\", // Unique identifier for the warehouse\n \"name\": \"string\", // Name of the warehouse\n \"active\": \"boolean\", // Status indicating if the warehouse is active\n \"address\": {\n \"id\": \"number\", // Unique identifier for the address\n \"name\": \"string\", // Name or label for the address\n \"address1\": \"string\", // Primary address line\n \"address2\": \"string\", // Secondary address line, optional\n \"address3\": \"string\", // Tertiary address line, optional\n \"city\": \"string\", // City name\n \"state\": \"string\", // State or region name\n \"postal_code\": \"string\" // Postal or ZIP code\n },\n \"country\": {\n \"id\": \"number\", // Unique identifier for the country\n \"iso\": \"string\" // ISO 2-letter country code\n }\n }\n ]\n }\n}\n\n\nThis endpoint retrieves the details of a specific warehouse.
\nMethod: GET
Path Parameter:
\nnumber): The unique identifier of the warehouse. This is a required path parameter and should be specified directly in the URL.{\n \"status\": \"string\",\n \"data\": {\n \"warehouse\": {\n \"id\": \"number\", // Unique identifier for the warehouse\n \"name\": \"string\", // Name of the warehouse\n \"active\": \"boolean\", // Status indicating if the warehouse is active\n \"address\": {\n \"id\": \"number\", // Unique identifier for the address\n \"name\": \"string\", // Name or label for the address\n \"address1\": \"string\", // Primary address line\n \"address2\": \"string\", // Secondary address line, optional\n \"address3\": \"string\", // Tertiary address line, optional\n \"city\": \"string\", // City name\n \"state\": \"string\", // State or region name\n \"postal_code\": \"string\" // Postal or ZIP code\n },\n \"country\": {\n \"id\": \"number\", // Unique identifier for the country\n \"iso\": \"string\" // ISO 2-letter country code\n }\n }\n }\n }\n}\n\nThis endpoint is used to delete a specific warehouse.
\nMethod: DELETE
\nPath Parameter:
\nnumber): The unique identifier of the warehouse. This is a required path parameter and should be specified directly in the URL.The response is in JSON format and has the following schema:
\n{\n \"status\": \"string\",\n \"data\": {\n \"message\": \"string\"\n }\n}\n\n{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"Warehouse deleted successfully\"\n }\n}\n\nThe endpoint 'Create Warehouse' is used to create a new warehouse for the company.
\nMethod: POST
\nRequest Body
\nwarehouse (object)
name (string): The name of the warehouse. Required.
active (boolean): Indicates whether the warehouse is active.
country_id (number): The ID for the country in which the warehouse is located. Required.
city (string): The city where the warehouse is located.
address1 (string): Primary address line of the warehouse location.
address2 (string or null): Secondary address line, if any (e.g., building or suite number).
address3 (string or null): Tertiary address line, if applicable.
state (string): The state or province of the warehouse.
postal_code (string or number): Postal or ZIP code for the warehouse location.
The response will be a JSON object with the following schema:
\n{\n \"status\": \"string\",\n \"data\": {\n \"warehouse\": {\n \"id\": \"number\", // Unique identifier for the warehouse\n \"name\": \"string\", // Name of the warehouse\n \"active\": \"boolean\", // Status indicating if the warehouse is active\n \"address\": {\n \"id\": \"number\", // Unique identifier for the address\n \"name\": \"string\", // Name or label for the address\n \"address1\": \"string\", // Primary address line\n \"address2\": \"string\", // Secondary address line, optional\n \"address3\": \"string\", // Tertiary address line, optional\n \"city\": \"string\", // City name\n \"state\": \"string\", // State or region name\n \"postal_code\": \"string\" // Postal or ZIP code\n },\n \"country\": {\n \"id\": \"number\", // Unique identifier for the country\n \"iso\": \"string\" // ISO 2-letter country code\n }\n }\n }\n}\n\nThis endpoint is used to update the details of a specific warehouse. This request updates the details of a specific warehouse identified by the warehouse_id path parameter. The request payload should contain the updated information for the warehouse.
Method: PATCH
\nPath Parameters
\nwarehouse_id (number, required): The unique ID of the warehouse to be updated. Example: /api/company/v1/warehouses/24Request Body
\nwarehouse (object)
name (string): The name of the warehouse.
active (boolean): Indicates if the warehouse is active.
country_id (number): The ID of the country where the warehouse is located.
city (string): The city where the warehouse is located.
address1 (string): The first line of the warehouse address.
address2 (string): The second line of the warehouse address.
address3 (string, optional): The third line of the warehouse address.
state (string): The state where the warehouse is located.
postal_code (string): The postal code of the warehouse location.
The response will be a JSON object with the following schema:
\n{\n \"status\": \"\",\n \"data\": {\n \"warehouse\": {\n \"id\": \"number\", // Unique identifier for the warehouse\n \"name\": \"string\", // Name of the warehouse\n \"active\": \"boolean\", // Status indicating if the warehouse is active\n \"address\": {\n \"id\": \"number\", // Unique identifier for the address\n \"name\": \"string\", // Name or label for the address\n \"address1\": \"string\", // Primary address line\n \"address2\": \"string\", // Secondary address line, optional\n \"address3\": \"string\", // Tertiary address line, optional\n \"city\": \"string\", // City name\n \"state\": \"string\", // State or region name\n \"postal_code\": \"string\" // Postal or ZIP code\n },\n \"country\": {\n \"id\": \"number\", // Unique identifier for the country\n \"iso\": \"string\" // ISO 2-letter country code\n }\n }\n }\n}\n\nThis API endpoint allows you to assign a warehouse to a specific country.
\nMethod: PATCH
\nPath Parameters:
\nwarehouse_id (number, required): The unique ID of the warehouse to be assigned to a new country. This ID is passed as part of the URL.
Example: /api/company/v1/warehouses/19/assign_to_country
Query Parameters:
\ncountry_id (number, required): The ID of the country to which the warehouse should be assigned. This is passed as a query parameter.
Example: country_id=65
customs (string, optional): The customs type to be applied to the warehouse in the new country. This parameter is required only if the warehouse is being assigned to a country other than it's located. The valid values for the customs parameter are:
DDP: Delivered Duty Paid (where the seller assumes responsibility for all duties and taxes).
\nDAP: Delivered At Place (where the buyer assumes responsibility for duties and taxes at the destination).
\n**Note**: If the warehouse's current country is the same as the country being assigned (`country_id`), the `customs` parameter is **not required**. However, if the warehouse is being reassigned to a different country, the `customs` parameter is **required** and must be one of the values in **CUSTOMS_OPTIONS** (`DDP` or `DAP`).\n\nThe request does not include a request body.
\nThe response is in JSON format and includes the following schema:
\n{\n \"status\": \"string\",\n \"data\": {\n \"company_country\": {\n \"id\": \"number\",\n \"base_shipping\": \"number\",\n \"shipper\": \"string or null\",\n \"shipping_login\": \"string or null\",\n \"shipping_password\": \"string or null\",\n \"warehouse_id\": \"number\",\n \"company\": {\n \"id\": \"number\",\n \"name\": \"string\",\n },\n \"country\": {\n \"id\": \"number\",\n \"iso\": \"string\",\n }\n }\n }\n}\n\nGet all subscription orders with optional filters.
\n","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}},"urlObject":{"path":["api","v2","subscription_orders"],"host":["fluid.lvh.me:3000"],"query":[{"disabled":true,"description":{"content":"Filter subscription orders by customer_id
\n","type":"text/plain"},"key":"buyer_id","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by customer_id
\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by shipping address' country
\n","type":"text/plain"},"key":"ship_to_country_id","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by start_date of next_bill_date
\n","type":"text/plain"},"key":"next_bill_date_start_date","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by end_date of next_bill_date
\n","type":"text/plain"},"key":"next_bill_date_end_date","value":""},{"disabled":true,"description":{"content":"Page number for pagination
\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"90a5084d-bcb4-4cfd-bafb-cc36cf2f609e","name":"index","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/v2/subscription_orders","host":["fluid","lvh","me"],"port":"3000","path":["api","v2","subscription_orders"],"query":[{"key":"customer_id","value":null,"description":"Filter subscription orders by customer_id","disabled":true},{"key":"ship_to_country_id","value":null,"description":"Filter subscription orders by shipping address' country","disabled":true},{"key":"next_bill_date_start_date","value":null,"description":"Filter subscription orders by start_date of next_bill_date","disabled":true},{"key":"next_bill_date_end_date","value":null,"description":"Filter subscription orders by end_date of next_bill_date","disabled":true},{"key":"page","value":null,"description":"Page number for pagination","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"6c056a04008f07c0d45f8d4eb80bc2fc\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"186a4912-910a-4750-b377-f68219ac1c5f"},{"key":"X-Runtime","value":"0.188764"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=19.14, instantiation.active_record;dur=1.92, render.active_model_serializers;dur=3.19, process_action.action_controller;dur=84.02"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"875"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"subscription_orders\": [\n {\n \"id\": 68,\n \"amount\": \"10.0\",\n \"created_at\": \"2024-11-20T12:21:08.291Z\",\n \"updated_at\": \"2024-11-20T12:21:08.595Z\",\n \"bill_date\": \"2024-12-20\",\n \"next_bill_date\": \"2025-01-20\",\n \"days_until_next_bill_date\": 61,\n \"subscription_interval\": 1,\n \"status\": \"Awaiting Payment\",\n \"bill_to\": {\n \"id\": 980190990,\n \"name\": \"Samantha Rose\",\n \"address1\": \"324N Presidental Avenue\",\n \"address2\": null,\n \"address3\": null,\n \"city\": \"Penedo\",\n \"state\": \"Alagoas\",\n \"subdivision_code\": \"AL\",\n \"postal_code\": \"57051-415\",\n \"country_code\": \"BR\",\n \"default\": false\n },\n \"ship_to\": {\n \"id\": 980190990,\n \"name\": \"Samantha Rose\",\n \"address1\": \"324N Presidental Avenue\",\n \"address2\": null,\n \"address3\": null,\n \"city\": \"Penedo\",\n \"state\": \"Alagoas\",\n \"subdivision_code\": \"AL\",\n \"postal_code\": \"57051-415\",\n \"country_code\": \"BR\",\n \"default\": false\n },\n \"order_thumbnail\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png\",\n \"customer\": null,\n \"buyer\": null,\n \"user\": null,\n \"payment_method\": {\n \"id\": 6,\n \"spreedly_token\": \"01JD4R9PDDBEMR3M22XKY4BN2N\",\n \"full_name\": \"Samantha Rose\",\n \"month\": 12,\n \"year\": 2028,\n \"number\": \"XXXX-XXXX-XXXX-1111\",\n \"last_four_digits\": \"1111\",\n \"first_six_digits\": \"411111\",\n \"card_type\": \"visa\",\n \"default\": false,\n \"email\": null,\n \"source\": \"card\"\n },\n \"subtotal\": \"10.0\",\n \"tax\": \"0.0\",\n \"discount\": \"0.0\",\n \"shipping\": \"0.0\",\n \"total\": \"10.0\",\n \"items\": [\n {\n \"id\": 20,\n \"product\": {\n \"title\": \"Gorgeous Iron Shirt30\",\n \"image_url\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png\"\n },\n \"variant\": {\n \"title\": \"Default Variant\",\n \"image_url\": null\n }\n }\n ],\n \"activities\": []\n },\n {\n \"id\": 66,\n \"amount\": \"6.0\",\n \"created_at\": \"2024-11-20T12:14:50.117Z\",\n \"updated_at\": \"2024-11-20T14:10:04.533Z\",\n \"bill_date\": \"2024-12-20\",\n \"next_bill_date\": \"2025-01-20\",\n \"days_until_next_bill_date\": 61,\n \"subscription_interval\": 1,\n \"status\": \"Awaiting Payment\",\n \"bill_to\": {\n \"id\": 980190987,\n \"name\": \"Spreedly Tester\",\n \"address1\": \"324 University Blvd\",\n \"address2\": null,\n \"address3\": null,\n \"city\": \"Provo\",\n \"state\": \"Utah\",\n \"subdivision_code\": \"UT\",\n \"postal_code\": \"84604\",\n \"country_code\": \"US\",\n \"default\": false\n },\n \"ship_to\": {\n \"id\": 980190987,\n \"name\": \"Spreedly Tester\",\n \"address1\": \"324 University Blvd\",\n \"address2\": null,\n \"address3\": null,\n \"city\": \"Provo\",\n \"state\": \"Utah\",\n \"subdivision_code\": \"UT\",\n \"postal_code\": \"84604\",\n \"country_code\": \"US\",\n \"default\": false\n },\n \"order_thumbnail\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/980190962/gotime.png\",\n \"customer\": null,\n \"buyer\": {\n \"id\": 10,\n \"first_name\": \"Bronwyn\",\n \"last_name\": \"Jones\",\n \"image_url\": null\n },\n \"user\": null,\n \"payment_method\": {\n \"id\": 5,\n \"spreedly_token\": \"01JD4QY50A8BQQ6DGK0ZJ61YEC\",\n \"full_name\": \"Jon Noj\",\n \"month\": 1,\n \"year\": 2025,\n \"number\": \"XXXX-XXXX-XXXX-1111\",\n \"last_four_digits\": \"1111\",\n \"first_six_digits\": \"411111\",\n \"card_type\": \"visa\",\n \"default\": false,\n \"email\": null,\n \"source\": \"card\"\n },\n \"subtotal\": \"6.0\",\n \"tax\": \"0.0\",\n \"discount\": \"0.0\",\n \"shipping\": \"0.0\",\n \"total\": \"6.0\",\n \"items\": [\n {\n \"id\": 18,\n \"product\": {\n \"title\": \"Enormous Leather Computer20\",\n \"image_url\": \"https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/980190962/gotime.png\"\n },\n \"variant\": {\n \"title\": \"Cyan-Xl\",\n \"image_url\": null\n }\n }\n ],\n \"activities\": []\n }\n ]\n }\n}"}],"_postman_id":"6974bd2b-0b7e-4242-9cc8-5e09e7308f62"},{"name":"stats","id":"738967dd-61ef-4f8b-a450-61acd5b34567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/v2/subscription_orders/stats","description":"Get statistics for subscription orders with optional filters.
\n","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}},"urlObject":{"path":["api","v2","subscription_orders","stats"],"host":["fluid.lvh.me:3000"],"query":[{"disabled":true,"description":{"content":"Filter subscription orders by customer_id
\n","type":"text/plain"},"key":"buyer_id","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by customer_id
\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by shipping address' country
\n","type":"text/plain"},"key":"ship_to_country_id","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by start_date of next_bill_date
\n","type":"text/plain"},"key":"next_bill_date_start_date","value":""},{"disabled":true,"description":{"content":"Filter subscription orders by end_date of next_bill_date
\n","type":"text/plain"},"key":"next_bill_date_end_date","value":""}],"variable":[]}},"response":[{"id":"69b52b88-f059-4626-a018-a44c376bfa1e","name":"stats","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/v2/subscription_orders/stats","host":["fluid.lvh.me:3000"],"path":["api","v2","subscription_orders","stats"],"query":[{"key":"customer_id","value":null,"description":"Filter subscription orders by customer_id","disabled":true},{"key":"ship_to_country_id","value":null,"description":"Filter subscription orders by shipping address' country","disabled":true},{"key":"next_bill_date_start_date","value":null,"description":"Filter subscription orders by start_date of next_bill_date","disabled":true},{"key":"next_bill_date_end_date","value":null,"description":"Filter subscription orders by end_date of next_bill_date","disabled":true},{"key":"page","value":"","description":"Page number for pagination","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"5fa083e2faff07a03942980ce4068cf9\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f0906c8a-bd81-438e-9398-9af99f8a0798"},{"key":"X-Runtime","value":"0.183788"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=20.01, instantiation.active_record;dur=0.49, render.active_model_serializers;dur=0.09, process_action.action_controller;dur=78.29"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"97"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"subscriptions_count\": 0,\n \"active_subscriptions_count\": 0,\n \"cancelled_subscriptions_count\": 0\n }\n}"}],"_postman_id":"738967dd-61ef-4f8b-a450-61acd5b34567"}],"id":"4b620e87-31a0-4602-9a2d-f5832b4973f9","_postman_id":"4b620e87-31a0-4602-9a2d-f5832b4973f9","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"CustomerNotes","item":[{"name":"index","id":"d8bbad19-dcee-4288-9393-72693582ee5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"GET","header":[],"url":"fluid.lvh.me:3000/api/customer_notes?customer_id=1&page=1&per_page=10","urlObject":{"path":["api","customer_notes"],"host":["fluid.lvh.me:3000"],"query":[{"key":"customer_id","value":"1"},{"key":"page","value":"1"},{"key":"per_page","value":"10"}],"variable":[]}},"response":[{"id":"62d64673-6933-45f1-86c6-30e9d41fc875","name":"index","originalRequest":{"method":"GET","header":[],"url":{"raw":"fluid.lvh.me:3000/api/customer_notes?customer_id=1&page=1&per_page=10","host":["fluid.lvh.me:3000"],"path":["api","customer_notes"],"query":[{"key":"customer_id","value":"1"},{"key":"page","value":"1"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"08cdd236ae65230419f84bca836b8031\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"4f50f950-9b75-4e85-b911-1c6b3f82ec49"},{"key":"X-Runtime","value":"0.269366"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=25.39, instantiation.active_record;dur=1.27, render.active_model_serializers;dur=0.19, process_action.action_controller;dur=73.39"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"254"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"customer_notes\": [\n {\n \"id\": 5,\n \"user_id\": 2,\n \"username\": \"Marilynn Jacobs\",\n \"customer_id\": 1,\n \"note\": \"This is a note from CSR for the customer with id 1\",\n \"resource_id\": 130,\n \"resource_type\": \"Order\",\n \"created_at\": \"2024-11-20T05:37:02.598Z\"\n },\n {\n \"id\": 4,\n \"user_id\": 2,\n \"username\": \"Marilynn Jacobs\",\n \"customer_id\": 1,\n \"note\": \"This is a note from CSR for the customer with id 1\",\n \"resource_id\": 130,\n \"resource_type\": \"Order\",\n \"created_at\": \"2024-11-20T05:36:15.230Z\"\n },\n {\n \"id\": 3,\n \"user_id\": 2,\n \"username\": \"Marilynn Jacobs\",\n \"customer_id\": 1,\n \"note\": \"This is a note from CSR for the customer with id 1\",\n \"resource_id\": 130,\n \"resource_type\": \"Order\",\n \"created_at\": \"2024-11-18T06:10:55.623Z\"\n },\n {\n \"id\": 2,\n \"user_id\": 2,\n \"username\": \"Marilynn Jacobs\",\n \"customer_id\": 1,\n \"note\": \"This is a note from CSR for the customer with id 1\",\n \"resource_id\": 130,\n \"resource_type\": \"Order\",\n \"created_at\": \"2024-11-18T06:03:48.006Z\"\n }\n ]\n }\n}"}],"_postman_id":"d8bbad19-dcee-4288-9393-72693582ee5a"},{"name":"create","id":"a4452a68-e7d5-43f9-ad1b-1f6bf5fc8f99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"userCompanyToken"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer_note\": {\n \"customer_id\": 1, // Required\n \"user_id\": 2, // Required\n \"note\": \"This is a note from CSR for the customer with id 1\", // Required\n \"resource_id\": 130, // Optional\n \"resource_type\": \"Order\" // Optional\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/customer_notes","urlObject":{"path":["api","customer_notes"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"e93b9a54-5944-4370-9c6f-bf217123941b","name":"create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer_note\": {\n \"customer_id\": 1, // Required\n \"user_id\": 2, // Required\n \"note\": \"This is a note from CSR for the customer with id 1\", // Required\n \"resource_id\": 130, // Optional\n \"resource_type\": \"Order\" // Optional\n }\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/customer_notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"87c1694e2e43e5c7e9384135298e92f3\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0cfcd91f-e1d9-4275-860b-dab4977d3854"},{"key":"X-Runtime","value":"0.125946"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=11.37, instantiation.active_record;dur=0.67, start_transaction.active_record;dur=0.01, transaction.active_record;dur=5.07, render.active_model_serializers;dur=0.07, process_action.action_controller;dur=33.08"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"204"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"customer_note\": {\n \"id\": 6,\n \"user_id\": 2,\n \"username\": \"Marilynn Jacobs\",\n \"customer_id\": 1,\n \"note\": \"This is a note from CSR for the customer with id 1\",\n \"resource_id\": 130,\n \"resource_type\": \"Order\",\n \"created_at\": \"2024-11-20T05:45:20.872Z\"\n }\n }\n}"}],"_postman_id":"a4452a68-e7d5-43f9-ad1b-1f6bf5fc8f99"}],"id":"f6cd5315-1cb8-46ec-93ce-2d773eb9cae1","description":"Endpoint to list customer notes given the customer_id and create new customer notes.
\n","_postman_id":"f6cd5315-1cb8-46ec-93ce-2d773eb9cae1","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}},{"name":"Variants Country Copy","item":[{"name":"index","id":"6b960b4e-d022-49fd-883a-cfdef48e3139","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"variant_ids\": [89, 90, 91, 92, 93]\n}","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/v1/variants/variant_countries","description":"This endpoint retrieves the variants for product with given id.
\nDetails of the variants for the product with given id.
\n","urlObject":{"path":["api","v1","variants","variant_countries"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b960b4e-d022-49fd-883a-cfdef48e3139"},{"name":"Bulk Update","id":"08cfe7ff-13dc-423a-8ddb-d0e4b992b1e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"company_admin_token"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"variant_countries\": [\n {\n \"sku\": \"8EPK0IOYUAaa\",\n \"country_code\": \"AD\",\n \"price\": 250.0,\n \"wholesale\": 200.0,\n \"cv\": 30,\n \"qv\": 35,\n \"pc_cv\": 20,\n \"pc_qv\": 25\n },\n {\n \"sku\": \"82WSIM3KY5\",\n \"country_code\": \"AD\",\n \"price\": 120.0,\n \"wholesale\": 110.0,\n \"cv\": 12,\n \"qv\": 18,\n \"pc_cv\": 10,\n \"pc_qv\": 14\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/v1/variants/variant_countries/bulk_update","description":"This endpoint updates multiple variant_countries details for a product's variants based on the provided sku and country-specific attributes ie. iso.
\nsku (string): SKU of the variant. Used to uniquely identify the variant.
country_code (string): ISO 3166-1 alpha-2 country code (e.g., \"AD\"). Identifies the country for the variant update.
cv (integer): Commissionable Volume (CV) for the variant in the specified country.
qv (integer): Qualifying Volume (QV) for the variant in the specified country.
price (numeric): Selling price of the variant in the specified country.
wholesale (numeric): Wholesale price for the variant in the specified country.
pc_cv (integer): Personal Commissionable Volume (PC CV) representing individual earnings from this variant.
pc_qv (integer): Personal Qualifying Volume (PC QV) representing the individual qualification metric.
Details of the variants for the product with given id.
\n","urlObject":{"path":["api","v1","variants","variant_countries","bulk_update"],"host":["fluid.lvh.me:3000"],"query":[],"variable":[]}},"response":[{"id":"34dedd8c-4a5f-45b6-9b5e-22efe937e909","name":"create Copy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"warehouse\": {\n \"name\": \"Central Warehouse\", // required\n \"active\": true,\n \"country_id\": 214, // required; corresponds to the country United States\n \"city\": \"Salt Lake City\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Building A, Suite 200\",\n \"address3\": null,\n \"state\": \"Utah\",\n \"postal_code\": \"84101\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"http://fluid.lvh.me:3000/api/company/v1/warehouses.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"eb7a6d563c5ad8b527f86262671d87c6\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"c8cf69e2-b70f-4b53-8f60-077b2119c053"},{"key":"X-Runtime","value":"0.129133"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=11.17, instantiation.active_record;dur=0.81, start_transaction.active_record;dur=0.00, transaction.active_record;dur=96.26, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=111.01"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"221"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"warehouse\": {\n \"id\": 25,\n \"name\": \"Central Warehouse\",\n \"active\": true,\n \"country\": {\n \"id\": 214,\n \"iso\": \"US\"\n },\n \"address\": {\n \"id\": 980191043,\n \"name\": null,\n \"address1\": \"123 Main St\",\n \"address2\": \"Building A, Suite 200\",\n \"address3\": null,\n \"city\": \"Salt Lake City\",\n \"state\": \"Utah\",\n \"postal_code\": \"84101\"\n }\n }\n }\n}"},{"id":"10cc9dca-f729-4ed2-ad30-dc61cecceb33","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"variant_countries\": [\n {\n \"sku\": \"8EPK0IOYUA\",\n \"country_code\": \"AD\",\n \"price\": 250.0,\n \"wholesale\": 200.0,\n \"cv\": 30,\n \"qv\": 35,\n \"pc_cv\": 20,\n \"pc_qv\": 25\n },\n {\n \"sku\": \"82WSIM3KY5\",\n \"country_code\": \"AD\",\n \"price\": 120.0,\n \"wholesale\": 110.0,\n \"cv\": 12,\n \"qv\": 18,\n \"pc_cv\": 10,\n \"pc_qv\": 14\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/v1/variants/variant_countries/bulk_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"1407fe174bb23543dc187176ed569966\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8117c0db-b9f9-4fce-8da2-0f41c408aad6"},{"key":"X-Runtime","value":"0.092305"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=16.22, instantiation.active_record;dur=0.72, unpermitted_parameters.action_controller;dur=0.01, start_transaction.active_record;dur=0.01, transaction.active_record;dur=39.07, render.active_model_serializers;dur=0.44, process_action.action_controller;dur=56.40"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Content-Length","value":"347"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"variant_country\": {\n \"price\": \"250.0\",\n \"wholesale\": \"200.0\",\n \"cv\": 30,\n \"qv\": 35,\n \"pc_cv\": 20,\n \"pc_qv\": 25,\n \"country_id\": 5,\n \"id\": 2134,\n \"variant_id\": 92,\n \"active\": false,\n \"created_at\": \"2024-10-07T06:54:15.974Z\",\n \"updated_at\": \"2024-11-25T07:08:22.907Z\",\n \"shipping\": \"0.0\",\n \"shipping_time\": null,\n \"tax\": \"0.0\",\n \"currency_code\": \"EUR\",\n \"subscription_price\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"external_id\": null,\n \"compare_price\": \"0.0\"\n },\n \"status\": \"success\"\n },\n {\n \"variant_country\": {\n \"price\": \"120.0\",\n \"wholesale\": \"110.0\",\n \"cv\": 12,\n \"qv\": 18,\n \"pc_cv\": 10,\n \"pc_qv\": 14,\n \"country_id\": 5,\n \"id\": 2133,\n \"variant_id\": 91,\n \"active\": false,\n \"created_at\": \"2024-10-07T06:54:15.959Z\",\n \"updated_at\": \"2024-11-25T06:58:31.290Z\",\n \"shipping\": \"0.0\",\n \"shipping_time\": null,\n \"tax\": \"0.0\",\n \"currency_code\": \"EUR\",\n \"subscription_price\": \"0.0\",\n \"wholesale_subscription_price\": \"0.0\",\n \"cost_of_goods_sold\": \"0.0\",\n \"external_id\": null,\n \"compare_price\": \"0.0\"\n },\n \"status\": \"success\"\n }\n ]\n}"},{"id":"8441df85-fa43-40da-b7d1-0cc4c61eeea4","name":"fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"variant_countries\": [\n {\n \"sku\": \"8EPK0IOYUAaa\",\n \"country_code\": \"AD\",\n \"price\": 250.0,\n \"wholesale\": 200.0,\n \"cv\": 30,\n \"qv\": 35,\n \"pc_cv\": 20,\n \"pc_qv\": 25\n },\n {\n \"sku\": \"82WSIM3KY5\",\n \"country_code\": \"AD\",\n \"price\": 120.0,\n \"wholesale\": 110.0,\n \"cv\": 12,\n \"qv\": 18,\n \"pc_cv\": 10,\n \"pc_qv\": 14\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"fluid.lvh.me:3000/api/v1/variants/variant_countries/bulk_update"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"8c94f923-572f-46ac-b5e8-6eaab5198467"},{"key":"X-Runtime","value":"0.060984"},{"key":"Server-Timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=11.33, instantiation.active_record;dur=0.45, unpermitted_parameters.action_controller;dur=0.00, start_transaction.active_record;dur=0.00, transaction.active_record;dur=22.37, render.active_model_serializers;dur=0.05, process_action.action_controller;dur=34.41"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"fail\",\n \"errors\": [\n {\n \"sku\": \"8EPK0IOYUAaa\",\n \"error\": \"Variant not found\"\n }\n ]\n}"}],"_postman_id":"08cfe7ff-13dc-423a-8ddb-d0e4b992b1e7"}],"id":"2423c534-26a6-4dc9-ade1-f81528694df1","_postman_id":"2423c534-26a6-4dc9-ade1-f81528694df1","description":"","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}}],"id":"1a0d66e4-2d9b-418d-a2bb-7847c7844a80","description":"This API documentation explains endpoints used by company to manage their related resources in Fluid Application.
\nThis is also helpful for the partner application who have subscribed to our webhooks as outlined on
Fluid Webhook documentation to make updates to Fluid application based on the event messages received.
Fluid API accepts request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Developers can use their language/library of choice to make a request.
\nFluid uses token based authentication for company related endpoints and basic authentication for users.
\nThe token is a text string, included in the request header.Authorization: Bearer Token
Token for the company can be obtained from admin settings page.
\nStep 1: Get the company token from admin settings.
\nStep 2: Use company token received in step 1 to build authorization headers (setting authorization header is explained on each endpoints in this doc.)
\nFluid provides an option for partner apps to subscribe to changes occurring within Fluid. This documentation provides comprehensive guide for using webhooks to subscribe to events in fluid.
\nPartners can setup Webhooks which are the endpoints on external application that can listen to Events originating from actions on Fluid. It will be the responsibility of the partners to ensure that the webhooks accept the events and process them accordingly. The server that receives the events can either send back the response or use the queue mechanism to process the events asynchronously and send back the data to fluid using the api endpoints.
\n![](\"https://lh7-us.googleusercontent.com/x9MaSwjnaNjEY6g4fzPA4AXAYX9q0UEgnyaH3vO83oyhphCbGHVJOio5AOlHToRfOFmnTCx9ZkEfubwBePgnEBm9As7MiKJdUs2V2n1ntZt7yiUU_hp7QbECSG5FoNdBc55Qy0u9LwYv_ep6F9CphUQ\")
\n\nWebhook: A single event message. Fluid sends an event to an app's webhook subscription endpoint. A webhook event contains a JSON payload in the body.
\nWebhook subscription: A persisted data object that can be created on fluid which defines the following:
\nThe event name (cart_updated, cart_abandoned etc) that the app wants to receive.
\nA webhook subscription endpoint, or the destination where Fluid sends event messages for the specified event type.
\nEvents 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.
\nExample:
\n{ \n \"id\": \"xxxx\",\n \"name\": \"cart_updated\",\n \"timestamp\": \"2023-05-05T14:48:00.000Z\",\n \"payload\": {\n \"cart\": { ... }, \n }\n}\n\n*completed means order is paid and shipped to ship_to address
\n**cancelable means order that are either (waiting_payment or shipment) and not (delivered, shipped, archived, cancelled)
\nFluid empowers partners to provide their own custom implementation of shipping calculation.
\nPre-requisite: A product with multiple variants as needed and their respective pricing information including shipping, CV, Country, SKU, etc. Cart has necessary information to calculate the tax and shipping like line items and shipping address.
\nFlow:
Once a product is added to the cart, the cart is created on the database with the selected product variant.
1. When cart_item is updated, it sends the event cart_updated to the provided webhook URL. This webhook URL is defined from the admin panel under developer settings( {fluid_url}/settings/developer where fluid_url is the url generated for the partner company).
\n2. We are expecting to receive the data on our api https://v1.fluid.app/api/carts asynchronously with following payload.
\n{\n \"cart_token\": \"xxxx\",\n \"currency_code\": \"USD\",\n \"shipping_options\": [\n {\n \"code\":\"fedex_ground\",\n \"name\":\"FedEx Ground\",\n \"price\":\"0.00\",\n \"delivery_date\":\"2023-05-06\" (optional)\n },\n {\n \"code\":\"ups_express\", (optional: if not provided create code from name)\n \"name\":\"UPS 2-day Express Saver\",\n \"price\":\"5.79\",\n \"delivery_date\":\"2023-05-03\" (optional)\n }\n ],\n \"tax_total\":\"XXYY\"\n}\n\nPartners can also choose to provide this information alongside the response for the webhook events submitted to external application.
\n3. The cart is now updated and reflects the information provided by the external application. However the updates will be rejected if the cart has already transitioned to complete state.
\nFailure Case:
1. The application will wait for the shipping information until the cart is finalized. In case of any kind of failure, the fallback option will be Manual value set on the product settings.
Fluid has two options available for the tax calculation:
\nAutomated tax calculation using Avalara.
\nManual tax values that can provided on the pricing section on Variant setting page.
\nAvalara helps businesses of all sizes get tax compliance right. In partnership with leading ERP, accounting, e-commerce, and other financial management system providers, Avalara delivers cloud-based compliance solutions for various transaction taxes, including sales and use, VAT, GST, excise, communications, lodging, customs duties, and other indirect tax types. Headquartered in Seattle, Avalara has offices across the U.S. and around the world in Canada, the U.K., Belgium, Brazil, and India. Each year, the company processes billions of indirect tax transactions for customers and users and files more than a million tax returns and other compliance documents.
\n\n","_postman_id":"1a0d66e4-2d9b-418d-a2bb-7847c7844a80","auth":{"type":"inherit","inherit":{},"isInherited":true,"source":{"_postman_id":"3268f07f-366c-4d1f-bed8-9c26203714b0","id":"3268f07f-366c-4d1f-bed8-9c26203714b0","name":"Fluid APIs Live","type":"collection"}}}],"auth":{"type":"inherit","inherit":{}},"event":[{"listen":"prerequest","script":{"id":"57327b67-31f3-4d45-8d67-20235858a67d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b9b219ab-9163-4ba3-8edb-b33108217f1c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"fluid.lvh.me:3000"},{"key":"base_url","value":"fluid.lvh.me:3000","type":"string"},{"key":"companyToken","value":"company_token"},{"key":"company_token","value":"company_admin_token","type":"string"},{"key":"userEmail","value":"admin_email"},{"key":"userPassword","value":"password"},{"key":"subdomain","value":"subdomain/"},{"key":"cart_token","value":"xxyy"},{"key":"api_token","value":"api_token\n","type":"string"},{"key":"affiliate_id","value":"affiliate_id","type":"string"},{"key":"affiliate_auth_token","value":"affiliate_auth_token","type":"string"},{"key":"userCompanyToken","value":"userCompanyToken","type":"string"}]}