The SalesOrder object tracks Storefront sales.
GetSalesOrder
This service is used to query the SalesOrder object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| salesOrderID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| salesOrder |
XML |
Container node. |
| adminNotes |
String |
Notes intended for store administrators. |
| affiliateID |
Integer |
The Affiliate ID tracked to the order if it originated from a referral. |
| billingCity |
String |
|
| billingCompany |
String |
|
| billingCountryCode |
String |
|
| billingCountryName |
String |
|
| billingDistrict |
String |
|
| billingEmail |
String |
|
| billingFirstName |
String |
|
| billingLastName |
String |
|
| billingPhone |
String |
|
| billingPostalCode |
String |
|
| billingStreet |
String |
|
| billingSubdivisionCode |
String |
|
| billingSubdivisionName |
String |
|
| billingUnit |
String |
|
| businessTaxNumber |
String |
Business tax number (e.g. VAT number). |
| couponCodes |
String |
Pipe delimited coupon codes. |
| createDate |
DateTime |
Creation date. |
| cultureCode |
String |
The display culture. |
| currencyCultureCode |
String |
The currency culture. |
| customerNotes |
XML Locale |
Notes intended for customer. |
| dynamicFormResult |
XML |
The result collected from DynamicForm. |
| exchangeRate |
Decimal |
The exchange rate relative to the primary currency. |
| fraudScore |
Integer |
The registered fraud score from 0 to 100 if available. |
| fraudRiskGateway |
String |
The risk gateway provider. |
| handlingAmount |
Decimal |
Handling amount. |
| handlingDiscountAmount |
Decimal |
Handling discount. |
| handlingMethodID |
Integer |
The HandlingMethod object identifier. |
| handlingTaxAmount1 |
Decimal |
|
| handlingTaxAmount2 |
Decimal |
|
| handlingTaxAmount3 |
Decimal |
|
| handlingTaxAmount4 |
Decimal |
|
| handlingTaxAmount5 |
Decimal |
|
| orderDate |
DateTime |
The order date. |
| orderLocked |
Boolean |
Lock the order to prevent customer from changing the order details when resuming an incomplete order. |
| origin |
Integer |
Where the order originated (Web Checkout = 1, System Recurring = 2). |
| packingMethodID |
Integer |
PackingMethod object identifier. |
| parentSalesOrderID |
Integer |
The parent sales order if this order belonged in a sales order set. |
| paymentIncompleteNextRetryDate |
DateTime |
Set when the next payment retry should be attempted. |
| paymentTerm |
Integer |
See PaymentTermType |
| portalID |
Integer |
|
| preferredUserPaymentID |
Integer |
|
| purchaseOrderNumber |
String |
Purchase order number. |
| rewardsPointsQualified |
Integer |
The number of rewards points earned from the purchase of this order. |
| rewardsPointsRewarded |
Integer |
The estimated number of points actually rewarded to the customer for this order so far. |
| salesOrderGUID |
GUID |
SalesOrder globally unique identifier. |
| salesOrderID |
Integer |
The object identifier. |
| salesOrderNumber |
String |
The order number shown to customer and printed on receipts. This value does not necessarily correspond to the salesOrderID identifier. |
| salesPaymentStatus |
Integer |
Sales payment status (Pending = 1, Paid = 2, Cancelled = 3, Refunded = 4). |
| sellerID |
Integer |
The seller associated with this sales order. |
| shippedDate |
DateTime |
The date the order is shipped, if available. |
| shippingAmount |
Decimal |
|
| shippingCity |
String |
|
| shippingCompany |
String |
|
| shippingCountryCode |
String |
|
| shippingCountryName |
String |
|
| shippingDestinationPoint |
String |
The pickup point code if this is a pickup service. |
| shippingDiscountAmount |
Decimal |
|
| shippingDistrict |
String |
|
| shippingEmail |
String |
|
| shippingExtension |
XML |
Extra information related to shipping. |
| shippingFirstName |
String |
|
| shippingLabelFile |
String |
The shipping label file name or absolute URL if label is stored externally. |
| shippingLabelType |
String |
Shipping label mime type. e.g. application/pdf |
| shippingLastName |
String |
|
| shippingMethodID |
Integer |
ShippingMethod object identifier. |
| shippingPackages |
XML |
The packing result. |
| shippingPhone |
String |
|
| shippingPostalCode |
String |
|
| shippingQuoted |
Boolean |
Indicates if the shipping amount requires quoting. |
| shippingStatus |
Integer |
Shipping status (Not Required = 1, Not Shipped = 2, Shipped = 3, Undeliverable = 4). |
| shippingStreet |
String |
|
| shippingSubdivisionCode |
String |
|
| shippingSubdivisionName |
String |
|
| shippingTaxAmount1 |
Decimal |
|
| shippingTaxAmount2 |
Decimal |
|
| shippingTaxAmount3 |
Decimal |
|
| shippingTaxAmount4 |
Decimal |
|
| shippingTaxAmount5 |
Decimal |
|
| shippingTrackingCode |
String |
Shipping tracking code. |
| shippingUnit |
String |
|
| shippingUniversalServiceName |
String |
The globally unique name generated by the system that corresponds to the shipping gateway's service name used internally to match a real-time shipping method. |
| status |
Integer |
Sales order status (Pending = 1, Ordered = 2, Processing = 3, Completed = 4, Cancelled = 5, Declined = 6, Incomplete = 7) |
| subTotalAmount |
Decimal |
Sub-total. |
| taxAmount1 |
Decimal |
|
| taxAmount2 |
Decimal |
|
| taxAmount3 |
Decimal |
|
| taxAmount4 |
Decimal |
|
| taxAmount5 |
Decimal |
|
| taxDiscountAmount |
Decimal |
|
| totalAmount |
Decimal |
|
| updateDate |
DateTime |
Update date. |
| userAgent |
String |
|
| userHostAddress |
String |
User IP address. |
| userID |
Integer |
UserID object identifier. |
| warehouseID |
Integer |
The warehouse associated to this sales order. |
GetSalesOrderBySalesOrderNumber
This service is used to get the SalesOrder object belonging to the portal.
Request Parameters
| Node |
Required |
Data Type |
Description |
| salesOrderNumber |
Yes |
String |
The order number shown to customer and printed on receipts. |
Return Data
Same as GetSalesOrder service return data.
GetSalesOrders
This service is used to get all the SalesOrder objects belonging to the portal.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| skip |
No |
Integer |
The number of records to skip over for paging purposes. |
| take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
| Node |
Data Type |
Description |
| totalCount |
Integer |
Number of records found. |
| salesOrders |
XML |
Container node |
| salesOrder |
XML |
Zero or more salesOrder nodes with same data structure as GetSalesOrder service return data. |
GetSalesOrdersByDateRange
This service is used to get all the SalesOrder objects belonging to the portal by date range.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| skip |
No |
Integer |
The number of records to skip over for paging purposes. |
| startDate |
Yes |
DateTime |
Start date. |
| stopDate |
Yes |
DateTime |
Stop date. |
| take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
| Node |
Data Type |
Description |
| totalCount |
Integer |
Number of records found. |
| salesOrders |
XML |
Container node |
| salesOrder |
XML |
Zero or more salesOrder nodes with same data structure as GetSalesOrder service return data. |
UpdateSalesOrder
This service is used to update a SalesOrder object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| preferredUserPaymentID |
No |
Integer |
The payment to use for collecting payment if unpaid. |
| salesOrderID |
Yes |
Integer |
The object identifier. |
| salesPaymentStatus |
Yes |
Integer |
Pending = 1, Paid = 2, Cancelled = 3, Refunded = 4 |
| shippingStatus |
Yes |
Integer |
NotRequired = 1, NotShipped = 2, Shipped = 3, Undeliverable = 4 |
| shippingTrackingCode |
No |
String |
The shipping tracking code for the order. Leave empty if none. |
| status |
Yes |
Integer |
Pending = 1, Ordered = 2, Processing = 3, Completed = 4, Cancelled = 5, Declined = 6, Incomplete = 7 |
Return Data
Same as GetSalesOrder service return data.
ProcessIncompleteSalesPayment
This service is used to process any missing payment for a sales order. The sales order must be in one of the following statuses (Ordered/Pending) and the payment status must be either (Incomplete/Declined). The sales order must also have a valid PreferredUserPaymentID set.
Request Parameters
| Node |
Required |
Data Type |
Description |
| salesOrderID |
Yes |
Integer |
The object identifier of the sales order to process. |
Return Data
None.