Returns

List return export rows

Export one row per returned line item using cursor pagination. Includes return-export columns, fees, and timestamps. The cutoff filter selects by request date, not by later updates to the return.

get/api/external/v1/returns

Request

  • Base URL: http://localhost
  • URL: http://localhost/api/external/v1/returns
  • Auth: HTTP bearer

Query parameters

cutoffstring

Only include returns whose return_requested_at is on or after this date/time (ISO 8601).

Example:architecto
cursorstring

Pagination token from a previous response's meta.next_cursor.

Example:architecto
limitinteger

Rows per page (1-500, default 100).

Example:16

Request body

cutoffstring nullable

Must be a valid date.

cursorstring nullable
limitinteger nullable

Must be at least 1.

Example request

{
  "cutoff": "2026-10-13T09:06:16",
  "cursor": "architecto",
  "limit": 22
}

Response

Example response

{
  "data": [
    {
      "return_reference": "R-1042",
      "return_vendor_reference": "#R1001",
      "order_name": "#1234",
      "order_vendor_id": "987654",
      "customer_vendor_id": "456789",
      "order_line_item_vendor_id": "111",
      "order_date": "2026-06-25T10:00:00+00:00",
      "order_shipping_address_country": "Sweden",
      "order_shipping_address_country_code": "SE",
      "store_currency": "SEK",
      "order_currency": "SEK",
      "return_shipping_fee_amount": 49,
      "return_shipping_fee_currency": "SEK",
      "product_sku": "SKU-1",
      "product_category_id": "gid://shopify/TaxonomyCategory/aa-1",
      "product_category": "Shirts",
      "product_type": "T-Shirt",
      "return_source": "PANGO_RETURN_FORM",
      "return_status": "CLOSED",
      "return_requested_at": "2026-07-01T09:14:00+00:00",
      "return_started_at": "2026-06-30T08:00:00+00:00",
      "return_approved_at": "2026-07-01T10:00:00+00:00",
      "return_shipped_at": "2026-07-02T12:00:00+00:00",
      "return_dropped_off_at": "2026-07-02T11:45:00+00:00",
      "return_arrived_at_warehouse_at": "2026-07-04T07:30:00+00:00",
      "return_declined_at": null,
      "return_canceled_at": null,
      "return_closed_at": "2026-07-05T14:00:00+00:00",
      "return_created_at": "2026-06-30T08:00:00+00:00",
      "return_updated_at": "2026-07-05T14:00:00+00:00",
      "return_reason": "Did not fit -> Too big",
      "return_reason_comment": "Too large",
      "order_quantity_total": 2,
      "return_quantity_total": 1,
      "return_quantity_approved": 1,
      "return_quantity_received": 1,
      "return_quantity_refunded": 1
    }
  ],
  "meta": {
    "next_cursor": "eyJyZXF1ZXN0ZWRfYXQiOiIyMDI2LTA3LTAxIDA5OjE0OjAwIiwiaWQiOjEwNDJ9",
    "limit": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.