Measura API documentation · v1

Get order return

Inspect a single durable Measura API return operation, including its status and saved outcome.

Code example

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

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.
`returnId`	string	Required — UUID operationId returned by the write, or id from operation history. Do not use shopifyReturnId.

Response example (200 success)

Code example

{
  "success": true,
  "data": {
    "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
}

Response fields

Scroll horizontally to see all columns.

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

Error responses

Scroll horizontally to see all columns.

Status code	Description
400	bad_request — Invalid numeric order ID.
404	not_found — Invalid operation UUID, unknown receipt, or a receipt outside this shop/order/operation kind.
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. Cache-Control: no-store ensures current receipt state is returned.
HTTP 200 means the receipt was found. Inspect data.status; a found rejected or requires_review operation is still returned with HTTP 200.
processing means execution is not terminal. completed has the saved result. rejected means execution was rejected before possible mutation. requires_review means changes or receipt persistence are uncertain; reconcile before starting another write.
Retry a lost write response with the identical body and original Idempotency-Key to replay its saved outcome. The detail id identifies the operation; it is not the original caller-provided key.

List order returns Get order details