> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # List RMAs (return merchandise authorizations) > Returns a paginated list of customer return (RMA) records for the entity. Supports filtering by `account_id`, `status` (open / inspected / closed / cancelled), `date_range`, full-text `search`, and `location_id` (Layer 4 warehouse isolation). Results are cursor-paginated using `next_cursor`. Requires `returns:read` scope. ## OpenAPI ````yaml /openapi.yaml get /returns openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /returns: get: tags: - Returns summary: List RMAs (return merchandise authorizations) description: > Returns a paginated list of customer return (RMA) records for the entity. Supports filtering by `account_id`, `status` (open / inspected / closed / cancelled), `date_range`, full-text `search`, and `location_id` (Layer 4 warehouse isolation). Results are cursor-paginated using `next_cursor`. Requires `returns:read` scope. operationId: listReturns parameters: - name: status in: query schema: type: string enum: - authorized - expected - received - inspecting - restocked - written_off - closed - sent_to_vendor - cancelled - name: account_id in: query schema: type: string format: uuid - name: original_order_id in: query schema: type: string format: uuid - name: search in: query schema: type: string - name: location_id in: query schema: type: string format: uuid description: > Filter to a single warehouse location (Layer 4 isolation). Resolved from the `X-Location-Id` request header first, then this query param. Returns whose originating order has NULL `location_id`, or returns with no `original_order_id`, remain visible (NULL-universal). Returns with no origin-order match are excluded. - name: expand[] in: query schema: type: array items: type: string enum: - items - refunds - original_order - gl_entries - return_label - vendor_return style: form explode: true - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/StartingAfter' responses: '200': description: Paginated list of RMAs content: application/json: schema: type: object properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/Return' has_more: type: boolean '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: parameters: Limit: name: limit in: query required: false description: | Maximum number of records to return per page. Default 25, max 500. Use together with starting_after for cursor pagination. For larger bulk extraction workflows prefer the migration endpoints. schema: type: integer minimum: 1 maximum: 500 default: 25 StartingAfter: name: starting_after in: query required: false description: | Cursor for pagination. Pass the id of the last record from the previous page to fetch the next page. Mutually exclusive with ending_before. schema: type: string maxLength: 200 schemas: Return: type: object description: >- RMA (return merchandise authorization). Phase A -- refund_amount is readOnly via PATCH; written only by POST /v1/returns/{id}/refund. properties: id: type: string format: uuid object: type: string enum: - return entity_id: type: string format: uuid readOnly: true return_number: type: string readOnly: true status: type: string enum: - authorized - expected - received - inspecting - restocked - written_off - closed - sent_to_vendor - cancelled readOnly: true description: >- Use action endpoints to transition status; PATCH cannot write status. original_order_id: type: string format: uuid account_id: type: string format: uuid vendor_id: type: string format: uuid nullable: true vendor_rma_number: type: string nullable: true inspection_required: type: boolean restocking_fee: type: number nullable: true refund_amount: type: number nullable: true readOnly: true description: >- SSOT: written only by POST /v1/returns/{id}/refund (refundReturn canonical). PATCH cannot write this field. return_to_vendor: type: boolean source: type: string enum: - csr - customer_portal - marketplace nullable: true notes: type: string nullable: true metadata: type: object nullable: true received_at: type: string format: date-time nullable: true readOnly: true closed_at: type: string format: date-time nullable: true readOnly: true cancelled_at: type: string format: date-time nullable: true readOnly: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````