Skip to main content
PATCH
Cancel a pending return

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.

Response

The return, now cancelled.

Response of PATCH /returns/{return_id}/cancel.

id
integer
required

Unique id of the return.

Example:

98765

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"

return_type
enum<string>
required

What kind of return this is.

  • TO_BE_DETERMINED: requested by the customer or by you, not yet reviewed; the outcome (simple return, exchange, rejection) is decided later.
  • SIMPLE_RETURN: the customer sends the goods back; no replacement is shipped.
  • EXCHANGE: the customer sends the goods back and replacement items (exchange_products) are reserved to ship once the return arrives.
  • IMMEDIATE_EXCHANGE: replacement items ship right away, before the return arrives (created from the Cubbo app, not through this API).
  • RETURNED_BY_CARRIER: the carrier could not deliver the order and brought it back; decide it with POST /returns/{return_id}/decision.
  • UNIDENTIFIED: a package arrived at the warehouse that could not be matched to an order (created by warehouse staff).
Available options:
TO_BE_DETERMINED,
SIMPLE_RETURN,
EXCHANGE,
IMMEDIATE_EXCHANGE,
RETURNED_BY_CARRIER,
UNIDENTIFIED
Example:

"TO_BE_DETERMINED"

resolved_at
string<date-time>
required

When the return was cancelled.

Example:

"2026-10-12T16:00:00.000Z"

created_at
string<date-time>
required

When the return was created.

Example:

"2026-10-12T15:04:05.123Z"