action vtex_brand_list_per_page {
  label: "Get Brand List Per Page"
  description: "Retrieves all Brands registered in the store's Catalog by page number.
\n## Response body example
\n
\n```json
\n{
\n  \"items\": [
\n    {
\n      \"id\": 2000000,
\n      \"name\": \"Farm\",
\n      \"isActive\": true,
\n      \"title\": \"Farm\",
\n      \"metaTagDescription\": \"Farm\",
\n      \"imageUrl\": null
\n    },
\n    {
\n      \"id\": 2000001,
\n      \"name\": \"Adidas\",
\n      \"isActive\": true,
\n      \"title\": \"\",
\n      \"metaTagDescription\": \"\",
\n      \"imageUrl\": null
\n    },
\n    {
\n      \"id\": 2000002,
\n      \"name\": \"Brastemp\",
\n      \"isActive\": true,
\n      \"title\": \"Brastemp\",
\n      \"metaTagDescription\": \"Brastemp\",
\n      \"imageUrl\": null
\n    }
\n  ],
\n    \"paging\": {
\n      \"page\": 1,
\n        \"perPage\": 3,
\n          \"total\": 6,
\n            \"pages\": 2
\n    }
\n}
\n```"
  provider: vtex
  method: GET
  path: "/api/catalog_system/pvt/brand/pagedlist"
  encoding: json
  input: {
    type: "object"
    properties: {
      Accept: {
        type: "string"
      }
      "Content-Type": {
        type: "string"
      }
      page: {
        type: "integer"
      }
      pageSize: {
        type: "integer"
      }
    }
    required: ["Accept", "Content-Type", "page", "pageSize"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["items", "paging"]
    properties: {
      items: {
        type: "array"
        description: "Array of objects with information of the store's brands."
        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."
            }
          }
        }
      }
      paging: {
        type: "object"
        description: "Object with pagination information."
        required: ["page", "pages", "perPage", "total"]
        properties: {
          page: {
            type: "integer"
            description: "Page number of the brand list."
          }
          pages: {
            type: "integer"
            description: "Total number of pages."
          }
          perPage: {
            type: "integer"
            description: "Quantity of brands per page."
          }
          total: {
            type: "integer"
            description: "Total of brands in the store."
          }
        }
      }
    }
  }
}