Skip to content

List catalog product groups

GET
/catalog/product-groups
curl --request GET \
--url 'https://api.fleet.co/platform/v1/catalog/product-groups?delivery_country=FR&category=ACOUSTIC_CHAIR&brand=apple&search=macbook&limit=20&offset=0' \
--header 'Authorization: Bearer <token>'
delivery_country
required

ISO 3166-1 alpha-2 delivery country code (e.g. FR). Cart line items must use a country where the catalog product is available.

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 by catalog brand key (lowercase slug). Any brand is accepted; common 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.

string
>= 1 characters

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

Example

0

Product groups with optional filters and limit/offset pagination

Media typeapplication/json
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 items matching filters (before paging)

integer
limit
required

Page size used for this response

integer
offset
required

Offset used for this response

integer

Example

{
"meta": {
"total": 42,
"limit": 50,
"offset": 0
}
}

Validation error

Media typeapplication/json
object
message
required

Every validation failure, comma-separated

string
type
required
string
Allowed values: validation_error
error
required
string
Allowed values: validation_error

Example

{
"message": "Required, must be an ISO 3166-1 alpha-2 country code",
"type": "validation_error",
"error": "validation_error"
}

Missing, invalid, or revoked API key

Media typetext/plain
string

Example

Unauthorized

Resource not found

Media typeapplication/json
object
error
required
string
Allowed values: COMPANY_NOT_FOUND COUNTRY_NOT_FOUND DELIVERY_COUNTRY_NOT_FOUND

Example

{
"error": "COMPANY_NOT_FOUND"
}

Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.

Media typetext/plain
string

Example

Too many requests, please try again later.

Unexpected server error

Media typeapplication/json
object
error
required
string
Allowed values: INTERNAL_ERROR

Example

{
"error": "INTERNAL_ERROR"
}

Rate limiting is temporarily unavailable; retry with backoff

Media typeapplication/json
object
message
required
string

Example generated

{
"message": "example"
}