get https://{accountName}.{environment}.com.br/api/catalog_system/pvt/brand/pagedlist
Retrieves all Brands registered in the store's Catalog by page number.
Response body has the following properties:
Attribute | Type | Description |
---|---|---|
items | array of objects | Array of objects with information of the store's brands. |
id | integer | Brand unique number identifier. |
name | string | Brand name. |
imageUrl | string | Brand image URL. |
isActive | boolean | Condition if the brand is active or not. |
title | string | Title shown in the browser bar, which corresponds to the title of your page. |
metaTagDescription | string | 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. |
paging | object | Object with information about the paging. |
page | integer | Page number of the brand list. |
perPage | integer | Quantity of brands per page. |
total | integer | Total of brands in the store. |
pages | integer | Total 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
}
}