Skip to content
Fleet Fleet Platform API

List catalog product groups

GET
/catalog/product-groups

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
delivery_country
required

ISO 3166-1 alpha-2 delivery country code (e.g. FR). Filters catalog by available_countries; cart line items must use a country allowed for the catalog product.

string
Example
FR
category

Optional filter: product group category code (exact match). Use one of the documented enum values, for example COMPUTER or SCREEN.

string
Allowed values: ACOUSTIC_CHAIR ACOUSTIC_PARTITION ADAPTER ARMCHAIR CASE CHAIR CHARGER COMPUTER DESK HEADPHONES KEYBOARD LAMP MOUSE OTHER PHONEBOOTH PRINTER SCREEN SHELVING_UNIT SMARTPHONE SOFA SPEAKERS STORAGE_CABINET TABLE TABLET
Example
COMPUTER
brand

Optional filter: catalog brand key (slug, usually lowercase). The enum lists common values; other brands may exist and are accepted at runtime.

string
>= 1 characters
Allowed values: acer acer-chromebook amazon apple asus bose corsair dell google hp huawei hyperx jabra lenovo lg logitech meta microsoft nothing oneplus poly razer samsung sonos sony steelseries ubiquiti wacom xiaomi yealink
Example
apple
search

Optional case-insensitive search on product group name and brand

string
>= 1 characters
Example
macbook
limit

Maximum number of product groups returned per page

integer
default: 20 >= 1 <= 100
Example
20
offset

Number of items to skip

integer
0 nullable
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Product groups with optional filters and limit/offset pagination

object
data
required
Array<object>
object
id
required
integer
name
required
string
nullable
img_url
required
string
nullable
slug
required
string
nullable
category
required
string
nullable
brand
required
string
nullable
meta
required
object
total
required

Total rows matching filters (before paging)

integer
Example
42
limit
required

Requested page size after validation

integer
Example
50
offset
required

Requested offset after validation

integer
0

400

Section titled “400 ”

Validation error

object
error
required
string

404

Section titled “404 ”

Resource not found

object
error
required
string
Allowed values: COMPANY_NOT_FOUND COUNTRY_NOT_FOUND DELIVERY_COUNTRY_NOT_FOUND