Returns

Permission: returns (read). Filtered to the locations the key can see.

GET /v1/returns. Filters: order_id, customer_id, source (sale or online), location_id, updated_since (on creation time), limit, cursor.

GET /v1/returns/{id}

{
  "object": "return",
  "id": 310,
  "number": "R18-000012",
  "source": "sale",
  "order_id": 5521,
  "bigcommerce_order_id": null,
  "location_id": 18,
  "customer_id": 1166,
  "settlement": "refund",
  "refund_tender": "card",
  "items_cents": 2400,
  "tax_cents": 174,
  "restock_fee_cents": 0,
  "total_cents": 2574,
  "reason": "Scent not as expected",
  "lines": [
    { "object": "return_line", "id": 402, "order_line_id": 9801, "product_id": 617, "sku": "CDL-SSD-08", "description": "Sea Salt & Driftwood Soy Candle 8oz", "qty": 1, "unit_price_cents": 2400, "tax_cents": 174, "line_total_cents": 2574, "condition": "restock", "restocked": true }
  ],
  "created_at": "2026-09-25T15:02:00Z"
}

Field	Values
settlement	refund, store_credit, exchange
source	sale means a return of a POS order (order_id set); online means a BigCommerce order (bigcommerce_order_id set)
lines[].condition	restock or damaged