Company Pages
/
Duplicate a page

Fluid Commerce APIs (1.0)

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

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company Pages

Operations

Retrieve a list of company pages

Request

Get all company pages for the current company, filtered by the current language.

Query
page_numberinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
by_metadatastring(json)

Search JSON meta data

Default "{}"
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/pages?by_metadata={}&page_number=1&per_page=10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

pages retrieved

Bodyapplication/jsonArray [
One of:
paginationobject
]
Response
application/json
[
  {
    "pagination": { … }
  }
]

Create a new company page

Request

Create a new company page

Bodyapplication/json
pageobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/pages \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": {
      "title": "Page Title",
      "html_code": "<p>Page content</p>",
      "publish": true,
      "image_url": "https://example.com/image.jpg",
      "available_countries": [
        "US"
      ],
      "metadata": {}
    }
  }'

Responses

page created

Bodyapplication/json
idinteger
Example: 1
titlestring
Example: "Page Title"
slugstring
Example: "page-title"
labelstring or null
Example: "Trending"
display_tagstring or null
Example: "Display tag"
share_linkstring or null
Example: "https://example.com/page-title"
activeboolean
Example: true
metadataobject

A JSON object that can store any custom data structure.

countriesArray of strings
Example: ["US"]
stripped_descriptionstring or null
Example: "Page description"
viewsinteger
Example: 100
leadsinteger
Example: 10
image_urlstring or null
Example: "https://example.com/image.jpg"
sourcestring or null
Example: "builder"
publishboolean
Example: true
promptsArray of objects
html_codestring
prompts_enabledboolean
jsonstring or null
application_theme_templateobject or null
search_engine_optimizerobject or null
use_search_engineboolean
show_on_site_searchboolean
emailstring or null
versionsArray of objects
open_graphobject or null
Response
application/json
{
  "id": 1,
  "title": "Page Title",
  "slug": "page-title",
  "label": "Trending",
  "display_tag": "Display tag",
  "share_link": "https://example.com/page-title",
  "active": true,
  "metadata": {},
  "countries": [
    "US"
  ],
  "stripped_description": "Page description",
  "views": 100,
  "leads": 10,
  "image_url": "https://example.com/image.jpg",
  "source": "builder",
  "publish": true,
  "prompts": [
    { … }
  ],
  "html_code": "string",
  "prompts_enabled": true,
  "json": "string",
  "application_theme_template": {},
  "search_engine_optimizer": {
    "id": 0,
    "title": "string",
    "description": "string",
    "image_url": "string"
  },
  "use_search_engine": true,
  "show_on_site_search": true,
  "email": "string",
  "versions": [
    { … }
  ],
  "open_graph": {
    "id": 0,
    "title": "string",
    "description": "string",
    "image_url": "string"
  }
}

Retrieve a single company page

Request

Fetch a specific page by its ID for the current company.

Path
idintegerrequired

Page's Id

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

Responses

page retrieved

Bodyapplication/json
idinteger
Example: 1
titlestring
Example: "Page Title"
slugstring
Example: "page-title"
labelstring or null
Example: "Trending"
display_tagstring or null
Example: "Display tag"
share_linkstring or null
Example: "https://example.com/page-title"
activeboolean
Example: true
metadataobject

A JSON object that can store any custom data structure.

