> ## 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. # Place a manual hold on an order > Places a manual hold on an order (`is_on_hold: true`, `hold_type: 'manual'`). Stamps `held_at`, records `held_by`, logs a `hold_placed` timeline event, writes a `HOLD_PLACED` activity log entry, and fires an `order.hold_placed` broadcast. API callers may only place holds with `hold_type: 'manual'`. The `credit_limit` hold type is set automatically by `POST /v1/orders/{id}/confirm` when the account exceeds its credit limit and is not settable via this endpoint. Guards: - Order must exist and belong to the entity (Layer 1) - Order must not already be on hold (400 `already_on_hold`) - Order must not be in a terminal status: `cancelled`, `archived` (422 `terminal_status`) - `hold_reason` is required A `user_id` is required for the audit trail. API key callers may pass `user_id` in the body; if omitted, the API key's owner user is used as the held-by actor. Idempotent via `Idempotency-Key` header. Requires `orders:write` scope. **Industry parallels:** - Shopify Admin GraphQL `orderHold` mutation (manual reason required) - NetSuite "Place on Credit Hold" per-order override ## OpenAPI ````yaml /openapi.yaml post /orders/{id}/hold 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: /orders/{id}/hold: parameters: - name: id in: path required: true schema: type: string format: uuid description: UUID of the order to place on hold. post: tags: - Orders summary: Place a manual hold on an order description: > Places a manual hold on an order (`is_on_hold: true`, `hold_type: 'manual'`). Stamps `held_at`, records `held_by`, logs a `hold_placed` timeline event, writes a `HOLD_PLACED` activity log entry, and fires an `order.hold_placed` broadcast. API callers may only place holds with `hold_type: 'manual'`. The `credit_limit` hold type is set automatically by `POST /v1/orders/{id}/confirm` when the account exceeds its credit limit and is not settable via this endpoint. Guards: - Order must exist and belong to the entity (Layer 1) - Order must not already be on hold (400 `already_on_hold`) - Order must not be in a terminal status: `cancelled`, `archived` (422 `terminal_status`) - `hold_reason` is required A `user_id` is required for the audit trail. API key callers may pass `user_id` in the body; if omitted, the API key's owner user is used as the held-by actor. Idempotent via `Idempotency-Key` header. Requires `orders:write` scope. **Industry parallels:** - Shopify Admin GraphQL `orderHold` mutation (manual reason required) - NetSuite "Place on Credit Hold" per-order override operationId: holdOrder parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - hold_reason properties: hold_reason: type: string description: >- Human-readable reason for placing the hold. Required for the audit trail. example: Pending credit review with finance team. user_id: type: string format: uuid description: >- UUID of the user placing the hold. Required for audit trail; defaults to API key owner if omitted. example: hold_reason: Pending credit review with finance team. user_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 responses: '200': description: Hold placed successfully. content: application/json: schema: type: object properties: data: type: object properties: success: type: boolean order_id: type: string format: uuid hold_type: type: string enum: - manual hold_reason: type: string '400': $ref: '#/components/responses/Error' description: Order already on hold, missing hold_reason, or missing user_id. '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' description: Order is in a terminal status (cancelled or archived). security: - ApiKeyAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: | Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. schema: type: string maxLength: 255 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' schemas: 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 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. ````