Retrieve Order Details
Retrieve a summary of a completed order.
REST
Request
https://api.neoncrm.com/neonws/services/api/store/retrieveOrderDetails?userSessionId=[session id]&orderId=55595
Response
{
"RetrieveOrderDetailsResponse": {
"operationResult": "SUCCESS",
"responseDateTime": "2013-02-22T03:33:49.984-06:00",
"order": {
"orderId": 55595,
"orderDate": "2013-02-22T00:00:00.000-06:00",
"shoppingCart": {
"shoppingCartId": 55595,
"shoppingCartItems": {
"shoppingCartItem": [
{
"sequenceId": 0,
"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-22T00:00:00.000-06:00",
"termStartDate": "2013-09-01-05:00",
"termEndDate": "2014-08-31-05:00",
"enrollmentType": "JOIN"
}
},
"quantity": 1
},
{
"sequenceId": 1,
"itemInfo": {
"unitPrice": 300,
"itemType": "Donation",
"donation": {
"createdDateTime": "2013-02-22T02:52:54.000-06:00",
"createdBy": "Administrator ",
"lastModifiedDateTime": "2013-02-22T02:52:54.000-06:00",
"lastModifiedBy": "Administrator ",
"donationId": 41733,
"accountId": 123958,
"amount": 300,
"purpose": {
"id": 12,
"name": "Research"
},
"campaign": {
"id": 249,
"name": "$5 Support a Kid"
},
"fund": {
"id": 11,
"name": "Benefit Concert"
},
"status": "Pending",
"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": 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,
"imageUrl": "https://xyx.com/images/testImage.pdf",
"imageLabel": "web service test product 1",
"hasOptions": false,
"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": {
"isShippingAddress": false,
"shippingDeliverTo": "xiao ma",
"addressLine1": "11/27 hercules ST",
"city": "",
"state": {
"code": "IL",
"name": "ILLINOIS"
},
"country": {
"id": 1,
"name": "United States"
},
"zipCode": 610000
},
"shippingHandlingFee": 10,
"shippingHandlingMethod": "UPS Ground",
"discounts": {
"nameValuePairs": {
"nameValuePair": [
{
"name": "discountName",
"value": "Buy $100.00 and get $50.00 off"
},
{
"name": "priceOff",
"value": 50
},
{
"name": "id",
"value": 275
},
{
"name": "freeShipping",
"value": false
}
]
}
},
"itemsCount": 3,
"totalDiscount": 50,
"subTotal": 1110,
"taxAmount": 403.28,
"totalCharge": 1473.28
},
"transaction": {
"transactionId": 55595,
"transactionStatus": "Pending",
"payments": {
"payment": {
"paymentId": 44091,
"amount": 1473.28,
"paymentStatus": "Pending",
"note": "shopping cart payment",
"tenderType": {
"id": 4,
"name": "Credit Card(Online)"
},
"creditCardOnlinePayment": {
"cardNumber": "************9236",
"expirationMonth": 9,
"expirationYear": 15,
"cardType": {
"code": "v",
"name": ""
},
"cardHolder": "Dark Smith",
"billingAddressLine1": "14/349 Geoge Street",
"city": "Chicago",
"state": {
"code": "IL"
},
"country": {
"id": 1,
"name": "United States"
},
"zipCode": 60009
}
}
}
}
}
}
}
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:retrieveorderdetailsrequest>
<usersessionid>T1361857093088</usersessionid>
<orderid>55606</orderid>
</neon:retrieveorderdetailsrequest>
</soapenv:body>
</soapenv:header>
</soapenv:envelope>
Response
<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:body>
<ns2:retrieveorderdetailsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
<operationresult>SUCCESS</operationresult>
<responsedatetime>2013-02-25T23:51:35.122-06:00</responsedatetime>
<order>
<orderid>55606</orderid>
<orderdate>2013-02-25T00:00:00.000-06:00</orderdate>
<shoppingcart>
<shoppingcartid>55606</shoppingcartid>
<shoppingcartitems>
<shoppingcartitem>
<sequenceid>0</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>
<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-25T00:00:00.000-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>1</sequenceid>
<iteminfo>
<unitprice>200.0</unitprice>
<itemtype>Donation</itemtype>
<donation>
<createddatetime>2013-02-25T23:47:56.000-06:00</createddatetime>
<createdby>Administrator</createdby>
<lastmodifieddatetime>2013-02-25T23:47:56.000-06:00</lastmodifieddatetime>
<lastmodifiedby>Administrator</lastmodifiedby>
<donationid>41738</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>Pending</status>
<donorname>Jason6 Weng</donorname>
<date>2013-02-25-06:00</date>
<acknowledgee>
<name>Xiao Ma</name>
<email>xma@z2systems.com</email>
<address>
<addressid>76176</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>
<shoppingcartitem>
<sequenceid>2</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>
<hasoptions>false</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>
</shoppingcartitems>
<accountid>123952</accountid>
<shippingaddress>
<isshippingaddress>false</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>discountName</name>
<value>Buy $100.00 and get $50.00 off</value>
</namevaluepair>
<namevaluepair>
<name>priceOff</name>
<value>50.0</value>
</namevaluepair>
<namevaluepair>
<name>id</name>
<value>277</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>
<transaction>
<transactionid>55606</transactionid>
<transactionstatus>Pending</transactionstatus>
<payments>
<payment>
<paymentid>44097</paymentid>
<amount>661.16</amount>
<paymentstatus>Pending</paymentstatus>
<note>paid by ralf</note>
<tendertype>
<id>4</id>
<name>Credit Card(Online)</name>
</tendertype>
<creditcardonlinepayment>
<cardnumber>************9236</cardnumber>
<expirationmonth>10</expirationmonth>
<expirationyear>16</expirationyear>
<cardtype>
V
<name>Visa</name>
</cardtype>
<cardholder>Morgan</cardholder>
<billingaddressline1>98/827 mars ST</billingaddressline1>
<city>Chicago</city>
<state>
IL
</state>
<country>
<id>1</id>
<name>United States</name>
</country>
<zipcode>60980</zipcode>
</creditcardonlinepayment>
</payment>
</payments>
</transaction>
</order>
</ns2:retrieveorderdetailsresponse>
</soap:body>
</soap:envelope>
Request Parameters
| Name | Required | Description |
|---|---|---|
| orderId | Yes | Order ID. Orders can be retrieved from the List Orders API method. |
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 |
Error Codes
| Code | Text | Description |
|---|---|---|
| 12402 | Order id is required. | |
| 12403 | Order id is invalid. |