> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Reverse (unallocate) an allocation peg > Reverse a single allocation peg created by the Purchase-to-Order workflow (the inverse of `POST /purchase-orders/{purchaseOrderId}/allocate`), freeing the pegged stock so it reposts as available against the incoming purchase order / on-hand supply. The peg is identified by `peg_id` alone — on-hand and pre-order pegs are not tied to a purchase order, so this is a top-level path rather than a PO-scoped one. Behavior depends on how far the allocation has progressed: - **Pure reservation** (nothing released) — the peg is deleted and availability recovers automatically. - **Pre-ship fulfillment** — the generated fulfillment order (or just this line's contribution to a consolidated fulfillment order) is unwound, returning the stock, then the peg is deleted. - **Already shipped** — cannot be reversed here; the request fails with `422` and the allocation must instead be reversed through a **Return**. If only part of the allocation shipped, the unfulfilled remainder is removed and the shipped portion is retained (`partial: true`). > **Note:** This endpoint is gated by the `PURCHASE_TO_ORDER` feature flag. Contact Luminous to > have it enabled for your tenant. ## OpenAPI ````yaml /api-reference/build.yaml post /purchase-orders/reverse-allocation openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Fulfillment Priority Lists description: Configure fulfillment routing priority lists - name: Purchase Orders description: Get and modify purchase orders - name: Supplier Portal description: >- Read a supplier's response to a purchase order and control the one-click portal link - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /purchase-orders/reverse-allocation: post: tags: - Purchase Orders summary: Reverse (unallocate) an allocation peg description: > Reverse a single allocation peg created by the Purchase-to-Order workflow (the inverse of `POST /purchase-orders/{purchaseOrderId}/allocate`), freeing the pegged stock so it reposts as available against the incoming purchase order / on-hand supply. The peg is identified by `peg_id` alone — on-hand and pre-order pegs are not tied to a purchase order, so this is a top-level path rather than a PO-scoped one. Behavior depends on how far the allocation has progressed: - **Pure reservation** (nothing released) — the peg is deleted and availability recovers automatically. - **Pre-ship fulfillment** — the generated fulfillment order (or just this line's contribution to a consolidated fulfillment order) is unwound, returning the stock, then the peg is deleted. - **Already shipped** — cannot be reversed here; the request fails with `422` and the allocation must instead be reversed through a **Return**. If only part of the allocation shipped, the unfulfilled remainder is removed and the shipped portion is retained (`partial: true`). > **Note:** This endpoint is gated by the `PURCHASE_TO_ORDER` feature flag. Contact Luminous to > have it enabled for your tenant. operationId: reversePurchaseOrderAllocation requestBody: required: true content: application/json: schema: type: object required: - peg_id properties: peg_id: type: integer minimum: 1 description: ID of the allocation peg to reverse example: 33012 examples: reverse_peg: summary: Reverse an allocation peg value: peg_id: 33012 responses: '200': description: Allocation reversed content: application/json: schema: type: object properties: data: type: object properties: removed: type: boolean description: >- Whether the peg was fully removed (false when only a shipped-partial remainder was trimmed) example: true foTornDown: type: boolean description: >- Whether a generated fulfillment order (or this line's contribution to one) was unwound to return the stock example: true quantityReversed: type: number format: float description: Quantity returned to available supply by the reversal example: 10 partial: type: boolean description: >- Present and `true` when only the unfulfilled remainder of a partly-shipped allocation was removed example: true shipped: type: boolean description: >- Present and `true` alongside `partial` when the retained portion had already shipped example: true '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string '422': description: > Unprocessable entity - `peg_id` missing, the allocation was not found, the `PURCHASE_TO_ORDER` feature is not enabled, or the allocation has already shipped (reverse it through a Return instead). content: application/json: schema: type: object properties: message: type: string security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````