Retrieve Shopping Cart Summary

Retrieve a summary of the contents of a shopping cart. This can be done at any stage of a purchase.

REST

Request

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

Response

{
    "retrieveShoppingCartSummaryResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "Shopping cart retrieved.",
        "responseDateTime": "2013-02-22T02:20:04.199-06:00",
        "shoppingCart": {
            "shoppingCartId": 55595,
            "shoppingCartItems": {
                "shoppingCartItem": [
                    {
                        "sequenceId": 0,
                        "itemInfo": {
                            "unitPrice": 300,
                            "itemType": "Donation",
                            "donation": {
                                "accountId": 123958,
                                "amount": 300,
                                "purpose": {
                                    "id": 12,
                                    "name": "Research"
                                },
                                "campaign": {
                                    "id": 249,
                                    "name": "$5 Support a Kid"
                                },
                                "fund": {
                                    "id": 11,
                                    "name": "Benefit Concert"
                                },
                                "status": "Succeed",
                                "donorName": "Jason10 Weng",
                                "date": "2013-02-20-06:00",
                                "acknowledgee": {
                                    "name": "Andrew Jones"
                                },
                                "customFieldDataList": {
                                    "customFieldData": {
                                        "fieldId": 603,
                                        "fieldOptionId": 2295
                                    }
                                },
                                "solicitation": {
                                    "id": 6,
                                    "name": "Proposal"
                                }
                            }
                        },
                        "quantity": 1
                    },
                    {
                        "sequenceId": 1,
                        "itemInfo": {
                            "unitPrice": 360,
                            "itemType": "Membership",
                            "membership": {
                                "accountId": 123958,
                                "membershipTerm": {
                                    "termInfo": {
                                        "id": 505,
                                        "name": "320 individual group 1"
                                    },
                                    "isParentTerm": true
                                },
                                "source": {
                                    "id": 43,
                                    "name": "Web"
                                },
                                "customFieldDataList": {
                                    "customFieldData": {
                                        "fieldId": 317,
                                        "fieldOptionId": 1732
                                    }
                                },
                                "membershipId": 134,
                                "membershipName": "320 individual group 1",
                                "termDuration": "1YEAR",
                                "fee": 360,
                                "transactionDate": "2013-02-22T01:50:31.880-06:00",
                                "termStartDate": "2013-09-01-05:00",
                                "termEndDate": "2014-08-31-05:00",
                                "enrollmentType": "JOIN"
                            }
                        },
                        "quantity": 1
                    },
                    {
                        "sequenceId": 2,
                        "product": {
                            "productId": 86,
                            "category": {
                                "id": 12,
                                "name": "Stationery"
                            },
                            "code": "code 1",
                            "name": "web service test product 1",
                            "description": "<p class="neonFieldLabel">rntweb service testing product 1</p>rn",
                            "unitPrice": 500,
                            "shippingRequired": true,
                            "daysToShip": 1,
                            "defaultShippingCost": 12,
                            "priceOffDiscount": 9,
                            "isDiscountInPercentage": true,
                            "imageUrl": "https://xyx.com/images/testImage.pdf",
                            "imageLabel": "web service test product 1",
                            "hasOptions": true,
                            "status": "Active"
                        },
                        "quantity": 1,
                        "selectedOptions": {
                            "option": {
                                "optionId": 40,
                                "name": "test option 2",
                                "optionValues": {
                                    "optionValue": {
                                        "optionValueId": 106,
                                        "name": "test option choice 1",
                                        "priceAdjustment": -5
                                    }
                                }
                            }
                        }
                    }
                ]
            },
            "accountId": 123958,
            "shippingAddress": {
                "isPrimaryAddress": false,
                "isShippingAddress": true,
                "shippingDeliverTo": "xiao ma",
                "addressLine1": "11/27 hercules ST",
                "state": {
                    "code": "IL",
                    "name": "ILLINOIS"
                },
                "country": {
                    "id": 1,
                    "name": "united states"
                },
                "zipCode": 610000
            },
            "shippingHandlingFee": 10,
            "shippingHandlingMethod": "UPS Ground",
            "discounts": {
                "nameValuePairs": {
                    "nameValuePair": [
                        {
                            "name": "priceOff",
                            "value": 50
                        },
                        {
                            "name": "discountName",
                            "value": "Buy $100.00 and get $50.00 off"
                        },
                        {
                            "name": "freeShipping",
                            "value": false
                        }
                    ]
                }
            },
            "itemsCount": 3,
            "totalDiscount": 50,
            "subTotal": 1110,
            "taxAmount": 403.28,
            "totalCharge": 1473.28
        }
    }
}

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

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:retrieveshoppingcartsummaryresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>Shopping cart retrieved.</responsemessage>
         <responsedatetime>2013-02-25T21:54:23.423-06:00</responsedatetime>
         <shoppingcart>
            <shoppingcartid>55604</shoppingcartid>
            <shoppingcartitems>
               <shoppingcartitem>
                  <sequenceid>0</sequenceid>
                  <product>
                     <productid>78</productid>
                     <category>
                        <id>5</id>
                        <name>Apparel</name>
                     </category>

                     <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>
                  <quantity>1</quantity>
                  <selectedoptions>
                     <option>
                        <optionid>37</optionid>
                        <name>T-shirt Sizes (Child/Adult)</name>
                        <optionvalues>
                           <optionvalue>
                              <optionvalueid>100</optionvalueid>
                              <name>Adult</name>
                              <priceadjustment>5.0</priceadjustment>
                           </optionvalue>
                        </optionvalues>
                     </option>
                  </selectedoptions>
               </shoppingcartitem>
               <shoppingcartitem>
                  <sequenceid>1</sequenceid>
                  <iteminfo>
                     <unitprice>360.0</unitprice>
                     <itemtype>Membership</itemtype>
                     <membership>
                        <accountid>123952</accountid>
                        <membershipterm>
                           <terminfo>
                              <id>505</id>
                              <name>320 individual group 1</name>
                           </terminfo>
                           <isparentterm>true</isparentterm>
                        </membershipterm>
                        <autorenewal>false</autorenewal>
                        <source>
                           <id>43</id>
                           <name>Web</name>

                        <customfielddatalist>
                           <customfielddata>
                              <fieldid>317</fieldid>
                              <fieldoptionid>1731</fieldoptionid>
                           </customfielddata>
                        </customfielddatalist>
                        <membershipid>134</membershipid>
                        <membershipname>320 individual group 1</membershipname>
                        <termduration>1YEAR</termduration>
                        <fee>360.0</fee>
                        <transactiondate>2013-02-25T21:52:27.183-06:00</transactiondate>
                        <termstartdate>2013-09-01-05:00</termstartdate>
                        <termenddate>2014-08-31-05:00</termenddate>
                        <enrollmenttype>JOIN</enrollmenttype>
                     </membership>
                  </iteminfo>
                  <quantity>1</quantity>
               </shoppingcartitem>
               <shoppingcartitem>
                  <sequenceid>2</sequenceid>
                  <iteminfo>
                     <unitprice>200.0</unitprice>
                     <itemtype>Donation</itemtype>
                     <donation>
                        <accountid>123952</accountid>
                        <amount>200.0</amount>
                        <purpose>
                           <id>12</id>
                           <name>Research</name>
                        </purpose>
                        <campaign>
                           <id>249</id>
                           <name>$5 Support a Kid</name>
                        </campaign>
                        <fund>
                           <id>11</id>
                           <name>Benefit Concert</name>
                        </fund>
                        <status>Succeed</status>
                        <donorname>Jason6 Weng</donorname>
                        <date>2013-02-25-06:00</date>
                        <acknowledgee>
                           <name>Xiao Ma</name>
                           <email>xma@z2systems.com</email>
                           <address>
                              <addressline1>41/82 walson street</addressline1>
                              <city>Chicago</city>
                              <state>
                                 IL
                                 <name>ILLINOIS</name>
                              </state>
                              <country>
                                 <id>1</id>
                                 <name>united states</name>
                              </country>
                              <zipcode>60000</zipcode>
                           </address>
                        </acknowledgee>
                        <source>
                           <id>43</id>
                           <name>Web</name>

                        <solicitation>
                           <id>6</id>
                           <name>Proposal</name>
                        </solicitation>
                     </donation>
                  </iteminfo>
                  <quantity>1</quantity>
               </shoppingcartitem>
            </shoppingcartitems>
            <accountid>123952</accountid>
            <shippingaddress>
               <isprimaryaddress>false</isprimaryaddress>
               <isshippingaddress>true</isshippingaddress>
               <shippingdeliverto>Xiao Ma</shippingdeliverto>
               <addressline1>1/304 Geroge Street</addressline1>
               <city>Chicago</city>
               <state>
                  IL
                  <name>ILLINOIS</name>
               </state>
               <country>
                  <id>1</id>
                  <name>united states</name>
               </country>
               <zipcode>60</zipcode>
            </shippingaddress>
            <shippinghandlingfee>10.0</shippinghandlingfee>
            <shippinghandlingmethod>FedEx 2-Day Air</shippinghandlingmethod>
            <discounts>
               <namevaluepairs>
                  <namevaluepair>
                     <name>priceOff</name>
                     <value>50.0</value>
                  </namevaluepair>
                  <namevaluepair>
                     <name>discountName</name>
                     <value>Buy $100.00 and get $50.00 off</value>
                  </namevaluepair>
                  <namevaluepair>
                     <name>freeShipping</name>
                     <value>false</value>
                  </namevaluepair>
               </namevaluepairs>
            </discounts>
            <itemscount>3</itemscount>
            <totaldiscount>50.0</totaldiscount>
            <subtotal>651.0</subtotal>
            <taxamount>50.16</taxamount>
            <totalcharge>661.16</totalcharge>
         </shoppingcart>
      </ns2:retrieveshoppingcartsummaryresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
shoppingCartId Yes Shopping cart ID

Response Parameters

Name Required Description
shoppingCartId Yes Shopping Cart ID
totalCharge Yes Total cost of shopping cart, including items, discounts, taxes, and shipping
shoppingCartItems A summary of each item included in this cart
accountId The account ID of the constituent associated with this shopping cart
shippingAddress The shipping address associated with this shopping cart
shippingHandlingFee Cost of shipping and handling for this shopping cart
shippingHandlingMethod
discounts A summary of discounts that apply to items in the shipping cart
itemsCount Total quantity of items in shopping cart
totalDiscount Total amount of discounts applying to items in the shopping cart
subTotal Total cost of items, minus any discounts
taxAmount Total amount of tax added to this shopping cart