Sitecore OrderCloud Documentation

docs

Portal login

Get a list of order returns.

GET

/orderreturns

200

Roles

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

FullAccessOrderAdminShopperOrderReader

Parameters

NameTypeDescriptionPossible Values
approvablebooleanOnly returns orders awaiting the user's approval if true.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, OrderID
sortByarrayComma-delimited list of fields to sort by.DateSubmitted, DateCreated, ID, OrderID, DateApproved, DateDeclined, DateCanceled, DateCompleted, LastUpdated, !DateSubmitted, !DateCreated, !ID, !OrderID, !DateApproved, !DateDeclined, !DateCanceled, !DateCompleted, !LastUpdated
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---------
Metaobject---------
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore