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. |
|
| ItemType | string |
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,
"ItemType": "sample string 9"
}
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> <ItemType>sample string 9</ItemType> <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. |
|
| ItemType | string |
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,
"ItemType": "sample string 11",
"HSNCode": "sample string 12",
"CalcDesc": "sample string 13",
"CalcMethod": "sample string 14",
"GSTPer": 15.0,
"UOM": "sample string 16",
"UOMID": 17,
"ItemStatus": "sample string 18",
"ItemRate": 19.0,
"OnlineRate": 20.0,
"TakeawayRate": 21.0,
"CorL": "sample string 22",
"productRate": [
{
"EffectiveDate": "2025-12-15T02:50:01.9591371+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
},
{
"EffectiveDate": "2025-12-15T02:50:01.9591371+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
}
],
"Comboitems": [
{
"ComboItemID": 1,
"ComboMainItemID": 2,
"ItemID": 3,
"Qty": 4.0,
"Pct": 5.0,
"Item": "sample string 6",
"UOM": "sample string 7"
},
{
"ComboItemID": 1,
"ComboMainItemID": 2,
"ItemID": 3,
"Qty": 4.0,
"Pct": 5.0,
"Item": "sample string 6",
"UOM": "sample string 7"
}
]
},
{
"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,
"ItemType": "sample string 11",
"HSNCode": "sample string 12",
"CalcDesc": "sample string 13",
"CalcMethod": "sample string 14",
"GSTPer": 15.0,
"UOM": "sample string 16",
"UOMID": 17,
"ItemStatus": "sample string 18",
"ItemRate": 19.0,
"OnlineRate": 20.0,
"TakeawayRate": 21.0,
"CorL": "sample string 22",
"productRate": [
{
"EffectiveDate": "2025-12-15T02:50:01.9591371+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
},
{
"EffectiveDate": "2025-12-15T02:50:01.9591371+05:30",
"ProdID": 2,
"ProdRate": 3.0,
"OnlineRate": 4.0,
"TakeawayRate": 5.0
}
],
"Comboitems": [
{
"ComboItemID": 1,
"ComboMainItemID": 2,
"ItemID": 3,
"Qty": 4.0,
"Pct": 5.0,
"Item": "sample string 6",
"UOM": "sample string 7"
},
{
"ComboItemID": 1,
"ComboMainItemID": 2,
"ItemID": 3,
"Qty": 4.0,
"Pct": 5.0,
"Item": "sample string 6",
"UOM": "sample string 7"
}
]
}
]
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 13</CalcDesc>
<CalcMethod>sample string 14</CalcMethod>
<Comboitems>
<ComboRecipe>
<ComboItemID>1</ComboItemID>
<ComboMainItemID>2</ComboMainItemID>
<Item>sample string 6</Item>
<ItemID>3</ItemID>
<Pct>5</Pct>
<Qty>4</Qty>
<UOM>sample string 7</UOM>
</ComboRecipe>
<ComboRecipe>
<ComboItemID>1</ComboItemID>
<ComboMainItemID>2</ComboMainItemID>
<Item>sample string 6</Item>
<ItemID>3</ItemID>
<Pct>5</Pct>
<Qty>4</Qty>
<UOM>sample string 7</UOM>
</ComboRecipe>
</Comboitems>
<CorL>sample string 22</CorL>
<GSTPer>15</GSTPer>
<GroupName>sample string 8</GroupName>
<HSNCode>sample string 12</HSNCode>
<ItemDescr>sample string 5</ItemDescr>
<ItemGroupID>2</ItemGroupID>
<ItemID>1</ItemID>
<ItemRate>19</ItemRate>
<ItemStatus>sample string 18</ItemStatus>
<ItemType>sample string 11</ItemType>
<LocID>10</LocID>
<LocName>sample string 9</LocName>
<OnlineRate>20</OnlineRate>
<SKU>sample string 7</SKU>
<Slug>sample string 6</Slug>
<TakeawayRate>21</TakeawayRate>
<Taxonomy>sample string 4</Taxonomy>
<TaxonomyID>3</TaxonomyID>
<UOM>sample string 16</UOM>
<UOMID>17</UOMID>
<productRate>
<prodRate>
<EffectiveDate>2025-12-15T02:50:01.9591371+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
<prodRate>
<EffectiveDate>2025-12-15T02:50:01.9591371+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
</productRate>
</ProductList>
<ProductList>
<CalcDesc>sample string 13</CalcDesc>
<CalcMethod>sample string 14</CalcMethod>
<Comboitems>
<ComboRecipe>
<ComboItemID>1</ComboItemID>
<ComboMainItemID>2</ComboMainItemID>
<Item>sample string 6</Item>
<ItemID>3</ItemID>
<Pct>5</Pct>
<Qty>4</Qty>
<UOM>sample string 7</UOM>
</ComboRecipe>
<ComboRecipe>
<ComboItemID>1</ComboItemID>
<ComboMainItemID>2</ComboMainItemID>
<Item>sample string 6</Item>
<ItemID>3</ItemID>
<Pct>5</Pct>
<Qty>4</Qty>
<UOM>sample string 7</UOM>
</ComboRecipe>
</Comboitems>
<CorL>sample string 22</CorL>
<GSTPer>15</GSTPer>
<GroupName>sample string 8</GroupName>
<HSNCode>sample string 12</HSNCode>
<ItemDescr>sample string 5</ItemDescr>
<ItemGroupID>2</ItemGroupID>
<ItemID>1</ItemID>
<ItemRate>19</ItemRate>
<ItemStatus>sample string 18</ItemStatus>
<ItemType>sample string 11</ItemType>
<LocID>10</LocID>
<LocName>sample string 9</LocName>
<OnlineRate>20</OnlineRate>
<SKU>sample string 7</SKU>
<Slug>sample string 6</Slug>
<TakeawayRate>21</TakeawayRate>
<Taxonomy>sample string 4</Taxonomy>
<TaxonomyID>3</TaxonomyID>
<UOM>sample string 16</UOM>
<UOMID>17</UOMID>
<productRate>
<prodRate>
<EffectiveDate>2025-12-15T02:50:01.9591371+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
<prodRate>
<EffectiveDate>2025-12-15T02:50:01.9591371+05:30</EffectiveDate>
<OnlineRate>4</OnlineRate>
<ProdID>2</ProdID>
<ProdRate>3</ProdRate>
<TakeawayRate>5</TakeawayRate>
</prodRate>
</productRate>
</ProductList>
</ArrayOfProductList>