Get Brand List Per Page

Retrieves all Brands registered in the store's Catalog by page number.

Response body example

{
  "items": [
    {
      "id": 2000000,
      "name": "Farm",
      "isActive": true,
      "title": "Farm",
      "metaTagDescription": "Farm",
      "imageUrl": null
    },
    {
      "id": 2000001,
      "name": "Adidas",
      "isActive": true,
      "title": "",
      "metaTagDescription": "",
      "imageUrl": null
    },
    {
      "id": 2000002,
      "name": "Brastemp",
      "isActive": true,
      "title": "Brastemp",
      "metaTagDescription": "Brastemp",
      "imageUrl": null
    }
  ],
    "paging": {
      "page": 1,
        "perPage": 3,
          "total": 6,
            "pages": 2
    }
}

Response body has the following properties:

AttributeTypeDescription
itemsarray of objectsArray of objects with information of the store's brands.
idintegerBrand unique number identifier.
namestringBrand name.
imageUrlstringBrand image URL.
isActivebooleanCondition if the brand is active or not.
titlestringTitle shown in the browser bar, which corresponds to the title of your page.
metaTagDescriptionstringA 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.
pagingobjectObject with information about the paging.
pageintegerPage number of the brand list.
perPageintegerQuantity of brands per page.
totalintegerTotal of brands in the store.
pagesintegerTotal number of pages.

Response body example:

{
  "items": [
    {
      "id": 2000000,
      "name": "Farm",
      "isActive": true,
      "title": "Farm",
      "metaTagDescription": "Farm",
      "imageUrl": null
    },
    {
      "id": 2000001,
      "name": "Adidas",
      "isActive": true,
      "title": "",
      "metaTagDescription": "",
      "imageUrl": null
    },
    {
      "id": 2000002,
      "name": "Brastemp",
      "isActive": true,
      "title": "Brastemp",
      "metaTagDescription": "Brastemp",
      "imageUrl": null
    }
  ],
    "paging": {
      "page": 1,
        "perPage": 3,
          "total": 6,
            "pages": 2
    }
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!