Sitecore Ordercloud

Get a list of line items

GET
/orders/{direction}/{orderID}/lineitems

Roles

At least one of the roles below is required to access this endpoint

FullAccess
OrderAdmin
Shopper
OrderReader

Parameters

NameTypeDescriptionPossible Values
directionstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDstringID of the order.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, ProductID
sortByarrayComma-delimited list of fields to sort by.DateAdded, ID, ProductID, !DateAdded, !ID, !ProductID
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
ProductIDstring---------
Quantityintegerint32------
DateAdded
Read Only
stringdate-time------
QuantityShipped
Read Only
integerint32------

UnitPricenumberfloat------

PromotionDiscount
Read Only
numberfloat------

LineTotal
Read Only
numberfloat------

LineSubtotal
Read Only
numberfloat------

CostCenterstring---------

DateNeededstringdate-time------
ShippingAccountstring---------

ShippingAddressIDstring---------
ShipFromAddressIDstring---------

Product
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
Name
Read Only
string---------
Description
Read Only
string---------
Returnable
Read Only
boolean---------
QuantityMultiplier
Read Only
integerint32------
ShipWeight
Read Only
numberfloat------
ShipHeight
Read Only
numberfloat------
ShipWidth
Read Only
numberfloat------
ShipLength
Read Only
numberfloat------
DefaultSupplierID
Read Only
string---------
xp
Read Only
object---------
Variant
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
Name
Read Only
string---------
Description
Read Only
string---------
ShipWeight
Read Only
numberfloat------
ShipHeight
Read Only
numberfloat------
ShipWidth
Read Only
numberfloat------
ShipLength
Read Only
numberfloat------
xp
Read Only
object---------
ShippingAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------
ShipFromAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------
SupplierID
Read Only
string---------
InventoryRecordIDstring---------

PriceScheduleID
Read Only
string---------

PriceOverridden
Read Only
boolean---------

Specsarray---------
PropertyTypeFormatMax LengthPossible Values
SpecIDstring---------
Name
Read Only
string---------
OptionIDstring---------
Valuestring---2000 characters---
PriceMarkupTypestring------NoMarkup, AmountPerQuantity, AmountTotal, Percentage
PriceMarkupnumberfloat------
xpobject---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------
NextPageKeystring---------