List Products

Retrieve a list of products available in the store.

REST

Request

https://api.neoncrm.com/neonws/services/api/store/listProducts?userSessionId=[session id]&searchCriteria.categoryId=12

Response

{
    "ListProductsResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "2 records found.",
        "responseDateTime": "2013-02-18T00:21:07.652-06:00",
        "products": {
            "product": [
                {
                    "productId": 86,
                    "catalogs": {
                        "idNamePair": [
                            {
                                "id": 18,
                                "name": "Fall 2009"
                            },
                            {
                                "id": 17,
                                "name": "Fall 2010"
                            }
                        ]
                    },
                    "category": {
                        "id": 12,
                        "name": "Stationery"
                    },
                    "code": "code 1",
                    "name": "web service test product 1",
                    "description": "<p class="neonFieldLabel">\r\n\tweb service testing product 1</p>\r\n",
                    "unitPrice": 500,
                    "shippingRequired": true,
                    "daysToShip": 1,
                    "defaultShippingCost": 12,
                    "priceOffDiscount": 500,
                    "pounds": 2,
                    "ounces": 4,
                    "hasOptions": true,
                    "status": "Active"
                },
                {
                    "productId": 38,
                    "category": {
                        "id": 12,
                        "name": "Stationery"
                    },
                    "code": "",
                    "name": "Retractable Ballpoint Pen",
                    "description": "",
                    "unitPrice": 1,
                    "daysToShip": 5,
                    "priceOffDiscount": 1,
                    "hasOptions": false,
                    "status": "Active"
                }
            ]
        }
    }
}

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:listproductsrequest>
            <usersessionid>T1361787273065</usersessionid>
             <searchcriteria>
                <categoryid>12</categoryid>
             </searchcriteria>
          </neon:listproductsrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listproductsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>2 records found.</responsemessage>
         <responsedatetime>2013-02-25T04:15:20.244-06:00</responsedatetime>
         <products>
            <product>
               <productid>86</productid>
               <catalogs>
                  <idnamepair>
                     <id>18</id>
                     <name>Fall 2009</name>
                  </idnamepair>
                  <idnamepair>
                     <id>17</id>
                     <name>Fall 2010</name>
                  </idnamepair>
               </catalogs>
               <category>
                  <id>12</id>
                  <name>Stationery</name>
               </category>
               <code>code 1</code>
               <name>web service test product 1</name>
               <description><p class='neonFieldLabel'>
    web service testing product 1</p></description>
               <unitprice>500.0</unitprice>
               <shippingrequired>true</shippingrequired>
               <daystoship>1</daystoship>
               <defaultshippingcost>12.0</defaultshippingcost>
               <priceoffdiscount>45.0</priceoffdiscount>
               <isdiscountinpercentage>true</isdiscountinpercentage>
               <priceoffdiscountstartdate>2013-01-06-06:00</priceoffdiscountstartdate>
               <priceoffdiscountenddate>2013-01-28-06:00</priceoffdiscountenddate>
               <pounds>2</pounds>
               <ounces>4.0</ounces>
               <hasoptions>true</hasoptions>
               <status>Active</status>
            </product>
            <product>
               <productid>38</productid>
               <category>
                  <id>12</id>
                  <name>Stationery</name>
               </category>
               <name>Retractable Ballpoint Pen</name>
               <description>
                   <unitprice>1.0</unitprice>
                   <daystoship>5</daystoship>
                   <priceoffdiscount>0.09</priceoffdiscount>
                   <isdiscountinpercentage>true</isdiscountinpercentage>
                   <priceoffdiscountstartdate>2013-01-06-06:00</priceoffdiscountstartdate>
                   <priceoffdiscountenddate>2013-01-28-06:00</priceoffdiscountenddate>
                   <hasoptions>false</hasoptions>
                   <status>Active</status>
                </description>
            </product>
         </products>
     </ns2:listproductsresponse>
  </soap:body>
</soap:envelope>

Request Parameters

Name	Required	Description
searchCriteria.categoryId	Yes	Possible values can be retrieved from the List Categories method.
searchCriteria.catalogId		Possible values can be retrieved form the List Catalogs method.
searchCriteria.code		Product Code
searchCriteria.name		Product Name
searchCriteria.description		Product Description
searchCriteria.keyword		Product Search Keywords

Response Parameters

Name	Required	Description
product.productId	Yes
product.name	Yes
product.unitPrice	Yes
product.priceOffDiscount
product.isDiscountInPercentage		Possible values: true, false
product.catalogs.idNamePair.id		Possible values can be retrieved from the List Catalogs method.
product.catalogs.idNamePair.name		Possible values can be retrieved from the List Catalogs method.
product.category.idNamePair.id		Possible values can be retrieved from the List Categories method.
product.category.idNamePair.name		Possible values can be retrieved from the List Categories method.
product.code
product.description
product.shippingRequired		Possible values: true, false
product.daysToShip
product.defaultShippingCost
product.pounds
product.ounces
product.hasOptions		Possible values: true, false
product.status		Possible values: Active, Inactive, Deleted
product.imageUrl
product.imageLabel

Error Codes

Code	Text	Description
12003	Catalog id is invalid.
12102	Category Id is invalid.
12103	Category Id is required.
12104	Category code is required.	You must include the parameter “searchCriteria.categoryId” in your request.