v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Returns

Update Return Status

Update return status.

Certain status transitions trigger additional side effects to maintain data consistency:

  • Setting status to complete will also mark all return items as complete.
  • Setting status to open from complete or rejected will reopen the return, resetting all processed/rejected items back to open, clearing pending processing info, resetting the expiration date, and marking the return as reopened. Note: Reopening a processed return does not reverse any refunds, exchanges, or other actions that were performed during processing.

Requires the returns_write scope.

put/returns/{returnId}/status

Path parameters

returnIdstring required
Example:64e4d5e837572a4813b73e40

Return ID

Request body

status'complete' | 'open' | 'flagged' | 'rejected' | 'deleted' required

Return status.

  • complete: The return has been completed successfully.
  • open: Return has been approved and is awaiting shipment.
  • flagged: A problem with return processing requires merchant action.
  • rejected: The return has been rejected.
  • deleted: The return has been reset.

Example request

{
  "status": "open"
}

Response

Updated