Sitecore Ordercloud

List shipments for an order

GET
/orders/{direction}/{orderID}/shipments

Roles

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

FullAccess
OrderAdmin
ShipmentReader

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, BuyerID, Shipper, DateShipped, DateDelivered, TrackingNumber
sortByarrayComma-delimited list of fields to sort by.DateShipped, OwnerID, ID, BuyerID, Shipper, DateDelivered, Cost, !DateShipped, !OwnerID, !ID, !BuyerID, !Shipper, !DateDelivered, !Cost
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---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------
FromAddress
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---------
ToAddress
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---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------
NextPageKeystring---------