company

Company Products index

Token-authenticated. Returns EVERY Product for the calling company regardless of lifecycle (draft / archived rows included), so admins can manage non-public rows.

Supports the same cursor pagination / filter / sort / q contract as the public catalog. filter[status] (the raw Product enum keys active/draft/archived) is only meaningful on this surface.

Product price is COUNTRY-RELATIVE — the country parameter selects the per-country variant price/currency rendered. country is also a real FILTER: products with no active variant priced in that country are omitted, because there is nothing to sell there.

Unlike the public catalog, this surface REJECTS a country the company has not configured with a 422 rather than falling back to the full catalog priced in the company default. An ISO the company does not sell in has no availability gate to apply, and returning every row with a 200 is indistinguishable from a filter that worked — an admin tool cannot tell the difference. Send only an ISO from the company’s configured countries.

GET

api

v202604

company

products

Company Products index

curl --request GET \
  --url https://api.fluid.app/api/v202604/company/products \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/company/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/company/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/company/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/company/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  },
  "products": [
    {
      "id": 60311,
      "slug": "scrute-farms-beet-blend",
      "title": "Schrute Farms Beet Blend",
      "canonical_url": "https://acme.fluid.app/home/products/scrute-farms-beet-blend",
      "images": {
        "thumb": {
          "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
          "width": 600
        },
        "medium": {
          "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
          "width": 600
        },
        "large": {
          "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
          "width": 600
        }
      },
      "active": true,
      "status": "published",
      "publish_at": null,
      "metafields": [
        {
          "namespace": "custom",
          "key": "material",
          "value": "<unknown>",
          "value_type": "single_line_text_field",
          "description": "The primary material used in this product",
          "created_at": "2026-05-01T12:00:00Z",
          "updated_at": "2026-05-01T12:00:00Z",
          "locked": false
        }
      ],
      "languages": [
        "en",
        "fr"
      ],
      "sku": "SCRUTE-BEET-001",
      "is_bundle": false,
      "in_stock": true,
      "has_subscription_plans": true,
      "pricing": {
        "price": "29.99",
        "currency_code": "USD",
        "compare_at": "39.99",
        "subscription_price": "26.99",
        "display_price": "$29.99"
      },
      "default_variant": {
        "id": 880912,
        "sku": "SCRUTE-BEET-001-12OZ"
      },
      "created_at": "2026-04-01T12:00:00Z",
      "updated_at": "2026-04-08T09:30:00Z"
    }
  ]
}

{
  "message": "Invalid credentials."
}

{
  "error": "Not authorized."
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Accepts company-admin tokens with storefront.view for read operations and storefront.update for writes and scan triggers (legacy per-resource grants like categories.update / products.view / etc. are still accepted during the migration), required on every company operation. Storefront public operations under /api/v202604/{resource} and /api/v202604/{resource}/{slug} are unauthenticated (security: []).

Query Parameters

lang

string

Response locale. ISO code (e.g. fr, de). When omitted, responds in the company's default locale. On the public surface, falls back to en for any translated field missing in the requested locale.

Example:

"fr"

country

string

ISO-2 country code that selects COUNTRY-RELATIVE Product pricing. Product-only — Categories and other storefront resources use filter[country] as an access-list visibility filter instead.

For Products, country drives the pricing block and each variant's variant_countries: it picks which per-country variant price and currency are rendered. On the catalog it also drops products with no active variant in the requested country. When omitted, falls back to the company's default country.

Example:

"GB"

string

Free-text search. Backed by Searchkick / Elasticsearch over translation-aware title and description fields, plus slug. On /products it additionally matches the product-level sku and every variant SKU.

On /products the match is TIERED: the term is matched first against the fields that NAME a product — title in every locale, slug, sku and every variant SKU — and description / metafields answer only when no name match survives the other filters on the request. A bundle's copy lists the products it contains, so matching name and copy in one pass returned every pack that merely mentions a product ahead of the product itself.

Substring-aware (word_middle), so partial terms match. Results are returned in the requested sort order, not by relevance — search resolves to an id set that the ordinary paginated query then filters, and that id set is capped at 1000 matches per request.

page[cursor]

string

Rotulus cursor returned in meta.pagination.next_cursor (or prev_cursor). Omit on the first page.

page[limit]

integer

default:25

Page size. Default 25. Max 100. Requests above 100 return 422.

Required range: 1 <= x <= 100

filter[status]

enum<string>

Raw Product enum key.

Available options:

active,

draft,

archived

filter[availability]

enum<string>

default:all

Stock filter. in_stock restricts to purchasable products; all (default) imposes no stock constraint.

Available options:

all,

in_stock

filter[bundle]

boolean

true returns only bundle products; false returns only non-bundle products.

filter[has_subscription_plans]

boolean

true returns only products that have at least one active subscription plan; false returns only products that have none. Matches the has_subscription_plans field on each product in the response exactly — a product whose only plan link is inactive, or whose only plan has been deactivated, reads false and is returned by false. Omit the parameter to apply no subscription constraint.

filter[category_ids]

integer[]

Restrict to products in any of these category ids.

filter[collection_ids]

integer[]

Restrict to products in any of these collection ids.

sort

enum<string>

Single sort key. Prefix with - for descending. Default priority then id.

Available options:

priority,

-priority,

title,

-title,

created_at,

-created_at,

updated_at,

-updated_at

Response

A page of products.

Shared success envelope for list / show / create / update responses: the resource payload is returned alongside a top-level integer status and meta. Composed onto each resource response via allOf.

status

integer

required

Example:

200

meta

object

required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.

Show child attributes

products

object[]

required

Show child attributes

Company Products index

curl --request GET \
  --url https://api.fluid.app/api/v202604/company/products \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/company/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/company/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/company/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/company/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  },
  "products": [
    {
      "id": 60311,
      "slug": "scrute-farms-beet-blend",
      "title": "Schrute Farms Beet Blend",
      "canonical_url": "https://acme.fluid.app/home/products/scrute-farms-beet-blend",
      "images": {
        "thumb": {
          "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
          "width": 600
        },
        "medium": {
          "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
          "width": 600
        },
        "large": {
          "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
          "width": 600
        }
      },
      "active": true,
      "status": "published",
      "publish_at": null,
      "metafields": [
        {
          "namespace": "custom",
          "key": "material",
          "value": "<unknown>",
          "value_type": "single_line_text_field",
          "description": "The primary material used in this product",
          "created_at": "2026-05-01T12:00:00Z",
          "updated_at": "2026-05-01T12:00:00Z",
          "locked": false
        }
      ],
      "languages": [
        "en",
        "fr"
      ],
      "sku": "SCRUTE-BEET-001",
      "is_bundle": false,
      "in_stock": true,
      "has_subscription_plans": true,
      "pricing": {
        "price": "29.99",
        "currency_code": "USD",
        "compare_at": "39.99",
        "subscription_price": "26.99",
        "display_price": "$29.99"
      },
      "default_variant": {
        "id": 880912,
        "sku": "SCRUTE-BEET-001-12OZ"
      },
      "created_at": "2026-04-01T12:00:00Z",
      "updated_at": "2026-04-08T09:30:00Z"
    }
  ]
}

{
  "message": "Invalid credentials."
}

{
  "error": "Not authorized."
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  }
}

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Member endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Company Products index

Authorizations

Query Parameters

Response