GET api/product/getproductList
Retrieve a list with all active products
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Product list
Collection of ProductSalesModelName | Description | Type | Additional information |
---|---|---|---|
ProductNumber | string |
Required |
|
Name | string |
Required |
|
Brand | string |
Required |
|
ImageURL | string |
Required |
|
DefaultImage | string |
Required |
|
CategoryId | integer |
None. |
|
SubCategory | integer |
None. |
|
CategoryName | string |
None. |
|
FaceValuePrice | decimal number |
Required |
|
PurchasePrice | decimal number |
Required |
|
PurchaseVat | decimal number |
Required |
|
MaxQuantityPerOrder | integer |
None. |
|
ProductType | string |
None. |
|
IsFavouriteForUser | boolean |
None. |
|
Purpose | string |
None. |
|
VatType | string |
None. |
|
FaceValueVatType | string |
None. |
|
FaceValueVat | decimal number |
None. |
|
IsInStock | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ProductNumber": "sample string 1", "Name": "sample string 2", "Brand": "sample string 3", "ImageURL": "sample string 4", "DefaultImage": "sample string 5", "CategoryId": 1, "SubCategory": 1, "CategoryName": "sample string 6", "FaceValuePrice": 7.0, "PurchasePrice": 8.0, "PurchaseVat": 9.0, "MaxQuantityPerOrder": 999, "ProductType": "sample string 10", "IsFavouriteForUser": true, "Purpose": "sample string 12", "VatType": "sample string 13", "FaceValueVatType": "sample string 14", "FaceValueVat": 15.0, "IsInStock": true }, { "ProductNumber": "sample string 1", "Name": "sample string 2", "Brand": "sample string 3", "ImageURL": "sample string 4", "DefaultImage": "sample string 5", "CategoryId": 1, "SubCategory": 1, "CategoryName": "sample string 6", "FaceValuePrice": 7.0, "PurchasePrice": 8.0, "PurchaseVat": 9.0, "MaxQuantityPerOrder": 999, "ProductType": "sample string 10", "IsFavouriteForUser": true, "Purpose": "sample string 12", "VatType": "sample string 13", "FaceValueVatType": "sample string 14", "FaceValueVat": 15.0, "IsInStock": true } ]
application/xml, text/xml
Sample:
<ArrayOfProductSalesModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MaxRetail.DTO.Model"> <ProductSalesModel> <Brand>sample string 3</Brand> <CategoryId>1</CategoryId> <CategoryName>sample string 6</CategoryName> <DefaultImage>sample string 5</DefaultImage> <FaceValuePrice>7</FaceValuePrice> <FaceValueVat>15</FaceValueVat> <FaceValueVatType>sample string 14</FaceValueVatType> <ImageURL>sample string 4</ImageURL> <IsFavouriteForUser>true</IsFavouriteForUser> <IsInStock>true</IsInStock> <Name>sample string 2</Name> <ProductNumber>sample string 1</ProductNumber> <ProductType>sample string 10</ProductType> <PurchasePrice>8</PurchasePrice> <PurchaseVat>9</PurchaseVat> <Purpose>sample string 12</Purpose> <SubCategory>1</SubCategory> <VatType>sample string 13</VatType> </ProductSalesModel> <ProductSalesModel> <Brand>sample string 3</Brand> <CategoryId>1</CategoryId> <CategoryName>sample string 6</CategoryName> <DefaultImage>sample string 5</DefaultImage> <FaceValuePrice>7</FaceValuePrice> <FaceValueVat>15</FaceValueVat> <FaceValueVatType>sample string 14</FaceValueVatType> <ImageURL>sample string 4</ImageURL> <IsFavouriteForUser>true</IsFavouriteForUser> <IsInStock>true</IsInStock> <Name>sample string 2</Name> <ProductNumber>sample string 1</ProductNumber> <ProductType>sample string 10</ProductType> <PurchasePrice>8</PurchasePrice> <PurchaseVat>9</PurchaseVat> <Purpose>sample string 12</Purpose> <SubCategory>1</SubCategory> <VatType>sample string 13</VatType> </ProductSalesModel> </ArrayOfProductSalesModel>