API v1 Reference

Create Category

REST

Request

https://api.neoncrm.com/neonws/services/api/store/createCategory?userSessionId=[session id]&category.code=BK1&category.name=Book&category.description=novel&category.displaySequence=13

Response

{
    "CreateCategoryResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "Category created.",
        "responseDateTime": "2013-02-17T20:27:09.732-06:00",
        "categoryId": 15
    }
}

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:createcategoryrequest>
             <usersessionid>T1361784723792</usersessionid>
            <category>
                <code>BK2</code>
                <name>Book</name>
               <description>some books</description>
                <displaysequence>19</displaysequence>
             </category>
          </neon:createcategoryrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:createcategoryresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>Category created.</responsemessage>
         <responsedatetime>2013-02-25T03:36:32.531-06:00</responsedatetime>
         <categoryid>16</categoryid>
      </ns2:createcategoryresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
category.code Yes
category.name Yes
category.description
category.displaySequence

Response Parameters

Name Required Description
category.categoryId Yes

Error Codes

Code Text Description
12101 Category name is required.
12104 Category code is required.