Management API
Shopper API
Auth API
Digital Assets Management API
Brands
List all series for a brand
Retrieves all series belonging to the specified brand with optional filtering by name. Validates that the brand exists. Includes series details, logo, cover image, description, and translations for each series.
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
brands
/
:brand_id
/
series
Error
Copy
A valid request URL is required to generate request examplesCopy
{
"data": [
{
"brand": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"cover": {
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"parent_id": "<string>",
"public": true,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
},
"created_at": "<string>",
"description": "<string>",
"id": "<string>",
"logo": {
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"parent_id": "<string>",
"public": true,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
},
"name": "<string>",
"slug": "<string>",
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"details": [
"<string>"
],
"success": true
}Path Parameters
App slug
Team slug
Id of brand
Query Parameters
Name of series used for filtering
Previous
Create a new series under a brandCreates a new series under the specified brand with the provided name, slug, logo, cover image, and description. Validates that the parent brand exists and that the series name and slug are unique.
Next
⌘I
Error
Copy
A valid request URL is required to generate request examplesCopy
{
"data": [
{
"brand": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"cover": {
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"parent_id": "<string>",
"public": true,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
},
"created_at": "<string>",
"description": "<string>",
"id": "<string>",
"logo": {
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"parent_id": "<string>",
"public": true,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
},
"name": "<string>",
"slug": "<string>",
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"details": [
"<string>"
],
"success": true
}