Retrieve Product

Retrieve details about a specific store product.

REST

Request

https://api.neoncrm.com/neonws/services/api/store/retrieveProduct?userSessionId=[session id]&productId=78

Response

{
    "RetrieveProductResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2013-02-18T02:37:34.699-06:00",
        "product": {
            "productId": 78,
            "category": {
                "id": 5,
                "name": "Apparel"
            },
            "code": "",
            "name": "T-shirt",
            "description": "<p class="neonFieldLabel">\r\n\tThis is a T-shirt.</p>\r\n",
            "unitPrice": 100,
            "shippingRequired": true,
            "priceOffDiscount": 10,
            "priceOffDiscountStartDate": "2013-01-05-06:00",
            "priceOffDiscountEndDate": "2013-01-19-06:00",
            "hasOptions": true,
            "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:retrieveproductrequest>
             <usersessionid>T1361790282286</usersessionid>
            <productid>78</productid>
          </neon:retrieveproductrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:retrieveproductresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsedatetime>2013-02-25T05:17:34.818-06:00</responsedatetime>
         <product>
            <productid>78</productid>
            <category>
               <id>5</id>
               <name>Apparel</name>
            </category>
            <code></code>
            <name>T-shirt</name>
            <description><p class='neonFieldLabel'>
    This is a T-shirt.</p></description>
            <unitprice>100.0</unitprice>
            <shippingrequired>true</shippingrequired>
            <priceoffdiscount>9.0</priceoffdiscount>
            <isdiscountinpercentage>true</isdiscountinpercentage>
            <hasoptions>true</hasoptions>
            <status>Active</status>
         </product>
     </ns2:retrieveproductresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name	Required	Description
product.productId	Yes

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
12201	Product id is required.
12202	Product id is invalid.