Sitecore OrderCloud Documentation

docs

Portal Login

Get a single order return.

GET

/orderreturns/{returnID}

200

Roles

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

FullAccessOrderAdminShopperOrderReader

Parameters

NameTypeDescriptionPossible Values
returnIDRequiredstringID of the return.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
OrderIDstring---------
PaymentIDsRead Onlyarray---------

StatusRead Onlystring------Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled
DateCreatedRead Onlystringdate-time------
DateSubmittedRead Onlystringdate-time------

DateApprovedRead Onlystringdate-time------
DateDeclinedRead Onlystringdate-time------
DateCanceledRead Onlystringdate-time------
DateCompletedRead Onlystringdate-time------

LastUpdatedRead Onlystringdate-time------
RefundAmountnumberfloat------
Commentsstring---2000 characters---
ItemsToReturnarray---------
xpobject---------

Get a single order return.

GET

/orderreturns/{returnID}

200

Roles

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

FullAccessOrderAdminShopperOrderReader

Parameters

NameTypeDescriptionPossible Values
returnIDRequiredstringID of the return.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
OrderIDstring---------
PaymentIDsRead Onlyarray---------

StatusRead Onlystring------Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled
DateCreatedRead Onlystringdate-time------
DateSubmittedRead Onlystringdate-time------

DateApprovedRead Onlystringdate-time------
DateDeclinedRead Onlystringdate-time------
DateCanceledRead Onlystringdate-time------
DateCompletedRead Onlystringdate-time------

LastUpdatedRead Onlystringdate-time------
RefundAmountnumberfloat------
Commentsstring---2000 characters---
ItemsToReturnarray---------
xpobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore