GET api/product?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}&keyword={keyword}&manufacturer={manufacturer}&excludeDiscontinued={excludeDiscontinued}&stripDescriptionHTML={stripDescriptionHTML}

Get detailed product information for items found withing the specified parameters.

Request Information

Parameters

NameDescriptionAdditional information
pageNumber
The page number to get

Define this parameter in the request URI.

pageSize
The total number of results per page.

Define this parameter in the request URI.

modifiedAfter
Filter only products that have been modified after this date.

Define this parameter in the request URI.

keyword
Filter only products that contain the keyword in the description or title.

Define this parameter in the request URI.

manufacturer
Filter only products for the specified manufacturer.

Define this parameter in the request URI.

excludeDiscontinued
Set to true to exclude disconinued products.

Define this parameter in the request URI.

stripDescriptionHTML
Remove all the HTML from the product description

Define this parameter in the request URI.

Response Information

Detailed product information for all items found

Response body formats

application/json, text/json

Sample:
{
  "PageNumber": 1,
  "PageSize": 2,
  "TotalItems": 3,
  "TotalPages": 4,
  "Products": [
    {
      "Sku": "sample string 1",
      "Upc": "sample string 2",
      "ManufacturerNumber": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "WholesalePrice": 1.0,
      "Msrp": 1.0,
      "MinimumAdvertisedPrice": 1.0,
      "AvailableQuantity": 1,
      "QuantityOnHand": 1,
      "Weight": 1.0,
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "Manufacturer": "sample string 6",
      "DateCreated": "2021-12-07T16:15:12.7472803-05:00",
      "DateModified": "2021-12-07T16:15:12.7472803-05:00",
      "Discontinued": true,
      "Video": "sample string 10",
      "Sellable": true,
      "DateDiscontinued": "2021-12-07T16:15:12.7472803-05:00",
      "Categories": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Sku": "sample string 1",
      "Upc": "sample string 2",
      "ManufacturerNumber": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "WholesalePrice": 1.0,
      "Msrp": 1.0,
      "MinimumAdvertisedPrice": 1.0,
      "AvailableQuantity": 1,
      "QuantityOnHand": 1,
      "Weight": 1.0,
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "Manufacturer": "sample string 6",
      "DateCreated": "2021-12-07T16:15:12.7472803-05:00",
      "DateModified": "2021-12-07T16:15:12.7472803-05:00",
      "Discontinued": true,
      "Video": "sample string 10",
      "Sellable": true,
      "DateDiscontinued": "2021-12-07T16:15:12.7472803-05:00",
      "Categories": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Sku": "sample string 1",
      "Upc": "sample string 2",
      "ManufacturerNumber": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "WholesalePrice": 1.0,
      "Msrp": 1.0,
      "MinimumAdvertisedPrice": 1.0,
      "AvailableQuantity": 1,
      "QuantityOnHand": 1,
      "Weight": 1.0,
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "Manufacturer": "sample string 6",
      "DateCreated": "2021-12-07T16:15:12.7472803-05:00",
      "DateModified": "2021-12-07T16:15:12.7472803-05:00",
      "Discontinued": true,
      "Video": "sample string 10",
      "Sellable": true,
      "DateDiscontinued": "2021-12-07T16:15:12.7472803-05:00",
      "Categories": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<Results xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <TotalItems>3</TotalItems>
  <TotalPages>4</TotalPages>
  <Products>
    <Product>
      <Sku>sample string 1</Sku>
      <Upc>sample string 2</Upc>
      <ManufacturerNumber>sample string 3</ManufacturerNumber>
      <Name>sample string 4</Name>
      <Description>sample string 5</Description>
      <WholesalePrice>1</WholesalePrice>
      <Msrp>1</Msrp>
      <MinimumAdvertisedPrice>1</MinimumAdvertisedPrice>
      <AvailableQuantity>1</AvailableQuantity>
      <QuantityOnHand>1</QuantityOnHand>
      <Weight>1</Weight>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <Manufacturer>sample string 6</Manufacturer>
      <DateCreated>2021-12-07T16:15:12.7472803-05:00</DateCreated>
      <DateModified>2021-12-07T16:15:12.7472803-05:00</DateModified>
      <Discontinued>true</Discontinued>
      <Video>sample string 10</Video>
      <Sellable>true</Sellable>
      <DateDiscontinued>2021-12-07T16:15:12.7472803-05:00</DateDiscontinued>
      <Categories>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
      </Categories>
      <Attributes>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
      </Attributes>
    </Product>
    <Product>
      <Sku>sample string 1</Sku>
      <Upc>sample string 2</Upc>
      <ManufacturerNumber>sample string 3</ManufacturerNumber>
      <Name>sample string 4</Name>
      <Description>sample string 5</Description>
      <WholesalePrice>1</WholesalePrice>
      <Msrp>1</Msrp>
      <MinimumAdvertisedPrice>1</MinimumAdvertisedPrice>
      <AvailableQuantity>1</AvailableQuantity>
      <QuantityOnHand>1</QuantityOnHand>
      <Weight>1</Weight>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <Manufacturer>sample string 6</Manufacturer>
      <DateCreated>2021-12-07T16:15:12.7472803-05:00</DateCreated>
      <DateModified>2021-12-07T16:15:12.7472803-05:00</DateModified>
      <Discontinued>true</Discontinued>
      <Video>sample string 10</Video>
      <Sellable>true</Sellable>
      <DateDiscontinued>2021-12-07T16:15:12.7472803-05:00</DateDiscontinued>
      <Categories>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
      </Categories>
      <Attributes>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
      </Attributes>
    </Product>
    <Product>
      <Sku>sample string 1</Sku>
      <Upc>sample string 2</Upc>
      <ManufacturerNumber>sample string 3</ManufacturerNumber>
      <Name>sample string 4</Name>
      <Description>sample string 5</Description>
      <WholesalePrice>1</WholesalePrice>
      <Msrp>1</Msrp>
      <MinimumAdvertisedPrice>1</MinimumAdvertisedPrice>
      <AvailableQuantity>1</AvailableQuantity>
      <QuantityOnHand>1</QuantityOnHand>
      <Weight>1</Weight>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <Manufacturer>sample string 6</Manufacturer>
      <DateCreated>2021-12-07T16:15:12.7472803-05:00</DateCreated>
      <DateModified>2021-12-07T16:15:12.7472803-05:00</DateModified>
      <Discontinued>true</Discontinued>
      <Video>sample string 10</Video>
      <Sellable>true</Sellable>
      <DateDiscontinued>2021-12-07T16:15:12.7472803-05:00</DateDiscontinued>
      <Categories>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
        <Category>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Category>
      </Categories>
      <Attributes>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </Attribute>
      </Attributes>
    </Product>
  </Products>
</Results>