Get Brand List Per Page

v1.0.0

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

Response body example

json

{
  "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
    }
}

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."
        }
      }
    }
  }
}