Skip to main content

Brand Management

5 API calls in this section.

List Brands​

Storefront & Commerce / Brand Management
GET/storefront/brands

List brands for the tenant's market with pagination, AdvancedDataGrid sorting/filtering, per-brand products_count, and market-wide stats.

Query parameters

ParameterTypeDescription
pagestring

Page number (default: 1)

Example: 1

limitstring

Items per page (default: 20)

Example: 20

is_activeOptionalstring

Filter by active state (optional)

Example: true

searchOptionalstring

Search by name/description (optional)

sort_bystring

Sort by one of: name, slug, is_active, products_count, created_at

Example: products_count

sort_orderstring

Sort order: asc or desc

Example: desc

column_filtersstring

JSON-encoded column filters for AdvancedDataGrid. Supported keys: name, is_active, created_at

Example: {"name":"adi","is_active":"true","created_at":"2025-01-01..2025-12-31"}

Headers

ParameterTypeDescription
Authorizationstring

Example: Bearer {{access_token}}

Staging
Request
curl
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/storefront/brands?page=1&limit=20&is_active=true&search=&sort_by=products_count&sort_order=desc&column_filters=%7B%22name%22%3A%22adi%22%2C%22is_active%22%3A%22true%22%2C%22created_at%22%3A%222025-01-01..2025-12-31%22%7D" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

200Success Response
Response body
json
1{2  "success": true,3  "brands": [4    {5      "id": "24b931dc-0000-0000-0000-000000000001",6      "market_id": "market-uuid",7      "name": {8        "en": "adidas"9      },10      "slug": "adidas",11      "description": {},12      "logo_url": "https://example.com/logo.png",13      "is_active": true,14      "products_count": 452,15      "created_at": "2026-04-01T10:00:00Z",16      "updated_at": "2026-04-05T10:00:00Z"17    }18  ],19  "pagination": {20    "page": 1,21    "limit": 20,22    "total": 1284,23    "totalPages": 6524  },25  "stats": {26    "totalBrands": 1284,27    "activeBrands": 1202,28    "topBrand": {29      "name": "Lumina Global",30      "productsCount": 45231    },32    "recentlyAdded": [33      {34        "name": "BrandA",35        "logo_url": "https://example.com/a.png"36      },37      {38        "name": "BrandB",39        "logo_url": "https://example.com/b.png"40      },41      {42        "name": "BrandC",43        "logo_url": "https://example.com/c.png"44      }45    ]46  }47}

Create Brand​

Storefront & Commerce / Brand Management
POST/storefront/brands

Create a new brand in the tenant's market. Required: name (multilingual), slug.

Headers

ParameterTypeDescription
Authorizationstring

Example: Bearer {{access_token}}

Content-Typestring

Example: application/json

Body parameters

ParameterTypeDescription
nameobject—
name.enstring—
slugstring—
descriptionobject—
logo_urlstring—
is_activeboolean—
Staging
Request
curl
1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/storefront/brands" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "name": {6    "en": ""7  },8  "slug": "",9  "description": {},10  "logo_url": "",11  "is_active": true12}'

Response examples

No saved response example. Use Try it to inspect a staging response.

Get Brand​

Storefront & Commerce / Brand Management
GET/storefront/brands/:brand_id

Fetch a brand by ID.

Path parameters

ParameterTypeDescription
brand_idRequiredstring

Example: brand-uuid

Headers

ParameterTypeDescription
Authorizationstring

Example: Bearer {{access_token}}

Staging
Request
curl
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/storefront/brands/${BRAND_ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Update Brand​

Storefront & Commerce / Brand Management
PUT/storefront/brands/:brand_id

Update brand fields (all optional).

Path parameters

ParameterTypeDescription
brand_idRequiredstring

Example: brand-uuid

Headers

ParameterTypeDescription
Authorizationstring

Example: Bearer {{access_token}}

Content-Typestring

Example: application/json

Body parameters

ParameterTypeDescription
nameobject—
name.enstring—
slugstring—
descriptionobject—
logo_urlstring—
is_activeboolean—
Staging
Request
curl
1curl --globoff --request PUT "https://staging-api.ondi.io/functions/v1/storefront/brands/${BRAND_ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "name": {6    "en": ""7  },8  "slug": "",9  "description": {},10  "logo_url": "",11  "is_active": true12}'

Response examples

No saved response example. Use Try it to inspect a staging response.

Delete Brand​

Storefront & Commerce / Brand Management
DELETE/storefront/brands/:brand_id

Delete a brand by ID.

Path parameters

ParameterTypeDescription
brand_idRequiredstring

Example: brand-uuid

Headers

ParameterTypeDescription
Authorizationstring

Example: Bearer {{access_token}}

Staging
Request
curl
1curl --globoff --request DELETE "https://staging-api.ondi.io/functions/v1/storefront/brands/${BRAND_ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.