List Shipping Methods

This method retrieves a list of shipping methods available for this purchase. The items in the shopping cart and the shipping address influence the costs and which methods are available.

REST

Request

https://api.neoncrm.com/neonws/services/api/store/listShippingMethods?userSessionId=[session id]&shoppingCartId=55603

Response

{
    "listShippingMethodsResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "Shipping methods retrieved.",
        "responseDateTime": "2013-02-20T21:18:06.441-06:00",
        "shippingMethods": {
            "shippingMethod": [
                {
                    "shippingMethodId": "Other||DHL",
                    "shippingMethodName": "DHL",
                    "fee": 20
                },
                {
                    "shippingMethodId": "Other||FedEx 2-Day Air",
                    "shippingMethodName": "FedEx 2-Day Air",
                    "fee": 35
                },
                {
                    "shippingMethodId": "Other||Fedex Ground",
                    "shippingMethodName": "Fedex Ground",
                    "fee": 25
                },
                {
                    "shippingMethodId": "Other||Processing Fee:",
                    "shippingMethodName": "Processing Fee:",
                    "fee": 5
                },
                {
                    "shippingMethodId": "Other||UPS Express",
                    "shippingMethodName": "UPS Express",
                    "fee": 28
                },
                {
                    "shippingMethodId": "Other||UPS Ground",
                    "shippingMethodName": "UPS Ground",
                    "fee": 50
                },
                {
                    "shippingMethodId": "Other||USPS Ground",
                    "shippingMethodName": "USPS Ground",
                    "fee": 20
                }
            ]
        }
    }
}

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:listshippingmethodsrequest>
            <usersessionid>T1361848390916</usersessionid>
             <shoppingcartid>55603</shoppingcartid>
          </neon:listshippingmethodsrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listshippingmethodsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>Shipping methods retrieved.</responsemessage>
         <responsedatetime>2013-02-25T21:43:04.040-06:00</responsedatetime>
         <shippingmethods>
            <shippingmethod>
               <shippingmethodid>Other||DHL</shippingmethodid>
               <shippingmethodname>DHL</shippingmethodname>
               <fee>12.0</fee>
            </shippingmethod>
            <shippingmethod>
               <shippingmethodid>Other||FedEx 2-Day Air</shippingmethodid>
               <shippingmethodname>FedEx 2-Day Air</shippingmethodname>
               <fee>30.0</fee>
            </shippingmethod>
            <shippingmethod>
               <shippingmethodid>Other||Fedex Ground</shippingmethodid>
               <shippingmethodname>Fedex Ground</shippingmethodname>
               <fee>20.0</fee>
            </shippingmethod>
            <shippingmethod>
               <shippingmethodid>Other||Processing Fee:</shippingmethodid>
               <shippingmethodname>Processing Fee:</shippingmethodname>
               <fee>5.0</fee>
            </shippingmethod>
            <shippingmethod>
               <shippingmethodid>Other||UPS Express</shippingmethodid>
               <shippingmethodname>UPS Express</shippingmethodname>
               <fee>20.0</fee>
            </shippingmethod>
            <shippingmethod>
               <shippingmethodid>Other||UPS Ground</shippingmethodid>
               <shippingmethodname>UPS Ground</shippingmethodname>
               <fee>4.0</fee>
            </shippingmethod>
            <shippingmethod>
               <shippingmethodid>Other||USPS Ground</shippingmethodid>
               <shippingmethodname>USPS Ground</shippingmethodname>
               <fee>10.0</fee>
            </shippingmethod>
         </shippingmethods>
      </ns2:listshippingmethodsresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
shoppingCartId Yes Shopping cart ID

Response Parameters

Name Required Description
shippingMethod.shippingMethodId Yes
shippingMethod.shippingMethodName Yes
shippingMethod.fee Yes

Error Codes

Code Text Description
12301 Shopping cart id is required.
12302 Shopping cart id is invalid.
12316 There is no shipping address in this shopping cart