POST api/Product/List
Request Information
URI Parameters
None.
Body Parameters
ProductPage| Name | Description | Type | Additional information |
|---|---|---|---|
| PID | string |
None. |
|
| ProductTypeId | integer |
None. |
|
| SortOrders | integer |
None. |
|
| ProductName | string |
None. |
|
| PRODUCT_DESCRIPTION | string |
None. |
|
| ShortDescription | string |
None. |
|
| ProductSize | string |
None. |
|
| ProductUnit | string |
None. |
|
| ProductVariety | string |
None. |
|
| ProductHSNCode | string |
None. |
|
| ProductGroup | string |
None. |
|
| Photo | string |
None. |
|
| PRODUCTCD | string |
None. |
|
| ExternalLink | string |
None. |
|
| GlobalSearch | string |
None. |
|
| FirstRec | integer |
None. |
|
| LastRec | integer |
None. |
|
| RequestType | integer |
None. |
|
| SortColumn | string |
None. |
|
| SortOrder | string |
None. |
|
| IsBatchRequired | boolean |
None. |
|
| IsTaxExempte | boolean |
None. |
|
| EffectiveDate | string |
None. |
|
| TaxExempted | integer |
None. |
|
| BatchRequired | integer |
None. |
|
| BrandId | integer |
None. |
|
| BrandName | string |
None. |
|
| PackTypesID | integer |
None. |
|
| PackTypesName | string |
None. |
|
| PackSizeID | integer |
None. |
|
| PackSizeName | string |
None. |
|
| ProductTypeName | string |
None. |
|
| PackGroupId | integer |
None. |
|
| PackGroupName | string |
None. |
|
| ProductCategoriesID | integer |
None. |
|
| ProductCategoriesName | string |
None. |
|
| MarketSegmentsID | integer |
None. |
|
| MarketSegmentsName | string |
None. |
|
| ProductRegionId | integer |
None. |
|
| ProductRegionName | string |
None. |
|
| VarietyId | integer |
None. |
|
| VarietyName | string |
None. |
|
| ProductVariantId | integer |
None. |
|
| ProductVariantName | string |
None. |
|
| ProductBrandId | integer |
None. |
|
| ProductBrand | string |
None. |
|
| PackSize | string |
None. |
|
| PackUnit | string |
None. |
|
| SchemeType | string |
None. |
|
| Type | string |
None. |
|
| Message | APIResponse |
None. |
|
| SecretKey | string |
None. |
|
| Token | string |
None. |
|
| EnterprisesCode | string |
None. |
|
| ModeluSelection | string |
None. |
|
| CallFrom | string |
None. |
|
| IsAllowedRequest | boolean |
None. |
|
| IsInMaintenance | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"PID": "sample string 1",
"ProductTypeId": 2,
"SortOrders": 3,
"ProductName": "sample string 4",
"PRODUCT_DESCRIPTION": "sample string 5",
"ShortDescription": "sample string 6",
"ProductSize": "sample string 7",
"ProductUnit": "sample string 8",
"ProductVariety": "sample string 9",
"ProductHSNCode": "sample string 10",
"ProductGroup": "sample string 11",
"Photo": "sample string 12",
"PRODUCTCD": "sample string 13",
"ExternalLink": "sample string 14",
"GlobalSearch": "sample string 15",
"FirstRec": 16,
"LastRec": 17,
"RequestType": 18,
"SortColumn": "sample string 19",
"SortOrder": "sample string 20",
"IsBatchRequired": true,
"IsTaxExempte": true,
"EffectiveDate": "sample string 23",
"TaxExempted": 24,
"BatchRequired": 25,
"BrandId": 26,
"BrandName": "sample string 27",
"PackTypesID": 28,
"PackTypesName": "sample string 29",
"PackSizeID": 30,
"PackSizeName": "sample string 31",
"ProductTypeName": "sample string 32",
"PackGroupId": 33,
"PackGroupName": "sample string 34",
"ProductCategoriesID": 35,
"ProductCategoriesName": "sample string 36",
"MarketSegmentsID": 37,
"MarketSegmentsName": "sample string 38",
"ProductRegionId": 39,
"ProductRegionName": "sample string 40",
"VarietyId": 41,
"VarietyName": "sample string 42",
"ProductVariantId": 43,
"ProductVariantName": "sample string 44",
"ProductBrandId": 45,
"ProductBrand": "sample string 46",
"PackSize": "sample string 47",
"PackUnit": "sample string 48",
"SchemeType": "sample string 49",
"Type": "sample string 50",
"Message": {
"ResponseCode": 1,
"ResponseMessage": "sample string 2"
},
"SecretKey": "sample string 51",
"Token": "sample string 52",
"EnterprisesCode": "sample string 53",
"ModeluSelection": "sample string 54",
"CallFrom": "sample string 55",
"IsAllowedRequest": true,
"IsInMaintenance": true
}
application/xml, text/xml
Sample:
<ProductPage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZipDMSModels">
<CallFrom>sample string 55</CallFrom>
<EnterprisesCode>sample string 53</EnterprisesCode>
<IsAllowedRequest>true</IsAllowedRequest>
<IsInMaintenance>true</IsInMaintenance>
<Message>
<ResponseCode>1</ResponseCode>
<ResponseMessage>sample string 2</ResponseMessage>
</Message>
<ModeluSelection>sample string 54</ModeluSelection>
<SecretKey>sample string 51</SecretKey>
<Token>sample string 52</Token>
<BatchRequired>25</BatchRequired>
<BrandId>26</BrandId>
<BrandName>sample string 27</BrandName>
<EffectiveDate>sample string 23</EffectiveDate>
<ExternalLink>sample string 14</ExternalLink>
<FirstRec>16</FirstRec>
<GlobalSearch>sample string 15</GlobalSearch>
<IsBatchRequired>true</IsBatchRequired>
<IsTaxExempte>true</IsTaxExempte>
<LastRec>17</LastRec>
<MarketSegmentsID>37</MarketSegmentsID>
<MarketSegmentsName>sample string 38</MarketSegmentsName>
<PID>sample string 1</PID>
<PRODUCTCD>sample string 13</PRODUCTCD>
<PRODUCT_DESCRIPTION>sample string 5</PRODUCT_DESCRIPTION>
<PackGroupId>33</PackGroupId>
<PackGroupName>sample string 34</PackGroupName>
<PackSize>sample string 47</PackSize>
<PackSizeID>30</PackSizeID>
<PackSizeName>sample string 31</PackSizeName>
<PackTypesID>28</PackTypesID>
<PackTypesName>sample string 29</PackTypesName>
<PackUnit>sample string 48</PackUnit>
<Photo>sample string 12</Photo>
<ProductBrand>sample string 46</ProductBrand>
<ProductBrandId>45</ProductBrandId>
<ProductCategoriesID>35</ProductCategoriesID>
<ProductCategoriesName>sample string 36</ProductCategoriesName>
<ProductGroup>sample string 11</ProductGroup>
<ProductHSNCode>sample string 10</ProductHSNCode>
<ProductName>sample string 4</ProductName>
<ProductRegionId>39</ProductRegionId>
<ProductRegionName>sample string 40</ProductRegionName>
<ProductSize>sample string 7</ProductSize>
<ProductTypeId>2</ProductTypeId>
<ProductTypeName>sample string 32</ProductTypeName>
<ProductUnit>sample string 8</ProductUnit>
<ProductVariantId>43</ProductVariantId>
<ProductVariantName>sample string 44</ProductVariantName>
<ProductVariety>sample string 9</ProductVariety>
<RequestType>18</RequestType>
<SchemeType>sample string 49</SchemeType>
<ShortDescription>sample string 6</ShortDescription>
<SortColumn>sample string 19</SortColumn>
<SortOrder>sample string 20</SortOrder>
<SortOrders>3</SortOrders>
<TaxExempted>24</TaxExempted>
<Type>sample string 50</Type>
<VarietyId>41</VarietyId>
<VarietyName>sample string 42</VarietyName>
</ProductPage>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |