API v1 Reference

Add or Update Shipping Address to Shopping Cart

REST

Request

https://api.neoncrm.com/neonws/services/api/store/addOrUpdateShippingAddressToShoppingCart?userSessionId=[session id]&shoppingCartId=55583&shippingAddress.shippingDeliverTo=Joe%20Smith&shippingAddress.country.id=1&shippingAddress.zipCode=610000&shippingAddress.state.code=IL

Response

{
    "addOrUpdateShippingAddressToShoppingCartResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "Shipping Address added.",
        "responseDateTime": "2013-02-20T20:58:07.043-06:00"
    }
}

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:addorupdateshippingaddresstoshoppingcartrequest>
             <usersessionid>T1361848390916</usersessionid>
            <shoppingcartid>55603</shoppingcartid>
             <shippingaddress>
               <shippingdeliverto>Joe Smith</shippingdeliverto>
                 <addressline1>1/304 Geroge Street</addressline1>
                <city>Chicago</city>
               <state>
                   <code>IL</code>
                </state>
                <country>
                   <id>1</id>
                </country>
                <zipcode>60</zipcode>
             </shippingaddress>
          </neon:addorupdateshippingaddresstoshoppingcartrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:addorupdateshippingaddresstoshoppingcartresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>Shipping Address added.</responsemessage>
         <responsedatetime>2013-02-25T21:37:02.194-06:00</responsedatetime>
      </ns2:addorupdateshippingaddresstoshoppingcartresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
shoppingCartId Yes Shopping Cart ID
shippingAddress.shippingCompanyName
shippingAddress.shippingDeliverTo Yes Name of the person to which this purchase should be shipped.
shippingAddress.addressType.id Possible values can be retrieved from List Address Types method.
shippingAddress.addressType.name Possible values can be retrieved from List Address Types method.
shippingAddress. addressLine1
shippingAddress. addressLine2
shippingAddress. addressLine3
shippingAddress. addressLine4
shippingAddress. city
shippingAddress.state.code Possible values can be retrieved from List States method.
shippingAddress.state.name Possible values can be retrieved from List States method.
shippingAddress.province
shippingAddress.county
shippingAddress.country.id Possible values can be retrieved from List Countries method.
shippingAddress.country.name Possible values can be retrieved from List Countries method.
shippingAddress.zipCode
shippingAddress.zipCodeSuffix
shippingAddress.startDate
shippingAddress.endDate

Error Codes

Code Text Description
10130 Shopping cart id is required.
10133 Address country is invalid.
10134 Address state is invalid.
12301 Shopping cart id is required.
12302 Shopping cart id is invalid.
12313 There is no item in this shopping cart. please add shopping cart item first.
12324 No item in this shopping cart requires shipping. shipping address is not needed.