POST api/v1/ItemList
Request Information
URI Parameters
None.
Body Parameters
ProductListInput| Name | Description | Type | Additional information |
|---|---|---|---|
| Mode | string |
None. |
|
| ItemID | integer |
None. |
|
| LocID | integer |
None. |
|
| CompID | integer |
None. |
|
| ItemGroupID | integer |
None. |
|
| FestID | integer |
None. |
|
| ProductName | string |
None. |
|
| TaxonomyID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Mode": "sample string 1",
"ItemID": 2,
"LocID": 3,
"CompID": 4,
"ItemGroupID": 5,
"FestID": 6,
"ProductName": "sample string 7",
"TaxonomyID": 8
}
application/xml, text/xml
Sample:
<ProductListInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models"> <CompID>4</CompID> <FestID>6</FestID> <ItemGroupID>5</ItemGroupID> <ItemID>2</ItemID> <LocID>3</LocID> <Mode>sample string 1</Mode> <ProductName>sample string 7</ProductName> <TaxonomyID>8</TaxonomyID> </ProductListInput>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of ProductList| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemID | integer |
None. |
|
| ItemGroupID | integer |
None. |
|
| TaxonomyID | integer |
None. |
|
| Taxonomy | string |
None. |
|
| ItemDescr | string |
None. |
|
| Slug | string |
None. |
|
| SKU | string |
None. |
|
| GroupName | string |
None. |
|
| LocName | string |
None. |
|
| LocID | integer |
None. |
|
| HSNCode | string |
None. |
|
| CalcDesc | string |
None. |
|
| CalcMethod | string |
None. |
|
| GSTPer | decimal number |
None. |
|
| UOM | string |
None. |
|
| UOMID | integer |
None. |
|
| ItemStatus | string |
None. |
|
| ItemRate | decimal number |
None. |
|
| OnlineRate | decimal number |
None. |
|
| TakeawayRate | decimal number |
None. |
|
| CorL | string |
None. |
|
| productRate | Collection of prodRate |
None. |
|
| Comboitems | Collection of ComboRecipe |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ItemID": 1,
"ItemGroupID": 2,
"TaxonomyID": 3,
"Taxonomy": "sample string 4",
"ItemDescr": "sample string 5",
"Slug": "sample string 6",
"SKU": "sample string 7",
"GroupName": "sample string 8",
"LocName": "sample string 9",
"LocID": 10,
"HSNCode": "sample string 11",
"CalcDesc": "sample string 12",
"CalcMethod": "sample string 13",
"GSTPer": 14.0,
"UOM": "sample string 15",
"UOMID": 16,
"ItemStatus": "sample string 17",
"ItemRate": 18.0,
"OnlineRate": 19.0,
"TakeawayRate": 20.0,
"CorL": "sample string 21",
"productRate": [
{
"EffectiveDate": "2025-12-15T01:07:43.2857166+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
},
{
"EffectiveDate": "2025-12-15T01:07:43.2857166+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
}
],
"Comboitems": [
{
"ComboRecipeID": 1,
"ComboItemID": 2,
"ItemID": 3,
"Pct": 4.0
},
{
"ComboRecipeID": 1,
"ComboItemID": 2,
"ItemID": 3,
"Pct": 4.0
}
]
},
{
"ItemID": 1,
"ItemGroupID": 2,
"TaxonomyID": 3,
"Taxonomy": "sample string 4",
"ItemDescr": "sample string 5",
"Slug": "sample string 6",
"SKU": "sample string 7",
"GroupName": "sample string 8",
"LocName": "sample string 9",
"LocID": 10,
"HSNCode": "sample string 11",
"CalcDesc": "sample string 12",
"CalcMethod": "sample string 13",
"GSTPer": 14.0,
"UOM": "sample string 15",
"UOMID": 16,
"ItemStatus": "sample string 17",
"ItemRate": 18.0,
"OnlineRate": 19.0,
"TakeawayRate": 20.0,
"CorL": "sample string 21",
"productRate": [
{
"EffectiveDate": "2025-12-15T01:07:43.2857166+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
},
{
"EffectiveDate": "2025-12-15T01:07:43.2857166+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
}
],
"Comboitems": [
{
"ComboRecipeID": 1,
"ComboItemID": 2,
"ItemID": 3,
"Pct": 4.0
},
{
"ComboRecipeID": 1,
"ComboItemID": 2,
"ItemID": 3,
"Pct": 4.0
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfProductList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
<ProductList>
<CalcDesc>sample string 12</CalcDesc>
<CalcMethod>sample string 13</CalcMethod>
<Comboitems>
<ComboRecipe>
<ComboItemID>2</ComboItemID>
<ComboRecipeID>1</ComboRecipeID>
<ItemID>3</ItemID>
<Pct>4</Pct>
</ComboRecipe>
<ComboRecipe>
<ComboItemID>2</ComboItemID>
<ComboRecipeID>1</ComboRecipeID>
<ItemID>3</ItemID>
<Pct>4</Pct>
</ComboRecipe>
</Comboitems>
<CorL>sample string 21</CorL>
<GSTPer>14</GSTPer>
<GroupName>sample string 8</GroupName>
<HSNCode>sample string 11</HSNCode>
<ItemDescr>sample string 5</ItemDescr>
<ItemGroupID>2</ItemGroupID>
<ItemID>1</ItemID>
<ItemRate>18</ItemRate>
<ItemStatus>sample string 17</ItemStatus>
<LocID>10</LocID>
<LocName>sample string 9</LocName>
<OnlineRate>19</OnlineRate>
<SKU>sample string 7</SKU>
<Slug>sample string 6</Slug>
<TakeawayRate>20</TakeawayRate>
<Taxonomy>sample string 4</Taxonomy>
<TaxonomyID>3</TaxonomyID>
<UOM>sample string 15</UOM>
<UOMID>16</UOMID>
<productRate>
<prodRate>
<EffectiveDate>2025-12-15T01:07:43.2857166+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
<prodRate>
<EffectiveDate>2025-12-15T01:07:43.2857166+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
</productRate>
</ProductList>
<ProductList>
<CalcDesc>sample string 12</CalcDesc>
<CalcMethod>sample string 13</CalcMethod>
<Comboitems>
<ComboRecipe>
<ComboItemID>2</ComboItemID>
<ComboRecipeID>1</ComboRecipeID>
<ItemID>3</ItemID>
<Pct>4</Pct>
</ComboRecipe>
<ComboRecipe>
<ComboItemID>2</ComboItemID>
<ComboRecipeID>1</ComboRecipeID>
<ItemID>3</ItemID>
<Pct>4</Pct>
</ComboRecipe>
</Comboitems>
<CorL>sample string 21</CorL>
<GSTPer>14</GSTPer>
<GroupName>sample string 8</GroupName>
<HSNCode>sample string 11</HSNCode>
<ItemDescr>sample string 5</ItemDescr>
<ItemGroupID>2</ItemGroupID>
<ItemID>1</ItemID>
<ItemRate>18</ItemRate>
<ItemStatus>sample string 17</ItemStatus>
<LocID>10</LocID>
<LocName>sample string 9</LocName>
<OnlineRate>19</OnlineRate>
<SKU>sample string 7</SKU>
<Slug>sample string 6</Slug>
<TakeawayRate>20</TakeawayRate>
<Taxonomy>sample string 4</Taxonomy>
<TaxonomyID>3</TaxonomyID>
<UOM>sample string 15</UOM>
<UOMID>16</UOMID>
<productRate>
<prodRate>
<EffectiveDate>2025-12-15T01:07:43.2857166+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
<prodRate>
<EffectiveDate>2025-12-15T01:07:43.2857166+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
</productRate>
</ProductList>
</ArrayOfProductList>