Sign in

v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Returns

Return Status

Get return status. Requires the returns_read scope.

get/returns/{returnId}/status

Path parameters

returnIdstring required
Example:64e4d5e837572a4813b73e40

Return ID

Response

Success

status'open' | 'in_transit' | 'delivered' | 'needs_review' | 'in_review' | 'complete' | 'rejected' | 'flagged' | 'pre_shipment' | 'deleted' required

Return status.

  • open: Return has been approved and is awaiting shipment.
  • in_transit: Return shipment is in transit.
  • delivered: Return shipment has been delivered and awaiting processing.
  • needs_review: Return requires review before further action.
  • in_review: Return is currently being reviewed.
  • complete: The return has been completed successfully.
  • rejected: The return has been rejected.
  • flagged: A problem with return processing requires merchant action.
  • pre_shipment: Return requires pre-shipment merchant authorization.
  • deleted: The return has been deleted (Reset).

Example response

{
  "status": "open"
}