Example Queries: Product Catalog Search Service

The Product Catalog Search Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to query and retrieve specific product information from an advertiser’s product catalogs. Refer to the following use cases for examples of this service.

Use Case #1

A user would like to list the first 100 product links for Nike basketball shoes for their joined advertisers that target the United States, and sell in US Dollars. The user would like to see the records sorted by price in descending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

websiteId

Your Web site ID (PID), which much match the Web site PID you used to register your developer key (Required).

advertiserIds

joined

keywords

basketball shoes

manufactuerName

Nike

targetedArea

US

currency

USD

maxResults

100

sortBy

price

sortOrder

desc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope>

   <soapenv:Header/>

   <soapenv:Body>

      <api:search>

         <developerKey></developerKey>

         <api:websiteId>12345</api:websiteId>

         <api:advertiserIds>joined</api:advertiserIds>

         <api:keywords>basketball shoes</api:keywords>

         <api:serviceableArea>US</api:serviceableArea>

         <api:upc></api:upc>

         <api:manufacturerName>nike</api:manufacturerName>

         <api:manufacturerSku></api:manufacturerSku>

         <api:advertiserSku></api:advertiserSku>

         <api:lowPrice></api:lowPrice>

         <api:highPrice></api:highPrice>

         <api:lowSalePrice></api:lowSalePrice>

         <api:highSalePrice></api:highSalePrice>

         <api:currency>USD</api:currency>

         <api:isbn></api:isbn>

         <api:sortBy>price</api:sortBy>

         <api:sortOrder>desc</api:sortOrder>

         <api:startAt></api:startAt>

         <api:maxResults>100</api:maxResults>

      </api:search>

   </soapenv:Body>

</soapenv:Envelope>

Response:

 <ns1:Product>

                  <adId>160261</adId>

                  <advertiserId>3434343</advertiserId>

                  <advertiserName>Paragon Sports</advertiserName>

                  <buyUrl>http://www.anrdoezrs.net/click-12345-10360261?url=http%3A%2F%2Fwww.paragonsports.com%2FParagon%2FShop%3FDSP%3D40000%26PCR%
3D1%3A102%3A1055%3A10427%26IID%3D5-315016%26E1SRC%3DCJ%26E1PRM%3DNIGHTLY</buyUrl>

                  <catalogId>cjo:655</catalogId>

                  <currency>USD</currency>

                  <description xmlns="http://product.lucene.service.cj.com">Celebrate a quarter century of basketball greatness. The men's Nike Air Force 2007 Supreme Shoe is the culmination of 25 years of Air Force, with all the plush sophistication and dynamic response of the Air Force legacy in a progressive, modern package.</description>

                  <imageUrl>http://www.paragonsports.com/Paragon/images/medium/5-315016_blackred_pd.jpg</imageUrl>

                  <inStock/>

                  <isbn />

                  <manufacturerName>Nike</manufacturerName>

                  <manufacturerSku/>

                  <name>Nike Air Force 25 Supreme - Mens</name>

                  <price>175.0</price>

                  <retailPrice>175.0</retailPrice>

                  <salePrice>0.0</salePrice>

                  <sku>5-31516</sku>

                  <upc />

               </ns1:Product>

Response

 <ns1:Product>

                  <adId>160261</adId>

                  <advertiserId>3434343</advertiserId>

                  <advertiserName>Paragon Sports</advertiserName>

                  <buyUrl>http://www.anrdoezrs.net/click-12345-10360261?url=http%3A%2F%2Fwww.paragonsports.com%2FParagon%2FShop%3FDSP%3D40000%26PCR%
3D1%3A102%3A1055%3A10427%26IID%3D5-315016%26E1SRC%3DCJ%26E1PRM%3DNIGHTLY</buyUrl>

                  <catalogId>cjo:655</catalogId>

                  <currency>USD</currency>

                  <description xmlns="http://product.lucene.service.cj.com">Celebrate a quarter century of basketball greatness. The men's Nike Air Force 2007 Supreme Shoe is the culmination of 25 years of Air Force, with all the plush sophistication and dynamic response of the Air Force legacy in a progressive, modern package.</description>

                  <imageUrl>http://www.paragonsports.com/Paragon/images/medium/5-315016_blackred_pd.jpg</imageUrl>

                  <inStock/>

                  <isbn />

                  <manufacturerName>Nike</manufacturerName>

                  <manufacturerSku/>

                  <name>Nike Air Force 25 Supreme - Mens</name>

                  <price>175.0</price>

                  <retailPrice>175.0</retailPrice>

                  <salePrice>0.0</salePrice>

                  <sku>5-31516</sku>

                  <upc />

               </ns1:Product>

 

Use Case #2

A user would like to list all of the product links for Nike basketball shoes with prices between $100 and $200 US Dollars from a specific advertiser (CID 123456). The user would like to see the records sorted by price in ascending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

websiteId

Your Web site ID (PID), which much match the Web site PID you used to register your developer key (Required).

advertiserIds

123456

keywords

basketball shoes

manufactuerName

Nike

currency

USD

lowPrice

100

highPrice

200

sortBy

price

sortOrder