countriesArray of strings
Example: ["US"]
stripped_descriptionstring or null
Example: "Page description"
viewsinteger
Example: 100
leadsinteger
Example: 10
image_urlstring or null
Example: "https://example.com/image.jpg"
sourcestring or null
Example: "builder"
publishboolean
Example: true
promptsArray of objects
html_codestring
prompts_enabledboolean
jsonstring or null
application_theme_templateobject or null
search_engine_optimizerobject or null
use_search_engineboolean
show_on_site_searchboolean
emailstring or null
versionsArray of objects
open_graphobject or null
Response
application/json
{
  "id": 1,
  "title": "Page Title",
  "slug": "page-title",
  "label": "Trending",
  "display_tag": "Display tag",
  "share_link": "https://example.com/page-title",
  "active": true,
  "metadata": {},
  "countries": [
    "US"
  ],
  "stripped_description": "Page description",
  "views": 100,
  "leads": 10,
  "image_url": "https://example.com/image.jpg",
  "source": "builder",
  "publish": true,
  "prompts": [
    { … }
  ],
  "html_code": "string",
  "prompts_enabled": true,
  "json": "string",
  "application_theme_template": {},
  "search_engine_optimizer": {
    "id": 0,
    "title": "string",
    "description": "string",
    "image_url": "string"
  },
  "use_search_engine": true,
  "show_on_site_search": true,
  "email": "string",
  "versions": [
    { … }
  ],
  "open_graph": {
    "id": 0,
    "title": "string",
    "description": "string",
    "image_url": "string"
  }
}

Update a company page

Request

Update the details of a specific company page.

Path
idintegerrequired

Page's Id

Bodyapplication/json
pageobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/pages/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": {
      "title": "Updated Title",
      "html_code": "<p>Updated content</p>",
      "publish": true,
      "metadata": {}
    }
  }'

Responses

page updated

Bodyapplication/json
idinteger
Example: 1
titlestring
Example: "Page Title"
slugstring
Example: "page-title"
labelstring or null
Example: "Trending"
display_tagstring or null
Example: "Display tag"
share_linkstring or null
Example: "https://example.com/page-title"
activeboolean
Example: true
metadataobject

A JSON object that can store any custom data structure.

countriesArray of strings
Example: ["US"]
stripped_descriptionstring or null
Example: "Page description"
viewsinteger
Example: 100
leadsinteger
Example: 10
image_urlstring or null
Example: "https://example.com/image.jpg"
sourcestring or null
Example: "builder"
publishboolean
Example: true
promptsArray of objects
html_codestring
prompts_enabledboolean
jsonstring or null
application_theme_templateobject or null
search_engine_optimizerobject or null
use_search_engineboolean
show_on_site_searchboolean
emailstring or null
versionsArray of objects
open_graphobject or null
Response
application/json
{
  "id": 1,
  "title": "Page Title",
  "slug": "page-title",
  "label": "Trending",
  "display_tag": "Display tag",
  "share_link": "https://example.com/page-title",
  "active": true,
  "metadata": {},
  "countries": [
    "US"
  ],
  "stripped_description": "Page description",
  "views": 100,
  "leads": 10,
  "image_url": "https://example.com/image.jpg",
  "source": "builder",
  "publish": true,
  "prompts": [
    { … }
  ],
  "html_code": "string",
  "prompts_enabled": true,
  "json": "string",
  "application_theme_template": {},
  "search_engine_optimizer": {
    "id": 0,
    "title": "string",
    "description": "string",
    "image_url": "string"
  },
  "use_search_engine": true,
  "show_on_site_search": true,
  "email": "string",
  "versions": [
    { … }
  ],
  "open_graph": {
    "id": 0,
    "title": "string",
    "description": "string",
    "image_url": "string"
  }
}

Delete a company page

Request

Delete a specific page for the current company.

Path
idintegerrequired

Page's Id

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

Responses

page deleted

Send a page to the top

Request

Mark a specific company page as prioritized and send it to the top of the list.

Path
idintegerrequired

Page's Id

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

Responses

page sent to top

Duplicate a page

Request

Create a duplicate of an existing company page.

Path
idintegerrequired

Page's Id

Query
langstring

Language code for the duplicated page

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

Responses

page duplicated

Append metadata field

Request

Path
idintegerrequired

Page's Id

Bodyapplication/json
metadataobjectrequired

A JSON object that can store any custom data structure. When provided, merges with existing metadata data.

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/pages/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {}
  }'

Responses

success

Bodyapplication/json
statusstring
dataobject
Response
application/json
{
  "status": "string",
  "data": {
    "page": { … }
  }
}

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{
  "droplet_categories": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}