The SalesOrderDetail object tracks individual sales items within a sales order.
GetSalesOrderDetail
This service is used to query the SalesOrderDetail object.
Request Parameters
Node |
Required |
Data Type |
Description |
salesOrderDetailID |
Yes |
Integer |
The object identifier. |
Return Data
Node |
Data Type |
Description |
salesOrderDetail |
XML |
Container node. |
adminNotes |
String |
Notes visible to the store administrator only. |
basePrice |
Decimal |
|
bookingStartDate |
DateTime |
The starting date for a booked order in UTC time zone. |
bookingStopDate |
DateTime |
The stopping date for a booked order in UTC time zone. |
createDate |
DateTime |
|
depth |
Decimal |
|
discountAmount |
Decimal |
|
dynamicFormResult |
XML |
|
handlingPrice |
Decimal |
|
height |
Decimal |
|
packageType |
Integer |
Package type for shipping calculation (Unspecified = 1, Envelope = 1000, Box = 2000, Bag = 3000, Tube = 4000). |
parentSalesOrderDetailID |
Integer |
Indicates if this SalesOrderDetail item is a product part and child of a parent SalesOrderDetail object usually in a bundled product scenario. |
price |
Decimal |
|
priceLocked |
Boolean |
Indicate if the prices are locked from changes. |
productCost |
Decimal |
|
productName |
XML Locale |
Localized product name. |
productPartID |
Integer |
References the ProductPart identifier usually from a bundled product purchase. |
productVariantExtension |
XML |
|
productVariantID |
Integer |
ProductVariant object identifier. |
productVariantName |
XML Locale |
Localized product variant name. |
quantity |
Integer |
|
recurringInterval |
Integer |
The recurring interval. |
recurringIntervalType |
Integer |
The interval type (Day = 1, Week = 2, Month = 3, Year = 4). |
recurringSalesOrderID |
Integer |
The associated RecurringSalesOrder object identifier if this SalesOrderDetail object was created from a recurring order. |
requireShipping |
Boolean |
Indicate if product requires shipping. |
salesOrderDetailID |
Integer |
The object identifier. |
salesOrderID |
Integer |
The associated SalesOrder object identifier. |
shippingPrice |
Decimal |
|
shippingStatus |
Integer |
Shipping status (Not Required = 1, Not Shipped = 2, Shipped = 3, Undeliverable = 4). |
sku |
String |
|
status |
Integer |
Order detail status (Pending = 1, Ordered = 2, Processing = 3, Completed = 4, Quoted = 9) |
taxAmount1 |
Decimal |
|
taxAmount2 |
Decimal |
|
taxAmount3 |
Decimal |
|
taxAmount4 |
Decimal |
|
taxAmount5 |
Decimal |
|
updateDate |
DateTime |
Update date. |
weight |
Decimal |
|
width |
Decimal |
|
GetSalesOrderDetails
This service is used to get all the SalesOrderDetail objects belonging to the SalesOrder.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
salesOrderID |
Yes |
Integer |
The SalesOrder object identifier. |
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. |
salesOrderDetailDetails |
XML |
Container node |
salesOrderDetail |
XML |
Zero or more salesOrderDetail nodes with same data structure as GetSalesOrderDetail service return data. |
UpdateSalesOrderDetail
This service is used to update a SalesOrderDetail object.
Request Parameters
Node |
Required |
Data Type |
Description |
salesOrderDetailID |
Yes |
Integer |
The object identifier. |
shippingStatus |
Yes |
Integer |
NotRequired = 1, NotShipped = 2, Shipped = 3, Undeliverable = 4 |
status |
Yes |
Integer |
Pending = 1, Ordered = 2, Processing = 3, Completed = 4, Quoted = 9 |
Return Data
Same as GetSalesOrderDetail service return data.