Measura API documentation · v1

List order returns

Read durable Measura API return operation receipts for one order.

Code example

GET /api/v1/orders/{orderId}/returns

Headers:
  Authorization: Bearer <api-key>
  Content-Type: application/json

Path parameters

Scroll horizontally to see all columns.

Parameter	Type	Description
`orderId`	string	Required — Numeric Shopify order legacy (REST) ID; do not send a GraphQL GID.

Query parameters

Scroll horizontally to see all columns.

Parameter	Type	Description
`limit`	integer	Optional — 1–100 operations per page. Default 25; values outside this range return 400.
`cursor`	string	Optional — Opaque meta.nextCursor from the previous operation-history response.

Response example (200 success)

Code example

{
  "success": true,
  "data": {
    "returns": [
      {
        "id": "123e4567-e89b-42d3-a456-426614174000",
        "kind": "order_return",
        "resourceId": "1234567890",
        "status": "processing",
        "phase": "validating",
        "createdAt": "2026-10-19T00:00:00Z",
        "updatedAt": "2026-10-19T00:00:00Z"
      }
    ]
  },
  "error": null,
  "meta": {
    "nextCursor": null,
    "hasMore": false
  }
}

Response fields

Scroll horizontally to see all columns.

Field	Type	Description
`data.returns`	array	Operation receipts, newest first by creation time and operation ID.
`meta.nextCursor`	string \| null	Opaque next-page cursor; null when no further page exists.
`meta.hasMore`	boolean	Whether another page exists.

Error responses

Scroll horizontally to see all columns.

Status code	Description
400	bad_request — Invalid order ID, limit, or operation cursor.
405	method_not_allowed — Only GET is supported; Allow: GET.
401	unauthorized — Missing or invalid API key.
403	forbidden — The Order edit add-on is not ACTIVE for this shop.
500	internal_error — The request could not be processed.

Note

Requires the active Order edit add-on. Responses are scoped to the authenticated shop, order, and operation kind, and use Cache-Control: no-store.
History contains durable public API operations, including processing and failed operations. It is not a complete Shopify return history.
Fetch the matching detail route using a receipt id to inspect snapshots, saved results, or errors. A requires_review receipt needs reconciliation before another write to this order.

Get order return Create order return

Operation receipt fields

Scroll horizontally to see all columns.

Field	Type	Description
`id`	string	Durable operation UUID. This is editId or returnId in the detail path.
`kind / resourceId`	string	order_edit or order_return, and the Shopify order legacy ID.
`status`	string	processing, completed, rejected, or requires_review.
`phase`	string	validating, applying, or finished.
`createdAt / updatedAt`	string	ISO-8601 operation timestamps.
`snapshot`	object	Optional — Before-state and original request saved before mutation.
`result`	object	Optional — Completed write result (order, lineMappings, paymentSettlement, and return-specific fields).
`error`	object	Optional — Recorded {code, message, details?} for an unsuccessful operation.