FleetbaseFleetbase

Products

Products are the items and services customers can browse and add to carts. Use product endpoints to list, retrieve, create, or update catalog items with pricing, media, variants, addons, and availability.

The Product object

A product is an item or service sold through a storefront, including pricing, availability, media, variants, addons, and tags.
Attributes
idstringoptional

Public identifier of the product.

namestringoptional

Product name.

descriptionstringoptional

Product description.

skustringoptional

Stock keeping unit.

primary_image_urlstringoptional

Primary product image URL.

priceintegeroptional

Product price.

sale_priceintegeroptional

Sale price when the product is on sale.

currencycurrencyoptional

Product currency code.

is_availablebooleanoptional

Whether the product is available for purchase.

tagsarray of stringsoptional

Product tags.

statusstringoptional

Product status.

metaobjectoptional

Arbitrary metadata stored with the product.

addon_categoriesarray of objectsoptional

Addon categories available for the product.

variantsarray of objectsoptional

Product variants and options.

imagesarray of stringsoptional

Product image URLs.

videosarray of stringsoptional

Product video URLs.

hoursarray of objectsoptional

Product availability hours.

created_attimestampoptional

Time the product was created.

updated_attimestampoptional

Time the product was last updated.

The Product object
{
  "id": "product_9Lb2mQ1",
  "name": "Cold Brew",
  "description": "Bottled cold brew coffee.",
  "sku": "CB-12",
  "primary_image_url": "https://files.example.com/cold-brew.png",
  "price": 450,
  "sale_price": null,
  "currency": "USD",
  "is_on_sale": false,
  "is_recommended": true,
  "is_service": false,
  "is_bookable": false,
  "is_available": true,
  "tags": [
    "coffee"
  ],
  "status": "active",
  "meta": {},
  "slug": "cold-brew",
  "translations": [],
  "addon_categories": [],
  "variants": [],
  "images": [],
  "videos": [],
  "hours": [],
  "youtube_urls": [],
  "created_at": "2026-05-07T09:30:00Z",
  "updated_at": "2026-05-07T09:30:00Z"
}
GET/v1/products

Query Products

Returns published, available products for the authenticated store or network. With a network key, products are restricted to active network members and can be scoped to a member store or one of that store's categories.

Query parameters
querystringoptional

Search published products available through the current store or network.

storestringoptional

Network member store public ID. Ignored for store-scoped keys.

categorystringoptional

Product category public ID belonging to the selected store scope.

with_storebooleanoptional

Include the product's hydrated member store and media.

limitintegeroptional

Maximum number of products to return.

offsetintegeroptional

Number of matching products to skip.

GET/v1/products
curl https://api.fleetbase.io/v1/products?query=&store=&category=&with_store=true&limit=&offset= \
  -H "Authorization: Bearer flb_live_…"
POST/v1/products

Create Product

Create Product

Body parameters
namestringrequired

Display name for the resource.

descriptionstringoptional

Human-readable description of the resource.

priceintegeroptional

Price for the item or entity.

POST/v1/products
curl -X POST https://api.fleetbase.io/v1/products \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Product",
  "description": "Example storefront product",
  "price": 1000
}'
GET/v1/products

Retrieve a Product

Retrieves a single storefront product by ID. The response includes product details, pricing, variants, and related catalog data when available.

GET/v1/products
curl https://api.fleetbase.io/v1/products \
  -H "Authorization: Bearer flb_live_…"
PUT/v1/products

Update Product

Update Product

Body parameters
namestringoptional

Display name for the resource.

descriptionstringoptional

Human-readable description of the resource.

priceintegeroptional

Price for the item or entity.

PUT/v1/products
curl -X PUT https://api.fleetbase.io/v1/products \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Product",
  "description": "Updated storefront product",
  "price": 1000
}'
Products | Fleetbase