GET api/v2/products/GetProductList?filterCode={filterCode}&startRow={startRow}&endRow={endRow}

Get list of products

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filterCode

an optional filter code used to filter the result product list

string

None.

startRow

string

None.

endRow

string

None.

Body Parameters

None.

Response Information

Resource Description

ProductList
NameDescriptionTypeAdditional information
TotalProducts

integer

None.

Products

Products

None.

DateLastSync

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalProducts": 1,
  "Products": {
    "Product": [
      {
        "ProductNumber": "sample string 1",
        "ProductTitle": "sample string 2",
        "ParentTitle": "sample string 3",
        "LongDescription": "sample string 4",
        "ProductInfo": {
          "ProductNumber": "sample string 1",
          "ProductName": "sample string 2",
          "Description": "sample string 3",
          "LGE": "sample string 4",
          "ItemContent": [
            "sample string 1",
            "sample string 2"
          ],
          "Bullets": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "ItemType": "sample string 5",
        "StyleCode": "sample string 6",
        "CollectionCode": "sample string 7",
        "FabricContent": "sample string 8",
        "GroupNumber": "sample string 9",
        "TypeOfPackaging": "sample string 10",
        "CatalogYear": "sample string 11",
        "UPC": "sample string 12",
        "CategoryCode": "sample string 13",
        "SubCategoryCode": "sample string 14",
        "PieceCode": "sample string 15",
        "Prop65": "sample string 16",
        "CountryOfOrigin": "sample string 17",
        "ListNextGenImages": "sample string 18",
        "PictureFullURLs": "sample string 19",
        "WebImageURLs": "sample string 20",
        "NumImages": 21,
        "NumBoxes": 22,
        "PackQty": 23,
        "CatalogPage": "sample string 24",
        "FabricCleaningCode": "sample string 25",
        "MainColor": "sample string 26",
        "ColorFamily": "sample string 27",
        "WeightLimitsOverall": "sample string 28",
        "ShelfWeightLimit": "sample string 29",
        "DrawerWeightLimit": "sample string 30",
        "BedSlats": 31,
        "SlatType": "sample string 32",
        "MainFinish": "sample string 33",
        "MainMaterial": "sample string 34",
        "GrossWeight": 1.0,
        "GrossWeightTotal": 1.0,
        "Cubes": 1.0,
        "CartonDimensions": {
          "Length": 1.0,
          "Width": 1.0,
          "Height": 1.0
        },
        "Features": [
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "MaterialList": [
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "ProductDimensions": [
          {
            "PieceName": "sample string 1",
            "Length": 1.0,
            "Width": 1.0,
            "MaxWidth": 1.0,
            "Depth": 1.0,
            "MaxDepth": 1.0,
            "Height": 1.0,
            "MaxHeight": 1.0,
            "Diameter": 1.0,
            "SeatHeight": 1.0,
            "SeatWidth": 1.0,
            "SeatDepth": 1.0,
            "Weight": 1.0,
            "DeskClearance": 1.0
          },
          {
            "PieceName": "sample string 1",
            "Length": 1.0,
            "Width": 1.0,
            "MaxWidth": 1.0,
            "Depth": 1.0,
            "MaxDepth": 1.0,
            "Height": 1.0,
            "MaxHeight": 1.0,
            "Diameter": 1.0,
            "SeatHeight": 1.0,
            "SeatWidth": 1.0,
            "SeatDepth": 1.0,
            "Weight": 1.0,
            "DeskClearance": 1.0
          }
        ],
        "AdditionalFieldList": [
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "ShipMethod": "sample string 35",
        "Components": [
          {
            "ProductNumber": "sample string 1",
            "Name": "sample string 2",
            "UPC": "sample string 3",
            "BoxSize": {
              "Length": 1.0,
              "Width": 1.0,
              "Height": 1.0
            },
            "BoxWeight": 1.0,
            "Cubes": 1.0,
            "Qty": 4.0
          },
          {
            "ProductNumber": "sample string 1",
            "Name": "sample string 2",
            "UPC": "sample string 3",
            "BoxSize": {
              "Length": 1.0,
              "Width": 1.0,
              "Height": 1.0
            },
            "BoxWeight": 1.0,
            "Cubes": 1.0,
            "Qty": 4.0
          }
        ],
        "RelatedProducts": [
          "sample string 1",
          "sample string 2"
        ],
        "AssemblyRequired": true,
        "AssemblyType": "sample string 37",
        "AssemblyURL": "sample string 38",
        "IsDiscontinued": true
      },
      {
        "ProductNumber": "sample string 1",
        "ProductTitle": "sample string 2",
        "ParentTitle": "sample string 3",
        "LongDescription": "sample string 4",
        "ProductInfo": {
          "ProductNumber": "sample string 1",
          "ProductName": "sample string 2",
          "Description": "sample string 3",
          "LGE": "sample string 4",
          "ItemContent": [
            "sample string 1",
            "sample string 2"
          ],
          "Bullets": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "ItemType": "sample string 5",
        "StyleCode": "sample string 6",
        "CollectionCode": "sample string 7",
        "FabricContent": "sample string 8",
        "GroupNumber": "sample string 9",
        "TypeOfPackaging": "sample string 10",
        "CatalogYear": "sample string 11",
        "UPC": "sample string 12",
        "CategoryCode": "sample string 13",
        "SubCategoryCode": "sample string 14",
        "PieceCode": "sample string 15",
        "Prop65": "sample string 16",
        "CountryOfOrigin": "sample string 17",
        "ListNextGenImages": "sample string 18",
        "PictureFullURLs": "sample string 19",
        "WebImageURLs": "sample string 20",
        "NumImages": 21,
        "NumBoxes": 22,
        "PackQty": 23,
        "CatalogPage": "sample string 24",
        "FabricCleaningCode": "sample string 25",
        "MainColor": "sample string 26",
        "ColorFamily": "sample string 27",
        "WeightLimitsOverall": "sample string 28",
        "ShelfWeightLimit": "sample string 29",
        "DrawerWeightLimit": "sample string 30",
        "BedSlats": 31,
        "SlatType": "sample string 32",
        "MainFinish": "sample string 33",
        "MainMaterial": "sample string 34",
        "GrossWeight": 1.0,
        "GrossWeightTotal": 1.0,
        "Cubes": 1.0,
        "CartonDimensions": {
          "Length": 1.0,
          "Width": 1.0,
          "Height": 1.0
        },
        "Features": [
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "MaterialList": [
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "ProductDimensions": [
          {
            "PieceName": "sample string 1",
            "Length": 1.0,
            "Width": 1.0,
            "MaxWidth": 1.0,
            "Depth": 1.0,
            "MaxDepth": 1.0,
            "Height": 1.0,
            "MaxHeight": 1.0,
            "Diameter": 1.0,
            "SeatHeight": 1.0,
            "SeatWidth": 1.0,
            "SeatDepth": 1.0,
            "Weight": 1.0,
            "DeskClearance": 1.0
          },
          {
            "PieceName": "sample string 1",
            "Length": 1.0,
            "Width": 1.0,
            "MaxWidth": 1.0,
            "Depth": 1.0,
            "MaxDepth": 1.0,
            "Height": 1.0,
            "MaxHeight": 1.0,
            "Diameter": 1.0,
            "SeatHeight": 1.0,
            "SeatWidth": 1.0,
            "SeatDepth": 1.0,
            "Weight": 1.0,
            "DeskClearance": 1.0
          }
        ],
        "AdditionalFieldList": [
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Field": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "ShipMethod": "sample string 35",
        "Components": [
          {
            "ProductNumber": "sample string 1",
            "Name": "sample string 2",
            "UPC": "sample string 3",
            "BoxSize": {
              "Length": 1.0,
              "Width": 1.0,
              "Height": 1.0
            },
            "BoxWeight": 1.0,
            "Cubes": 1.0,
            "Qty": 4.0
          },
          {
            "ProductNumber": "sample string 1",
            "Name": "sample string 2",
            "UPC": "sample string 3",
            "BoxSize": {
              "Length": 1.0,
              "Width": 1.0,
              "Height": 1.0
            },
            "BoxWeight": 1.0,
            "Cubes": 1.0,
            "Qty": 4.0
          }
        ],
        "RelatedProducts": [
          "sample string 1",
          "sample string 2"
        ],
        "AssemblyRequired": true,
        "AssemblyType": "sample string 37",
        "AssemblyURL": "sample string 38",
        "IsDiscontinued": true
      }
    ]
  },
  "DateLastSync": "sample string 2"
}

application/xml, text/xml

Sample:
<ProductList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterWebAPI.Products">
  <DateLastSync>sample string 2</DateLastSync>
  <Products>
    <Product>
      <Product>
        <AdditionalFieldList>
          <AdditionalField>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </AdditionalField>
          <AdditionalField>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </AdditionalField>
        </AdditionalFieldList>
        <AssemblyRequired>true</AssemblyRequired>
        <AssemblyType>sample string 37</AssemblyType>
        <AssemblyURL>sample string 38</AssemblyURL>
        <BedSlats>31</BedSlats>
        <CartonDimensions>
          <Height>1</Height>
          <Length>1</Length>
          <Width>1</Width>
        </CartonDimensions>
        <CatalogPage>sample string 24</CatalogPage>
        <CatalogYear>sample string 11</CatalogYear>
        <CategoryCode>sample string 13</CategoryCode>
        <CollectionCode>sample string 7</CollectionCode>
        <ColorFamily>sample string 27</ColorFamily>
        <Components>
          <Component>
            <BoxSize>
              <Height>1</Height>
              <Length>1</Length>
              <Width>1</Width>
            </BoxSize>
            <BoxWeight>1</BoxWeight>
            <Cubes>1</Cubes>
            <Name>sample string 2</Name>
            <ProductNumber>sample string 1</ProductNumber>
            <Qty>4</Qty>
            <UPC>sample string 3</UPC>
          </Component>
          <Component>
            <BoxSize>
              <Height>1</Height>
              <Length>1</Length>
              <Width>1</Width>
            </BoxSize>
            <BoxWeight>1</BoxWeight>
            <Cubes>1</Cubes>
            <Name>sample string 2</Name>
            <ProductNumber>sample string 1</ProductNumber>
            <Qty>4</Qty>
            <UPC>sample string 3</UPC>
          </Component>
        </Components>
        <CountryOfOrigin>sample string 17</CountryOfOrigin>
        <Cubes>1</Cubes>
        <DrawerWeightLimit>sample string 30</DrawerWeightLimit>
        <FabricCleaningCode>sample string 25</FabricCleaningCode>
        <FabricContent>sample string 8</FabricContent>
        <Features>
          <Features>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Features>
          <Features>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Features>
        </Features>
        <GrossWeight>1</GrossWeight>
        <GrossWeightTotal>1</GrossWeightTotal>
        <GroupNumber>sample string 9</GroupNumber>
        <IsDiscontinued>true</IsDiscontinued>
        <ItemType>sample string 5</ItemType>
        <ListNextGenImages>sample string 18</ListNextGenImages>
        <LongDescription>sample string 4</LongDescription>
        <MainColor>sample string 26</MainColor>
        <MainFinish>sample string 33</MainFinish>
        <MainMaterial>sample string 34</MainMaterial>
        <MaterialList>
          <Material>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Material>
          <Material>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Material>
        </MaterialList>
        <NumBoxes>22</NumBoxes>
        <NumImages>21</NumImages>
        <PackQty>23</PackQty>
        <ParentTitle>sample string 3</ParentTitle>
        <PictureFullURLs>sample string 19</PictureFullURLs>
        <PieceCode>sample string 15</PieceCode>
        <ProductDimensions>
          <Measurement>
            <Depth>1</Depth>
            <DeskClearance>1</DeskClearance>
            <Diameter>1</Diameter>
            <Height>1</Height>
            <Length>1</Length>
            <MaxDepth>1</MaxDepth>
            <MaxHeight>1</MaxHeight>
            <MaxWidth>1</MaxWidth>
            <PieceName>sample string 1</PieceName>
            <SeatDepth>1</SeatDepth>
            <SeatHeight>1</SeatHeight>
            <SeatWidth>1</SeatWidth>
            <Weight>1</Weight>
            <Width>1</Width>
          </Measurement>
          <Measurement>
            <Depth>1</Depth>
            <DeskClearance>1</DeskClearance>
            <Diameter>1</Diameter>
            <Height>1</Height>
            <Length>1</Length>
            <MaxDepth>1</MaxDepth>
            <MaxHeight>1</MaxHeight>
            <MaxWidth>1</MaxWidth>
            <PieceName>sample string 1</PieceName>
            <SeatDepth>1</SeatDepth>
            <SeatHeight>1</SeatHeight>
            <SeatWidth>1</SeatWidth>
            <Weight>1</Weight>
            <Width>1</Width>
          </Measurement>
        </ProductDimensions>
        <ProductInfo>
          <Bullets xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Bullets>
          <Description>sample string 3</Description>
          <ItemContent xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ItemContent>
          <LGE>sample string 4</LGE>
          <ProductName>sample string 2</ProductName>
          <ProductNumber>sample string 1</ProductNumber>
        </ProductInfo>
        <ProductNumber>sample string 1</ProductNumber>
        <ProductTitle>sample string 2</ProductTitle>
        <Prop65>sample string 16</Prop65>
        <RelatedProducts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </RelatedProducts>
        <ShelfWeightLimit>sample string 29</ShelfWeightLimit>
        <ShipMethod>sample string 35</ShipMethod>
        <SlatType>sample string 32</SlatType>
        <StyleCode>sample string 6</StyleCode>
        <SubCategoryCode>sample string 14</SubCategoryCode>
        <TypeOfPackaging>sample string 10</TypeOfPackaging>
        <UPC>sample string 12</UPC>
        <WebImageURLs>sample string 20</WebImageURLs>
        <WeightLimitsOverall>sample string 28</WeightLimitsOverall>
      </Product>
      <Product>
        <AdditionalFieldList>
          <AdditionalField>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </AdditionalField>
          <AdditionalField>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </AdditionalField>
        </AdditionalFieldList>
        <AssemblyRequired>true</AssemblyRequired>
        <AssemblyType>sample string 37</AssemblyType>
        <AssemblyURL>sample string 38</AssemblyURL>
        <BedSlats>31</BedSlats>
        <CartonDimensions>
          <Height>1</Height>
          <Length>1</Length>
          <Width>1</Width>
        </CartonDimensions>
        <CatalogPage>sample string 24</CatalogPage>
        <CatalogYear>sample string 11</CatalogYear>
        <CategoryCode>sample string 13</CategoryCode>
        <CollectionCode>sample string 7</CollectionCode>
        <ColorFamily>sample string 27</ColorFamily>
        <Components>
          <Component>
            <BoxSize>
              <Height>1</Height>
              <Length>1</Length>
              <Width>1</Width>
            </BoxSize>
            <BoxWeight>1</BoxWeight>
            <Cubes>1</Cubes>
            <Name>sample string 2</Name>
            <ProductNumber>sample string 1</ProductNumber>
            <Qty>4</Qty>
            <UPC>sample string 3</UPC>
          </Component>
          <Component>
            <BoxSize>
              <Height>1</Height>
              <Length>1</Length>
              <Width>1</Width>
            </BoxSize>
            <BoxWeight>1</BoxWeight>
            <Cubes>1</Cubes>
            <Name>sample string 2</Name>
            <ProductNumber>sample string 1</ProductNumber>
            <Qty>4</Qty>
            <UPC>sample string 3</UPC>
          </Component>
        </Components>
        <CountryOfOrigin>sample string 17</CountryOfOrigin>
        <Cubes>1</Cubes>
        <DrawerWeightLimit>sample string 30</DrawerWeightLimit>
        <FabricCleaningCode>sample string 25</FabricCleaningCode>
        <FabricContent>sample string 8</FabricContent>
        <Features>
          <Features>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Features>
          <Features>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Features>
        </Features>
        <GrossWeight>1</GrossWeight>
        <GrossWeightTotal>1</GrossWeightTotal>
        <GroupNumber>sample string 9</GroupNumber>
        <IsDiscontinued>true</IsDiscontinued>
        <ItemType>sample string 5</ItemType>
        <ListNextGenImages>sample string 18</ListNextGenImages>
        <LongDescription>sample string 4</LongDescription>
        <MainColor>sample string 26</MainColor>
        <MainFinish>sample string 33</MainFinish>
        <MainMaterial>sample string 34</MainMaterial>
        <MaterialList>
          <Material>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Material>
          <Material>
            <Field>sample string 1</Field>
            <Value>sample string 2</Value>
          </Material>
        </MaterialList>
        <NumBoxes>22</NumBoxes>
        <NumImages>21</NumImages>
        <PackQty>23</PackQty>
        <ParentTitle>sample string 3</ParentTitle>
        <PictureFullURLs>sample string 19</PictureFullURLs>
        <PieceCode>sample string 15</PieceCode>
        <ProductDimensions>
          <Measurement>
            <Depth>1</Depth>
            <DeskClearance>1</DeskClearance>
            <Diameter>1</Diameter>
            <Height>1</Height>
            <Length>1</Length>
            <MaxDepth>1</MaxDepth>
            <MaxHeight>1</MaxHeight>
            <MaxWidth>1</MaxWidth>
            <PieceName>sample string 1</PieceName>
            <SeatDepth>1</SeatDepth>
            <SeatHeight>1</SeatHeight>
            <SeatWidth>1</SeatWidth>
            <Weight>1</Weight>
            <Width>1</Width>
          </Measurement>
          <Measurement>
            <Depth>1</Depth>
            <DeskClearance>1</DeskClearance>
            <Diameter>1</Diameter>
            <Height>1</Height>
            <Length>1</Length>
            <MaxDepth>1</MaxDepth>
            <MaxHeight>1</MaxHeight>
            <MaxWidth>1</MaxWidth>
            <PieceName>sample string 1</PieceName>
            <SeatDepth>1</SeatDepth>
            <SeatHeight>1</SeatHeight>
            <SeatWidth>1</SeatWidth>
            <Weight>1</Weight>
            <Width>1</Width>
          </Measurement>
        </ProductDimensions>
        <ProductInfo>
          <Bullets xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Bullets>
          <Description>sample string 3</Description>
          <ItemContent xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ItemContent>
          <LGE>sample string 4</LGE>
          <ProductName>sample string 2</ProductName>
          <ProductNumber>sample string 1</ProductNumber>
        </ProductInfo>
        <ProductNumber>sample string 1</ProductNumber>
        <ProductTitle>sample string 2</ProductTitle>
        <Prop65>sample string 16</Prop65>
        <RelatedProducts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </RelatedProducts>
        <ShelfWeightLimit>sample string 29</ShelfWeightLimit>
        <ShipMethod>sample string 35</ShipMethod>
        <SlatType>sample string 32</SlatType>
        <StyleCode>sample string 6</StyleCode>
        <SubCategoryCode>sample string 14</SubCategoryCode>
        <TypeOfPackaging>sample string 10</TypeOfPackaging>
        <UPC>sample string 12</UPC>
        <WebImageURLs>sample string 20</WebImageURLs>
        <WeightLimitsOverall>sample string 28</WeightLimitsOverall>
      </Product>
    </Product>
  </Products>
  <TotalProducts>1</TotalProducts>
</ProductList>