Get Brand List

v1.0.0

Retrieves all Brands registered in the store's Catalog.

⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use the endpoint instead to get a paginated response.

Response body example

json

[
  {
    "id": 9280,
    "name": "Brand",
    "isActive": true,
    "title": "Brand",
    "metaTagDescription": "Brand",
    "imageUrl": null
  },
  {
    "id": 2000000,
    "name": "Orma Carbon",
    "isActive": true,
    "title": "Orma Carbon",
    "metaTagDescription": "Orma Carbon",
    "imageUrl": null
  },
  {
    "id": 2000001,
    "name": "Pedigree",
    "isActive": true,
    "title": "Pedigree",
    "metaTagDescription": "",
    "imageUrl": null
  }
]

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "Content-Type": {
      "type": "string"
    }
  },
  "required": [
    "Accept",
    "Content-Type"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "description": "An array with all brands registered in the store.",
  "items": {
    "type": "object",
    "description": "Object containing Brand information.",
    "required": [
      "id",
      "name",
      "isActive",
      "imageUrl",
      "title",
      "metaTagDescription"
    ],
    "properties": {
      "id": {
        "type": "integer",
        "description": "Brand's unique numerical identifier."
      },
      "imageUrl": {
        "type": "string",
        "description": "URL of the brand's image."
      },
      "isActive": {
        "type": "boolean",
        "description": "Defines if the brand is active (`true`) or not (`false`)."
      },
      "metaTagDescription": {
        "type": "string",
        "description": "Meta Description for the Brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description."
      },
      "name": {
        "type": "string",
        "description": "Brand name."
      },
      "title": {
        "type": "string",
        "description": "Meta Title for the Brand page."
      }
    }
  }
}