company

Create a Product

Token-authenticated; requires storefront.update (or legacy products.update during the migration).

The write keeps the ActiveRecord accepts_nested_attributes_for key names so the existing Retail::ProductManager / VariantManager orchestration consumes the payload unchanged. A variant MUST be priced in at least one country on create (variant_countries_attributes required). Dynamic bundle-group writes are NOT accepted; static product_bundles_attributes are.

Triggers fresh Lighthouse + compliance scans automatically — a subsequent GET :id/lighthouse / :id/compliance returns scan_status: pending while the queued scans run.

POST

api

v202604

company

products

curl --request POST \
  --url https://api.fluid.app/api/v202604/company/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": {
    "title": "Schrute Farms Beet Blend",
    "variants_attributes": [
      {
        "is_master": true,
        "title": "12 oz",
        "variant_countries_attributes": [
          {
            "active": true,
            "country_id": 233,
            "price": "29.99"
          }
        ]
      }
    ]
  }
}
'

{
  "status": 201,
  "meta": {
    "request_id": "7f3c2a90-1c2b-4d5e-9aaa-112233445566",
    "timestamp": "2026-07-15T12:34:56Z"
  },
  "product": {
    "id": 60311,
    "slug": "scrute-farms-beet-blend",
    "title": "Schrute Farms Beet Blend",
    "description": "A cold-pressed beet concentrate from the finest acres on Schrute Farms.",
    "image_url": null,
    "canonical_url": "https://acme.fluid.app/home/products/scrute-farms-beet-blend",
    "images": null,
    "active": true,
    "status": "published",
    "publish_at": null,
    "seo": {
      "id": 60315,
      "title": "Schrute Farms Beet Blend — Cold Pressed",
      "description": "Single-origin beet concentrate, pressed within the hour.",
      "image_url": "https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/seo/60311.png",
      "block_crawler": false
    },
    "metafields": [
      {
        "namespace": "custom",
        "key": "harvest_acre",
        "value": "North Forty",
        "value_type": "single_line_text_field",
        "description": null,
        "created_at": "2026-06-23T14:00:00Z",
        "updated_at": "2026-06-23T14:00:00Z",
        "locked": false
      }
    ],
    "languages": [
      "en"
    ],
    "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"
    },
    "variants": [
      {
        "id": 880912,
        "sku": "SCRUTE-BEET-001-12OZ",
        "is_master": true,
        "title": "12 oz",
        "position": 1,
        "allow_subscription": true,
        "variant_countries": {
          "US": {
            "id": 451233,
            "active": true,
            "currency_code": "USD",
            "price": "29.99",
            "compare_price": "39.99",
            "subscription_price": "26.99",
            "cv": "20",
            "qv": "20",
            "points": 100,
            "country_id": 233,
            "country_name": "United States",
            "display_price": "$29.99",
            "buyable": true
          }
        }
      }
    ],
    "subscription_plans": [
      {
        "id": 7741,
        "default": true,
        "active": true,
        "subscription_plan": {
          "id": 4410,
          "name": "Monthly Beet Club",
          "billing_interval": 1,
          "billing_interval_unit": "month",
          "billing_frequency_in_words": "Every month",
          "active": true,
          "subscription_price": "$26.99",
          "savings_label": "Subscribe & save 10%"
        }
      }
    ],
    "media": [],
    "bundle_groups": [],
    "custom_slug": true
  }
}

{
  "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"

Body

application/json

product

object

required

Company write contract for a Product. Keeps the ActiveRecord accepts_nested_attributes_for key names (*_attributes) so the existing Retail::ProductManager / VariantManager write orchestration consumes the payload unchanged. status is the RAW Product enum key (active/draft/archived) — the canonical published/scheduled split is presentation-only on read. NOTE: dynamic bundle-group writes (product_bundle_groups_attributes) are NOT accepted on this surface; static bundle-component links (product_bundles_attributes) ARE.

Show child attributes

Response

The created Product.

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

product

object

required

Authenticated (company-surface) Product read shape: the public ProductBase plus custom_slug, admin metadata never rendered on the public surface.

Show child attributes

Company Products index

Company Product show

curl --request POST \
  --url https://api.fluid.app/api/v202604/company/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": {
    "title": "Schrute Farms Beet Blend",
    "variants_attributes": [
      {
        "is_master": true,
        "title": "12 oz",
        "variant_countries_attributes": [
          {
            "active": true,
            "country_id": 233,
            "price": "29.99"
          }
        ]
      }
    ]
  }
}
'

{
  "status": 201,
  "meta": {
    "request_id": "7f3c2a90-1c2b-4d5e-9aaa-112233445566",
    "timestamp": "2026-07-15T12:34:56Z"
  },
  "product": {
    "id": 60311,
    "slug": "scrute-farms-beet-blend",
    "title": "Schrute Farms Beet Blend",
    "description": "A cold-pressed beet concentrate from the finest acres on Schrute Farms.",
    "image_url": null,
    "canonical_url": "https://acme.fluid.app/home/products/scrute-farms-beet-blend",
    "images": null,
    "active": true,
    "status": "published",
    "publish_at": null,
    "seo": {
      "id": 60315,
      "title": "Schrute Farms Beet Blend — Cold Pressed",
      "description": "Single-origin beet concentrate, pressed within the hour.",
      "image_url": "https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/seo/60311.png",
      "block_crawler": false
    },
    "metafields": [
      {
        "namespace": "custom",
        "key": "harvest_acre",
        "value": "North Forty",
        "value_type": "single_line_text_field",
        "description": null,
        "created_at": "2026-06-23T14:00:00Z",
        "updated_at": "2026-06-23T14:00:00Z",
        "locked": false
      }
    ],
    "languages": [
      "en"
    ],
    "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"
    },
    "variants": [
      {
        "id": 880912,
        "sku": "SCRUTE-BEET-001-12OZ",
        "is_master": true,
        "title": "12 oz",
        "position": 1,
        "allow_subscription": true,
        "variant_countries": {
          "US": {
            "id": 451233,
            "active": true,
            "currency_code": "USD",
            "price": "29.99",
            "compare_price": "39.99",
            "subscription_price": "26.99",
            "cv": "20",
            "qv": "20",
            "points": 100,
            "country_id": 233,
            "country_name": "United States",
            "display_price": "$29.99",
            "buyable": true
          }
        }
      }
    ],
    "subscription_plans": [
      {
        "id": 7741,
        "default": true,
        "active": true,
        "subscription_plan": {
          "id": 4410,
          "name": "Monthly Beet Club",
          "billing_interval": 1,
          "billing_interval_unit": "month",
          "billing_frequency_in_words": "Every month",
          "active": true,
          "subscription_price": "$26.99",
          "savings_label": "Subscribe & save 10%"
        }
      }
    ],
    "media": [],
    "bundle_groups": [],
    "custom_slug": true
  }
}

{
  "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

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Create a Product

Authorizations

Query Parameters

Body

Response