List Orders

Retrieve a list of orders. Search either by account ID or the date of the order.

REST

Request

https://api.neoncrm.com/neonws/services/api/store/listOrders?userSessionId=[session id]&accountId=123958&orderDateFrom=2013-01-05

Response

{
    "ListOrdersResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2013-02-22T03:53:10.410-06:00",
        "orders": {
            "order": [
                {
                    "orderId": 55569,
                    "orderDate": "2013-01-17T00:02:00.000-06:00",
                    "shoppingCart": {
                        "shoppingCartId": 55569,
                        "shoppingCartItems": {
                            "shoppingCartItem": {
                                "sequenceId": 0,
                                "itemInfo": {
                                    "unitPrice": 0,
                                    "itemType": "Membership",
                                    "membership": {
                                        "accountId": 123958,
                                        "membershipTerm": {
                                            "termInfo": {
                                                "id": 505,
                                                "name": "320 individual group 1"
                                            },
                                            "isParentTerm": true
                                        },
                                        "source": {
                                            "id": 51,
                                            "name": "Your Custom Selection"
                                        },
                                        "customFieldDataList": {
                                            "customFieldData": {
                                                "fieldId": 625,
                                                "fieldValue": "customer field 1"
                                            }
                                        },
                                        "membershipId": 134,
                                        "membershipName": "320 individual group 1",
                                        "termDuration": "1YEAR",
                                        "fee": 360,
                                        "transactionDate": "2013-02-17T00:00:00.000-06:00",
                                        "termStartDate": "2015-09-01-05:00",
                                        "termEndDate": "2016-08-31-05:00",
                                        "enrollmentType": "JOIN"
                                    }
                                },
                                "quantity": 1
                            }
                        },
                        "accountId": 123958,
                        "shippingHandlingFee": 0,
                        "itemsCount": 1,
                        "subTotal": 0,
                        "taxAmount": 0,
                        "totalCharge": 360
                    },
                    "transaction": {
                        "transactionId": 55569,
                        "transactionStatus": "Succeed",
                        "payments": {
                            "payment": {
                                "paymentId": 44073,
                                "amount": 360,
                                "paymentStatus": "Succeed",
                                "note": "cash payment",
                                "tenderType": {
                                    "id": 1,
                                    "name": "Cash"
                                }
                            }
                        }
                    }
                },
                ...
            ]
        },
        "page": {
            "currentPage": 2,
            "pageSize": 5,
            "totalPage": 3,
            "totalResults": 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:listordersrequest>
            <usersessionid>T1361857093088</usersessionid>
            <accountid>123952</accountid>
          </neon:listordersrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listordersresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsedatetime>2013-02-26T00:02:25.258-06:00</responsedatetime>
         <orders>
            <order>
               <orderid>55605</orderid>
               <orderdate>2013-01-25T00:02:00.000-06:00</orderdate>
               <shoppingcart>
                  <shoppingcartid>55605</shoppingcartid>
                  <shoppingcartitems>
                     <shoppingcartitem>
                        <sequenceid>0</sequenceid>
                        <iteminfo>
                           <unitprice>200.0</unitprice>
                           <itemtype>Donation</itemtype>
                           <donation>
                              <createddatetime>2013-02-25T23:40:23.000-06:00</createddatetime>
                              <createdby>Administrator</createdby>
                              <lastmodifieddatetime>2013-02-25T23:40:23.000-06:00</lastmodifieddatetime>
                              <lastmodifiedby>Administrator</lastmodifiedby>
                              <donationid>41737</donationid>
                              <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>
                                    <addressid>76175</addressid>
                                    <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>
                              <customfielddatalist>
                              <source>
                                 <id>43</id>
                                 <name>Web</name>

                              <solicitation>
                                 <id>6</id>
                                 <name>Proposal</name>
                              </solicitation>
                           </customfielddatalist></donation>
                        </iteminfo>
                        <quantity>1</quantity>
                     </shoppingcartitem>
                  </shoppingcartitems>
                  <accountid>123952</accountid>
                  <shippinghandlingfee>0.0</shippinghandlingfee>
                  <itemscount>1</itemscount>
                  <subtotal>200.0</subtotal>
                  <taxamount>0.0</taxamount>
                  <totalcharge>200.0</totalcharge>
               </shoppingcart>
               <transaction>
                  <transactionid>55605</transactionid>
                  <transactionstatus>Succeed</transactionstatus>
                  <payments>
                     <payment>
                        <paymentid>44096</paymentid>
                        <amount>200.0</amount>
                        <paymentstatus>Succeed</paymentstatus>
                        <note>test payment</note>
                        <tendertype>
                           <id>1</id>
                           <name>Cash</name>
                        </tendertype>
                     </payment>
                  </payments>
               </transaction>
            </order>
            ...
         </orders>
         <page>
            <currentpage>1</currentpage>
            <pagesize>20</pagesize>
            <totalpage>1</totalpage>
            <totalresults>3</totalresults>
         </page>
      </ns2:listordersresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
accountId Search for orders by account ID
orderDateFrom Search for orders starting with a specific date. Format: yyyy-mm-dd
page.currentPage
page.pageSize
page.totalPage
page.totalResults
page.sortColumn
page.sortDirection

Response Parameters

Name Required Description
orderId Yes Order ID
orderDate Yes Format: 2013-02-22T00:00:00.000-06:00
shoppingCart.shoppingCartId Yes Shopping Cart ID
shoppingCart.shoppingCartItems A summary of each item included in this cart
shoppingCart.accountId The account ID of the constituent associated with this shopping cart
shoppingCart.shippingAddress The shipping address associated with this shopping cart
shoppingCart.shippingHandlingFee Cost of shipping and handling for this shopping cart
shoppingCart.shippingHandlingMethod
shoppingCart.discounts A summary of discounts that apply to items in the shipping cart
shoppingCart.itemsCount Total quantity of items in shopping cart
shoppingCart.totalDiscount Total amount of discounts applying to items in the shopping cart
shoppingCart.subTotal Total cost of items, minus any discounts
shoppingCart.taxAmount Total amount of tax added to this shopping cart
shoppingCart.totalCharge Yes Total cost of shopping cart, including items, discounts, taxes, and shipping
transaction.transactionId Yes Transaction ID
transaction.transactionStatus Yes Possible values: Pending, Processing, Succeed, Declined, Error, Scheduled, Cancelled, Deferred
transaction.payments Yes A summary of the payment details for this order
page.currentPage
page.pageSize
page.totalPage
page.totalResults

Error Codes

Code Text Description
10132 Account Id is invalid