GET v1/store/categories/{categoryID}/products?pageNumber={pageNumber}&pageSize={pageSize}&calculateMinimumPrice={calculateMinimumPrice}

Gets the online products of a specific product category, using pagination.

Request Information

URI Parameters

Name	Description	Type	Additional information
categoryID	The unique ID of the parent category.	globally unique identifier	Required
pageNumber	The requested page number.	integer	Optional. Default value is 1
pageSize	The number of products on a single page. The maximum is 200.	integer	Optional. Default value is 50
calculateMinimumPrice	Indicates whether to calculate the minimum price.	boolean	Optional. Default value is True

Body Parameters

None.

Response Information

Resource Description

Returns a list of online products according the requested parameters.

ProductListModel

Name	Description	Type	Additional information
Products	The list of the products according to the pagination.	Collection of ProductListItemModel	None.
Count	The total number of products without pagination.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Products": [
    {
      "ID": "b9adfea8-425d-4cbb-9758-47003ca57b5c",
      "FriendlyID": 2,
      "Name": "sample string 3",
      "ShortDescription": "sample string 4",
      "Description": "sample string 5",
      "ExternalID": "sample string 6",
      "CatalogNumber": "sample string 7",
      "HasPricing": true,
      "ImageUrl": "sample string 9",
      "Thumbnails": [
        "sample string 1",
        "sample string 2"
      ],
      "Inventory": {
        "Quantity": 1,
        "AllowOutOfStockPurchase": true
      },
      "Unit": {
        "ItemQuantity": 1,
        "ItemType": {
          "Name": "sample string 1",
          "PluralName": "sample string 2"
        },
        "PackType": {
          "Name": "sample string 1",
          "PluralName": "sample string 2"
        }
      },
      "MinimumQuantity": 10,
      "MinimumPrice": {
        "Price": 1.0,
        "Tax": 2.0
      },
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Type": 1,
      "Configuration": {
        "AllowQuickAddToCart": true,
        "Quantity": {
          "Minimum": 1,
          "Maximum": 1,
          "Changeable": true,
          "Options": [
            {
              "Name": "sample string 1",
              "Value": 2
            },
            {
              "Name": "sample string 1",
              "Value": 2
            }
          ]
        },
        "Properties": [
          {
            "Name": "sample string 1",
            "ID": "2076ec71-d1e5-4788-9bb6-91486469afbf"
          },
          {
            "Name": "sample string 1",
            "ID": "2076ec71-d1e5-4788-9bb6-91486469afbf"
          }
        ]
      }
    },
    {
      "ID": "b9adfea8-425d-4cbb-9758-47003ca57b5c",
      "FriendlyID": 2,
      "Name": "sample string 3",
      "ShortDescription": "sample string 4",
      "Description": "sample string 5",
      "ExternalID": "sample string 6",
      "CatalogNumber": "sample string 7",
      "HasPricing": true,
      "ImageUrl": "sample string 9",
      "Thumbnails": [
        "sample string 1",
        "sample string 2"
      ],
      "Inventory": {
        "Quantity": 1,
        "AllowOutOfStockPurchase": true
      },
      "Unit": {
        "ItemQuantity": 1,
        "ItemType": {
          "Name": "sample string 1",
          "PluralName": "sample string 2"
        },
        "PackType": {
          "Name": "sample string 1",
          "PluralName": "sample string 2"
        }
      },
      "MinimumQuantity": 10,
      "MinimumPrice": {
        "Price": 1.0,
        "Tax": 2.0
      },
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Type": 1,
      "Configuration": {
        "AllowQuickAddToCart": true,
        "Quantity": {
          "Minimum": 1,
          "Maximum": 1,
          "Changeable": true,
          "Options": [
            {
              "Name": "sample string 1",
              "Value": 2
            },
            {
              "Name": "sample string 1",
              "Value": 2
            }
          ]
        },
        "Properties": [
          {
            "Name": "sample string 1",
            "ID": "2076ec71-d1e5-4788-9bb6-91486469afbf"
          },
          {
            "Name": "sample string 1",
            "ID": "2076ec71-d1e5-4788-9bb6-91486469afbf"
          }
        ]
      }
    }
  ],
  "Count": 1
}