Brands

Brands represent the manufacturers or labels of the products in your store. Each brand belongs to a language and can be associated with multiple products. All brand endpoints are scoped to a language.

The brand model

The brand model contains all the information about a product brand, including its name, content description, and any custom attributes you have defined.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the brand.

  • Name
    product_ids
    Type
    array
    Description

    An array of product IDs associated with this brand.

  • Name
    name
    Type
    string
    Description

    The display name of the brand.

  • Name
    url
    Type
    string
    Description

    The URL of the brand page in your store.

  • Name
    content
    Type
    string
    Description

    A description or content block for the brand.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp of when the brand was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    Timestamp of when the brand was last updated.

  • Name
    custom_attributes
    Type
    array
    Description

    An array of custom attribute objects with name and a value field (string_value, integer_value, date_value, datetime_value, or boolean_value).


GET/v2/languages/:language_id/brands

List all brands

This endpoint allows you to retrieve a paginated list of all brands for a given language. By default, a maximum of ten brands are shown per page, with a maximum of 250 per page.

Optional attributes

  • Name
    page
    Type
    integer
    Description

    Page offset to fetch. Defaults to 1.

  • Name
    per_page
    Type
    integer
    Description

    Number of brands per page. Defaults to 10, maximum 250.

Request

GET
/v2/languages/:language_id/brands
curl -G https://app.reloadify.com/api/v2/languages/en/brands \
  -H "Authorization: Bearer {token}" \
  -d per_page=10 \
  -d page=1

Response

{
  "data": [
    {
      "id": "brand_001",
      "product_ids": ["prod_301", "prod_302", "prod_303"],
      "name": "Samsung",
      "url": "https://example.com/brands/samsung",
      "content": "Leading global technology company specializing in electronics and appliances.",
      "created_at": "2025-03-10T09:00:00Z",
      "updated_at": "2025-08-22T16:45:00Z",
      "custom_attributes": []
    },
    {
      "id": "brand_002",
      "product_ids": ["prod_401", "prod_402"],
      "name": "Nike",
      "url": "https://example.com/brands/nike",
      "content": "World-renowned sportswear and athletic footwear brand.",
      "created_at": "2025-04-15T11:30:00Z",
      "updated_at": "2025-09-01T10:00:00Z",
      "custom_attributes": []
    }
  ]
}

PUT/v2/languages/:language_id/brands

Create or update a brand

This endpoint allows you to create a new brand or update an existing one. If a brand with the given ID already exists, it will be updated with the provided fields.

Required attributes

  • Name
    id
    Type
    string
    Description

    The unique identifier for the brand.

  • Name
    name
    Type
    string
    Description

    The display name of the brand.

Optional attributes

  • Name
    content
    Type
    string
    Description

    A description or content block for the brand.

  • Name
    url
    Type
    string
    Description

    The URL of the brand page in your store.

  • Name
    created_at
    Type
    timestamp
    Description

    The creation timestamp. Defaults to the current time.

  • Name
    updated_at
    Type
    timestamp
    Description

    The last updated timestamp. Defaults to the current time.

  • Name
    custom_attributes
    Type
    array
    Description

    An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

Request

PUT
/v2/languages/:language_id/brands
curl -X PUT https://app.reloadify.com/api/v2/languages/en/brands \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "brand": {
      "id": "brand_003",
      "name": "Nike",
      "content": "World-renowned sportswear and athletic footwear brand.",
      "url": "https://example.com/brands/nike",
      "custom_attributes": [
        {
          "name": "country_of_origin",
          "string_value": "United States"
        }
      ]
    }
  }'

Response

{
  "id": "brand_003",
  "product_ids": [],
  "name": "Nike",
  "url": "https://example.com/brands/nike",
  "content": "World-renowned sportswear and athletic footwear brand.",
  "created_at": "2025-10-01T08:00:00Z",
  "updated_at": "2025-10-01T08:00:00Z",
  "custom_attributes": [
    {
      "name": "country_of_origin",
      "string_value": "United States"
    }
  ]
}

GET/v2/languages/:language_id/brands/:brand_id

Retrieve a brand

This endpoint allows you to retrieve a brand by providing the brand ID. Refer to the model at the top of this page to see which properties are included with brand objects.

Request

GET
/v2/languages/en/brands/brand_001
curl https://app.reloadify.com/api/v2/languages/en/brands/brand_001 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "brand_001",
  "product_ids": ["prod_301", "prod_302", "prod_303"],
  "name": "Samsung",
  "url": "https://example.com/brands/samsung",
  "content": "Leading global technology company specializing in electronics and appliances.",
  "created_at": "2025-03-10T09:00:00Z",
  "updated_at": "2025-08-22T16:45:00Z",
  "custom_attributes": []
}

DELETE/v2/languages/:language_id/brands/:brand_id

Delete a brand

This endpoint allows you to delete a brand. Be careful — this action is irreversible and will remove the brand and its associations.

Request

DELETE
/v2/languages/en/brands/brand_003
curl -X DELETE https://app.reloadify.com/api/v2/languages/en/brands/brand_003 \
  -H "Authorization: Bearer {token}"

GET/v2/languages/:language_id/brands/:brand_id/products

List brand products

This endpoint allows you to retrieve a list of all products that belong to a specific brand.

Request

GET
/v2/languages/en/brands/brand_001/products
curl -G https://app.reloadify.com/api/v2/languages/en/brands/brand_001/products \
  -H "Authorization: Bearer {token}"

Response

{
  "data": [
    {
      "id": "prod_301",
      "name": "Samsung Galaxy S24",
      "url": "https://example.com/products/galaxy-s24"
    },
    {
      "id": "prod_302",
      "name": "Samsung QLED TV 65\"",
      "url": "https://example.com/products/qled-tv-65"
    },
    {
      "id": "prod_303",
      "name": "Samsung Galaxy Buds Pro",
      "url": "https://example.com/products/galaxy-buds-pro"
    }
  ]
}

Was this page helpful?