GET categories

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CategoryEx

Name	Type	Additional information
id	integer	None.
name	string	None.
localized_names	Collection of CategoryLocalLizedNamesEX	None.
description	string	None.
category_template_id	integer	None.
meta_keywords	string	None.
meta_title	string	None.
parent_category_id	string	None.
page_size	string	None.
page_size_options	string	None.
price_ranges	string	None.
show_on_home_page	string	None.
include_in_top_menu	string	None.
has_discounts_applied	string	None.
published	boolean	None.
display_order	integer	None.
created_on_utc	string	None.
updated_on_utc	string	None.
role_ids	Collection of CategoryRoleIdEx	None.
store_ids	Collection of integer	None.
image	CategoryImageEx	None.
se_name	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "localized_names": [
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      },
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      }
    ],
    "description": "sample string 3",
    "category_template_id": 4,
    "meta_keywords": "sample string 5",
    "meta_title": "sample string 6",
    "parent_category_id": "sample string 7",
    "page_size": "sample string 8",
    "page_size_options": "sample string 9",
    "price_ranges": "sample string 10",
    "show_on_home_page": "sample string 11",
    "include_in_top_menu": "sample string 12",
    "has_discounts_applied": "sample string 13",
    "published": true,
    "display_order": 15,
    "created_on_utc": "sample string 16",
    "updated_on_utc": "sample string 17",
    "role_ids": [
      {
        "Id": 1
      },
      {
        "Id": 1
      }
    ],
    "store_ids": [
      1,
      2
    ],
    "image": {
      "src": "sample string 1",
      "se_name": "sample string 2",
      "attachment": "sample string 3"
    },
    "se_name": "sample string 18"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "localized_names": [
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      },
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      }
    ],
    "description": "sample string 3",
    "category_template_id": 4,
    "meta_keywords": "sample string 5",
    "meta_title": "sample string 6",
    "parent_category_id": "sample string 7",
    "page_size": "sample string 8",
    "page_size_options": "sample string 9",
    "price_ranges": "sample string 10",
    "show_on_home_page": "sample string 11",
    "include_in_top_menu": "sample string 12",
    "has_discounts_applied": "sample string 13",
    "published": true,
    "display_order": 15,
    "created_on_utc": "sample string 16",
    "updated_on_utc": "sample string 17",
    "role_ids": [
      {
        "Id": 1
      },
      {
        "Id": 1
      }
    ],
    "store_ids": [
      1,
      2
    ],
    "image": {
      "src": "sample string 1",
      "se_name": "sample string 2",
      "attachment": "sample string 3"
    },
    "se_name": "sample string 18"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCategoryEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EliteWeb.NopCommerce.Common">
  <CategoryEx>
    <category_template_id>4</category_template_id>
    <created_on_utc>sample string 16</created_on_utc>
    <description>sample string 3</description>
    <display_order>15</display_order>
    <has_discounts_applied>sample string 13</has_discounts_applied>
    <id>1</id>
    <image>
      <attachment>sample string 3</attachment>
      <se_name>sample string 2</se_name>
      <src>sample string 1</src>
    </image>
    <include_in_top_menu>sample string 12</include_in_top_menu>
    <localized_names>
      <CategoryLocalLizedNamesEX>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </CategoryLocalLizedNamesEX>
      <CategoryLocalLizedNamesEX>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </CategoryLocalLizedNamesEX>
    </localized_names>
    <meta_keywords>sample string 5</meta_keywords>
    <meta_title>sample string 6</meta_title>
    <name>sample string 2</name>
    <page_size>sample string 8</page_size>
    <page_size_options>sample string 9</page_size_options>
    <parent_category_id>sample string 7</parent_category_id>
    <price_ranges>sample string 10</price_ranges>
    <published>true</published>
    <role_ids>
      <CategoryRoleIdEx>
        <Id>1</Id>
      </CategoryRoleIdEx>
      <CategoryRoleIdEx>
        <Id>1</Id>
      </CategoryRoleIdEx>
    </role_ids>
    <se_name>sample string 18</se_name>
    <show_on_home_page>sample string 11</show_on_home_page>
    <store_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </store_ids>
    <updated_on_utc>sample string 17</updated_on_utc>
  </CategoryEx>
  <CategoryEx>
    <category_template_id>4</category_template_id>
    <created_on_utc>sample string 16</created_on_utc>
    <description>sample string 3</description>
    <display_order>15</display_order>
    <has_discounts_applied>sample string 13</has_discounts_applied>
    <id>1</id>
    <image>
      <attachment>sample string 3</attachment>
      <se_name>sample string 2</se_name>
      <src>sample string 1</src>
    </image>
    <include_in_top_menu>sample string 12</include_in_top_menu>
    <localized_names>
      <CategoryLocalLizedNamesEX>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </CategoryLocalLizedNamesEX>
      <CategoryLocalLizedNamesEX>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </CategoryLocalLizedNamesEX>
    </localized_names>
    <meta_keywords>sample string 5</meta_keywords>
    <meta_title>sample string 6</meta_title>
    <name>sample string 2</name>
    <page_size>sample string 8</page_size>
    <page_size_options>sample string 9</page_size_options>
    <parent_category_id>sample string 7</parent_category_id>
    <price_ranges>sample string 10</price_ranges>
    <published>true</published>
    <role_ids>
      <CategoryRoleIdEx>
        <Id>1</Id>
      </CategoryRoleIdEx>
      <CategoryRoleIdEx>
        <Id>1</Id>
      </CategoryRoleIdEx>
    </role_ids>
    <se_name>sample string 18</se_name>
    <show_on_home_page>sample string 11</show_on_home_page>
    <store_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </store_ids>
    <updated_on_utc>sample string 17</updated_on_utc>
  </CategoryEx>
</ArrayOfCategoryEx>