GET api/V3/Product/list

Lists all the products. Max 1000 products are listed in a request. Use paging ($skip) to get more.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of V3.Product
NameDescriptionTypeAdditional information
Deactivated

Product is disabled

 boolean

None.
ProductGuid

Guid of the product

 string

None.
ProductDivision

Division of the Product

 string

Required

String length: inclusive between 0 and 100
Brand

Brand of the Product

 string

Required

String length: inclusive between 0 and 100
Category

Category Name of the Product

 string

Required

String length: inclusive between 0 and 100
DisplayCategory

Category of Display

 string

String length: inclusive between 0 and 30
StandardUnit

string

String length: inclusive between 0 and 50
SuperUnit

Name of the Super Unit for the Product

 string

String length: inclusive between 0 and 50
Name

NAme of the Product of the SKU

 string

Required

String length: inclusive between 0 and 100
VariantName

Name of the Variant of the SKU

 string

None.
MRP

Maximum Retail Price of the Product just for indication

 string

None.
Price

Price to Retailer also kown as PTR

 decimal number

None.
Unit

Unit of Measurement for the product. e.g. 'box' or 'pcs'

 string

Required

String length: inclusive between 0 and 50
LocalName

Local Name of the Product

 string

String length: inclusive between 0 and 100
Image

Not available in APIs

 string

None.
StandardUnitConversionFactor

Standard Unit Conversion Factor for the Standard Unit

 decimal number

None.
SuperUnitConversionFactor

Super Unit Conversion Factor for the Super Unit

 decimal number

None.
DisplayOrder

Order Position at which the Product is displayed in App

 integer

None.
PackagingType

Type of Packaging paper/Box/Pouch etc...

 string

String length: inclusive between 0 and 20
IsPromoted

True or False indicating if the product is a Promoted Product

 boolean

None.
Description

Brief Description if needed...

 string

None.
ProductERPId

SAP or ERP id of the product

 string

Required

String length: inclusive between 1 and 50
Schemes

Scheme details for the product

 string

None.
PackSize

Pack Size of the Product

 string

None.
Color

Color of the Product

 string

String length: inclusive between 0 and 64
AlternateCategory

Alternate Category of the Product

 string

None.
IsNewLaunch

IsNewProduct as True or False

 boolean

None.
MBQ

Minimum Batch Quantity

 integer

Range: inclusive between 1 and 2147483647
ExpiryInDays

Expiry in days of the product

 integer

None.
GSTCategory

Category for Tax at Sale Point

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Deactivated": true,
    "ProductGuid": "sample string 2",
    "ProductDivision": "sample string 3",
    "Brand": "sample string 4",
    "Category": "sample string 5",
    "DisplayCategory": "sample string 6",
    "StandardUnit": "sample string 7",
    "SuperUnit": "sample string 8",
    "Name": "sample string 9",
    "VariantName": "sample string 10",
    "MRP": "sample string 11",
    "Price": 12.1,
    "Unit": "sample string 13",
    "LocalName": "sample string 14",
    "Image": "sample string 15",
    "StandardUnitConversionFactor": 1.1,
    "SuperUnitConversionFactor": 1.1,
    "DisplayOrder": 1,
    "PackagingType": "sample string 16",
    "IsPromoted": true,
    "Description": "sample string 17",
    "ProductERPId": "sample string 18",
    "Schemes": "sample string 19",
    "PackSize": "sample string 20",
    "Color": "sample string 21",
    "AlternateCategory": "sample string 22",
    "IsNewLaunch": true,
    "MBQ": 1,
    "ExpiryInDays": 1,
    "GSTCategory": "sample string 23"
  },
  {
    "Deactivated": true,
    "ProductGuid": "sample string 2",
    "ProductDivision": "sample string 3",
    "Brand": "sample string 4",
    "Category": "sample string 5",
    "DisplayCategory": "sample string 6",
    "StandardUnit": "sample string 7",
    "SuperUnit": "sample string 8",
    "Name": "sample string 9",
    "VariantName": "sample string 10",
    "MRP": "sample string 11",
    "Price": 12.1,
    "Unit": "sample string 13",
    "LocalName": "sample string 14",
    "Image": "sample string 15",
    "StandardUnitConversionFactor": 1.1,
    "SuperUnitConversionFactor": 1.1,
    "DisplayOrder": 1,
    "PackagingType": "sample string 16",
    "IsPromoted": true,
    "Description": "sample string 17",
    "ProductERPId": "sample string 18",
    "Schemes": "sample string 19",
    "PackSize": "sample string 20",
    "Color": "sample string 21",
    "AlternateCategory": "sample string 22",
    "IsNewLaunch": true,
    "MBQ": 1,
    "ExpiryInDays": 1,
    "GSTCategory": "sample string 23"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <Product>
    <AlternateCategory>sample string 22</AlternateCategory>
    <Color>sample string 21</Color>
    <Description>sample string 17</Description>
    <DisplayOrder>1</DisplayOrder>
    <ExpiryInDays>1</ExpiryInDays>
    <GSTCategory>sample string 23</GSTCategory>
    <Image>sample string 15</Image>
    <IsNewLaunch>true</IsNewLaunch>
    <IsPromoted>true</IsPromoted>
    <LocalName>sample string 14</LocalName>
    <MBQ>1</MBQ>
    <MRP>sample string 11</MRP>
    <Name>sample string 9</Name>
    <PackSize>sample string 20</PackSize>
    <PackagingType>sample string 16</PackagingType>
    <Price>12.1</Price>
    <ProductERPId>sample string 18</ProductERPId>
    <Schemes>sample string 19</Schemes>
    <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor>
    <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor>
    <Unit>sample string 13</Unit>
    <VariantName>sample string 10</VariantName>
    <Brand>sample string 4</Brand>
    <Category>sample string 5</Category>
    <DisplayCategory>sample string 6</DisplayCategory>
    <ProductDivision>sample string 3</ProductDivision>
    <StandardUnit>sample string 7</StandardUnit>
    <SuperUnit>sample string 8</SuperUnit>
    <Deactivated>true</Deactivated>
    <ProductGuid>sample string 2</ProductGuid>
  </Product>
  <Product>
    <AlternateCategory>sample string 22</AlternateCategory>
    <Color>sample string 21</Color>
    <Description>sample string 17</Description>
    <DisplayOrder>1</DisplayOrder>
    <ExpiryInDays>1</ExpiryInDays>
    <GSTCategory>sample string 23</GSTCategory>
    <Image>sample string 15</Image>
    <IsNewLaunch>true</IsNewLaunch>
    <IsPromoted>true</IsPromoted>
    <LocalName>sample string 14</LocalName>
    <MBQ>1</MBQ>
    <MRP>sample string 11</MRP>
    <Name>sample string 9</Name>
    <PackSize>sample string 20</PackSize>
    <PackagingType>sample string 16</PackagingType>
    <Price>12.1</Price>
    <ProductERPId>sample string 18</ProductERPId>
    <Schemes>sample string 19</Schemes>
    <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor>
    <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor>
    <Unit>sample string 13</Unit>
    <VariantName>sample string 10</VariantName>
    <Brand>sample string 4</Brand>
    <Category>sample string 5</Category>
    <DisplayCategory>sample string 6</DisplayCategory>
    <ProductDivision>sample string 3</ProductDivision>
    <StandardUnit>sample string 7</StandardUnit>
    <SuperUnit>sample string 8</SuperUnit>
    <Deactivated>true</Deactivated>
    <ProductGuid>sample string 2</ProductGuid>
  </Product>
</ArrayOfProduct>