Brand

Brands represent the commercial brands that can be associated with products in the TrackVision system.

The brand Object

Brands store information about commercial brand identities including names, sub-brands, and visual assets.

Field Name	Type	Description
id	uuid	Primary key for the brand.
user_created	object	User who created the brand. Read-only. Links to directus_users.
date_created	datetime	Timestamp in ISO 8601 when the brand was created. Read-only.
user_updated	object	User who last updated the brand. Read-only. Links to directus_users.
date_updated	datetime	Timestamp in ISO 8601 when the brand was last updated. Read-only.
brand_name	string	The primary commercial name of the brand.
sub_brand_name	string	Secondary or sub-brand name for brand variants or extensions.
account	object	Account associated with this brand. (Multi-tenant installations only)
primary_image	object	Primary image file for the brand (logo, trademark, etc.). Links to directus_files.
translations	array of objects	Translations for multi-lingual brand content.

---

Sub-Objects

User Object (user_created, user_updated)

See Users for the full schema.

Account Object (account)

See Account for the full schema.

File Object (primary_image)

See Files for the full schema.

Brand Translation Object (translations)

Field	Type	Description
id	integer	Unique identifier of the translation record.
languages_code	string	Language code for this translation (e.g., "en-US").
brand_name	string	Translated brand name.
sub_brand_name	string	Translated sub-brand name.
brand_content	string	Translated brand content/description.

---

List Brands

List existing brands.

REST

GET /items/brand

GraphQL

query {
  brand {
    id
    brand_name
    sub_brand_name
    account {
      id
      name
    }
    primary_image {
      id
      filename_download
    }
  }
}

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit brand objects. If no items are available, data will be an empty array.

---

Retrieve a Brand

Retrieve a specific brand by ID.

REST

GET /items/brand/:id

GraphQL

query {
  brand_by_id(id: "brand_id") {
    id
    brand_name
    sub_brand_name
    account {
      id
      name
    }
    primary_image {
      id
      filename_download
    }
    user_created {
      id
      first_name
      last_name
    }
    date_created
    user_updated {
      id
      first_name
      last_name
    }
    date_updated
  }
}

Returns

Returns a brand object if a valid primary key was provided.

---

Create a Brand

Create a new brand.

REST

POST /items/brand

{
  "brand_name": "TrackVision Premium",
  "sub_brand_name": "Eco-Friendly Line"
}

GraphQL

mutation {
  create_brand_item(data: {
    brand_name: "TrackVision Premium"
    sub_brand_name: "Eco-Friendly Line"
  }) {
    id
    brand_name
    sub_brand_name
  }
}

Query Parameters

Supports all global query parameters.

Request Body

A partial brand object.

Returns

Returns the brand object for the created brand.

---

Update a Brand

Update an existing brand.

REST

PATCH /items/brand/:id

{
  "brand_name": "TrackVision Premium - Updated",
  "sub_brand_name": "Sustainable Products"
}

GraphQL

mutation {
  update_brand_item(id: "brand_id", data: {
    brand_name: "TrackVision Premium - Updated"
    sub_brand_name: "Sustainable Products"
  }) {
    id
    brand_name
    sub_brand_name
  }
}

Query Parameters

Supports all global query parameters.

Request Body

A partial brand object.

Returns

Returns the brand object for the updated brand.

---

Delete a Brand

Delete an existing brand.

REST

DELETE /items/brand/:id

GraphQL

mutation {
  delete_brand_item(id: "brand_id") {
    id
  }
}

Returns

Empty body.