Skip to main content

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

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the brand to retrieve

Example Requests

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())

Response Fields

FieldTypeDescription
idIntegerUnique ID of the brand
image_dataObjectBrand image details
orderIntegerDisplay order for brand sorting (nullable)
nameStringBrand name (unique)
slugStringURL-friendly version of the brand name(unique, nullable)
descriptionStringBrand description (max 500 characters, nullable)
products_countIntegerNumber of products associated with brand
created_atString (ISO 8601)Timestamp when brand was created
updated_atString (ISO 8601)Timestamp when brand was last updated

Image Data Structure

FieldTypeDescription
idIntegerUnique ID of the image
typeStringFile type (e.g., image/jpeg)
nameStringOriginal file name
sizeIntegerFile size in bytes
human_readable_sizeStringHuman readable file size (e.g., 2.5 MB)
fStringURL to access the image file
widthIntegerImage width in pixels
heightIntegerImage height in pixels
modeStringColor mode (e.g., RGB, CMYK)
thumbnailsList of thumbnail objectsImgae thumbnails

Thumbnail Data Structure

FieldTypeDescription
idIntegerUnique ID of the thumbnail (unique)
fStringURL to access the thumbnail file
sizeIntegerFile 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"
}