asc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://product.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:search>

         <developerKey></developerKey>

         <api:websiteId>12345</api:websiteId>

         <api:advertiserIds>123456</api:advertiserIds>

         <api:keywords>basketball shoes</api:keywords>

         <api:serviceableArea>US</api:serviceableArea>

         <api:upc></api:upc>

         <api:manufacturerName>nike</api:manufacturerName>

         <api:manufacturerSku></api:manufacturerSku>

         <api:advertiserSku></api:advertiserSku>

         <api:lowPrice>100</api:lowPrice>

         <api:highPrice>200</api:highPrice>

         <api:lowSalePrice></api:lowSalePrice>

         <api:highSalePrice></api:highSalePrice>

         <api:currency>USD</api:currency>

         <api:isbn></api:isbn>

         <api:sortBy>price</api:sortBy>

         <api:sortOrder>asc</api:sortOrder>

         <api:startAt></api:startAt>

         <api:maxResults>100</api:maxResults>

      </api:search>

   </soapenv:Body>

</soapenv:Envelope>

Response

<ns1:Product>

                  <adId>160261</adId>

                  <advertiserId>123456</advertiserId>

                  <advertiserName>Paragon Sports</advertiserName>

                  <buyUrl>http://www.kqzyfj.com/click-12345-10360261?url=http%3A%2F%2Fwww.paragonsports.com%2FParagon%2FShop%3FDSP%3D40000%26PCR%
3D1%3A102%3A1055%3A10427%26IID%3D5-315836%26E1SRC%3DCJ%26E1PRM%3DNIGHTLY</buyUrl>

                  <catalogId>cjo:655</catalogId>

                  <currency>USD</currency>

                  <description>The Nike Shox Spotlight basketball shoe provides a new flavor for the baller in summertime basketball looking for something new on and off the court. Seamless suede upper with full-grain leather wrap for maximum durability</description>

                  <imageUrl>http://www.paragonsports.com/Paragon/images/medium/5-315835_whitebluerose_pd.jpg</imageUrl>

                  <inStock />

                  <isbn />

                  <manufacturerName>Nike</manufacturerName>

                  <manufacturerSku />

                  <name >Nike Shox Spotlight - Mens</name>

                  <price>100.0</price>

                  <retailPrice>100.0</retailPrice>

                  <salePrice>0.0</salePrice>

                  <sku x>5-31536</sku>

                  <upc />

               </ns1:Product>

 

Use Case #3

A user would like to list all product links for external hard drives on sale with sale prices between $50 and $100 US Dollars from all advertisers. The user would like to see the records sorted by manufacturer name in ascending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

websiteId

Your Web site ID (PID), which much match the Web site PID you used to register your developer key (Required).

keywords

external hard drive

currency

USD

lowSaleprice

50

highSaleprice

100

sortBy

manufacturerName

sortOrder

asc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://product.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:search>

         <developerKey></developerKey>

         <api:websiteId>12345</api:websiteId>

         <api:advertiserIds></api:advertiserIds>

         <api:keywords>external hard drive</api:keywords>

         <api:serviceableArea></api:serviceableArea>

         <api:upc></api:upc>

         <api:manufacturerName></api:manufacturerName>

         <api:manufacturerSku></api:manufacturerSku>

         <api:advertiserSku></api:advertiserSku>

         <api:lowPrice></api:lowPrice>

         <api:highPrice></api:highPrice>

         <api:lowSalePrice>50</api:lowSalePrice>

         <api:highSalePrice>100</api:highSalePrice>

         <api:currency>USD</api:currency>

         <api:isbn></api:isbn>

         <api:sortBy>manufacturerName</api:sortBy>

         <api:sortOrder>asc</api:sortOrder>

         <api:startAt></api:startAt>

         <api:maxResults>100</api:maxResults>

      </api:search>

   </soapenv:Body>

</soapenv:Envelope>

Response

<ns1:Product>

                  <adId>4497</adId>

                  <advertiserId>147</advertiserId>

                  <advertiserName>Newegg.com</advertiserName>

                  <buyUrl>http://www.jdoqocy.com/click-12345-10440897?url=http%3A%2F%2Fwww.newegg.com%2FProduct%2FProduct.asp%3FItem%3DN82E16822216
001R%26ATT%3D22-216-001R%26CMP%3DAFC-C8Junction</buyUrl>

                  <catalogId>cjo:1460</catalogId>

                  <currency>USD</currency>

                  <description>acomdata PHD120U2E-54 120GB 5400 RPM USB 2.0 External Hard Drive</description>

                  <imageUrl>http://images10.newegg.com/ProductImageCompressAll200/22-216-001-02.jpg</imageUrl>

                  <inStock />

                  <isbn />

                  <manufacturerName>AcomData</manufacturerName>

                  <manufacturerSku>PHD120U2E-54</manufacturerSku>

                  <name>acomdata 120GB 2.5" External Hard Drive</name>

                  <price>87.99</price>

                  <retailPrice>0.0</retailPrice>

                  <salePrice>87.99</salePrice>

                  <sku>N82E16822216001R</sku>

                  <upc />

               </ns1:Product>