Skip to main content
POST

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Path Parameters

return_id
integer
required

Numeric id of the return.

Body

application/json
decision
enum<string>
required

resend creates a new order from the returned one and ships it again; cancel_forward cancels the return and releases its reserved stock.

Available options:
resend,
cancel_forward
Example:

"resend"

Response

Decision cancel_forward applied; the return is cancelled.

decision
enum<string>
required

The applied decision.

Available options:
cancel_forward
Example:

"cancel_forward"

return_id
integer
required

Id of the decided return.

Example:

98765

return_status
enum<string>
required

Lifecycle status of a return.

  • PENDING: created and waiting for a decision (review of a customer request, or decision on an order returned by the carrier).
  • REQUESTED: resolved; the customer has the return instructions and the goods are expected back.
  • ORDERED: resolved by creating a new (replacement or resend) order.
  • CANCELLED: cancelled before the goods came back; reserved stock was released.
  • ARRIVED_AT_WAREHOUSE: the package arrived at the warehouse and is waiting to be processed.
  • AWAITING_INSPECTION: the package was opened and is waiting for inspection of its contents.
  • RECEIVED: the goods were checked in and are being re-entered into inventory.
  • REENTERED: the goods were fully re-entered into inventory; the return is complete.
  • UNSUCCESSFUL: closed without receiving anything; every expected product was missing on reception.
Available options:
PENDING,
REQUESTED,
ORDERED,
CANCELLED,
ARRIVED_AT_WAREHOUSE,
AWAITING_INSPECTION,
RECEIVED,
REENTERED,
UNSUCCESSFUL
Example:

"PENDING"