ReturnOrders
Create a return
Create a return by items. Return line statuses and conditions can be specified. If an item is in an existing return and has not active rentals, the endpoint updates the return line. If the item has multiple active rentals, the rental ID must be specified (return rental IDs with error).
POST
/
return_orders
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
id
integer
requiredNumeric ID of the return.
createdAt
string
requiredcreditStatus
enum<string>
requiredAvailable options:
uncredited
, partially_recredited
, recredited
customer
object
requiredreturnLines
object[]
requiredrequestedAt
string | null
sequentialId
integer
requiredSequential ID of the return.
status
enum<string>
requiredStatus of the return.
Available options:
requested
, expected
, received
, in_progress
, completed
, cancelled