v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Returns

Process Return

BETA: This endpoint is in beta and subject to change.

Trigger processing of a return with specified products.

Requires the returns_write scope.

post/returns/{returnId}/process

Request body

customerNotesstring

Notes to send to customer. These can be rejection notes or processing notes.

Example request

{
  "products": [
    {
      "_id": "64e4d5e837572a4813b73e41"
    }
  ]
}

Response

Processing request completed

messagestring

Status message

Example response

{
  "message": "Processing triggered successfully"
}