Process a return

Process the refunds of one or several items associated to the return, and change the return state to "approved".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the return in CMS.

Body Params

Return items to be processed.

items
array of objects
required

List of items being returned.

items*
boolean

Indicates whether the refund was processed manually.

boolean

Indicates whether we want to force processing a child return from a non fully processed parent order.

boolean

Whether the return should be processed (refunds, CMS, notifications) when all items are decided. When false, only the item state (status, amount, motive) is persisted without processing. Defaults to true for backward compatibility.

number

Indicates the amount to be added as extra if the payment method is storeCredit.

Responses

401

Unauthorized

404

Return not found

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json