v41

latestOpenAPI 3.0.0UNLICENSEDraw.githubusercontent.com2026-07-0839165177.6 KB

Returns

Create return

Create a return for a completed order. Whole-order returns only — the order's line items are enumerated for you. The return is submitted for approval and then progresses asynchronously toward the refund; poll the returned return id (or listen for webhooks) to follow its state.

post/api/v1/returns

Request body

Reason a shopper is returning an order, supplied on the create-return call: defective (arrived damaged or faulty), wrong_item (not what was ordered), unwanted (changed their mind), color / size_too_large / size_too_small / style (wrong color, size, or style), not_as_described (differs from the listing), and other (anything else).

orderIdstring required

Rye order id (order_<32 hex>) of the order being returned.

Response

Created

updatedAtstring date-time required

When the Return record was last updated.

createdAtstring date-time required

When the Return record was created.

checkoutIntentIdstring required

Rye checkout intent id that produced the order being returned.

orderIdstring required

Rye order id (order_<32 hex>) this Return was opened against.

Lifecycle state of a Return:

requested — submitted to the merchant, awaiting approval.
requires_action — approved; the shopper must ship the items back.
processing — approved and in flight (items shipped, or no shipping required), awaiting the refund.
refunded — terminal; the refund has been issued and reconciled.
denied — terminal; the merchant declined the return.
failed — terminal; the return could not be completed.

idstring required

Rye return id (ret_<32 hex>).

Example response

{
  "refunds": [
    {
      "shopperRefundTotal": {
        "currencyCode": "USD",
        "amountSubunits": 1500
      }
    }
  ]
}