Back to Developer Center

API v1 Reference

Create Catalog

REST

Request

https://api.neoncrm.com/neonws/services/api/store/createCatalog?userSessionId=[session id]&catalog.name=Computer parts&catalog.code=Comp&catalog.descriptions=CPU,RAM,Hard drives,etc&catalog.displaySequence=3

Response

{
    "CreateCatalogResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "Catalog created.",
        "responseDateTime": "2013-02-17T16:50:22.603-06:00",
        "catalogId": 31
    }
}

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:createcatalogrequest>
            <usersessionid>T1361784723792</usersessionid>
            <catalog>
               <code>Comp</code>
                <name>Computer parts</name>
               <description>CPU,RAM,Hard drives,etc</description>
                <displaysequence>3</displaysequence>
             </catalog>
          </neon:createcatalogrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:createcatalogresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>Catalog created.</responsemessage>
         <responsedatetime>2013-02-25T03:32:08.171-06:00</responsedatetime>
         <catalogid>33</catalogid>
      </ns2:createcatalogresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
catalog.name Yes Name of the catalog.
catalog.code Catalog code.
catalog.description Description of the catalog
catalog.displaySequence Display sequence number

Response Parameters

Name Required Description
catalogId Yes The ID of the catalog.

Error Codes

Code Text Description
12001 Catalog name is required.