Retrieve Brand
Retrieves detailed information about a specific brand by its unique ID.
HTTP Request
GET/api/products/brands/:id
Authorization
Authorization
- Required: Yes
- Permission: Staff with BrandPermission or Admin
- Permission Code: 1812
- Authentication: Token-based (Authorization: Token <your_api_key>)
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | Unique ID of the brand to retrieve |
Example Requests
- 🐍 Python
- 🌐 Curl
1import requests
2
3# Retrieve a specific brand
4response = requests.get('http://www.example.com/api/products/brands/123',
5 headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())1# Retrieve a specific brand
2curl "http://www.example.com/api/products/brands/123" \
3-H "Authorization: Token <your_api_key>"Response Fields
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the brand |
| image_data | Object | Brand image details |
| order | Integer | Display order for brand sorting (nullable) |
| name | String | Brand name (unique) |
| slug | String | URL-friendly version of the brand name(unique, nullable) |
| description | String | Brand description (max 500 characters, nullable) |
| products_count | Integer | Number of products associated with brand |
| created_at | String (ISO 8601) | Timestamp when brand was created |
| updated_at | String (ISO 8601) | Timestamp when brand was last updated |
Image Data Structure
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the image |
| type | String | File type (e.g., image/jpeg) |
| name | String | Original file name |
| size | Integer | File size in bytes |
| human_readable_size | String | Human readable file size (e.g., 2.5 MB) |
| f | String | URL to access the image file |
| width | Integer | Image width in pixels |
| height | Integer | Image height in pixels |
| mode | String | Color mode (e.g., RGB, CMYK) |
| thumbnails | List of thumbnail objects | Imgae thumbnails |
Thumbnail Data Structure
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the thumbnail (unique) |
| f | String | URL to access the thumbnail file |
| size | Integer | File size in bytes (nullable) |
Example Response
{
"id": 2,
"image_data": {
"id": 3,
"type": "image",
"name": "logitech-mx-2",
"size": 3166,
"human_readable_size": "3.09 KB",
"f": "http://127.0.0.1:8000/media/core_media/2025/11/22/logitech-mx-2.jpg",
"width": 275,
"height": 183,
"mode": "RGB",
"thumbnails": [
{
"id": 213,
"f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_64x64.jpg",
"size": 64
},
{
"id": 214,
"f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_128x128.jpg",
"size": 128
},
{
"id": 215,
"f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_512x512.jpg",
"size": 512
},
{
"id": 216,
"f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_1080x1080.jpg",
"size": 1080
}
]
},
"order": 1,
"name": "Homenick Inc",
"slug": "a-modern-brand",
"description": "logistical",
"products_count": 0,
"created_at": "2025-12-24T13:12:19.836399Z",
"updated_at": "2025-12-24T13:12:19.836407Z"
}