> ## 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. # Create customer return > Create a new customer return against an existing sales order. Use `transaction_type` to control whether a refund order is generated alongside the return: - `return-only` (default): just the return order - `refund-only`: refund only, no return order - `return-and-refund`: both, linked Returns are created in `Pending` status. Call `PATCH /returns/{id}/receive` to mark them received and (optionally) restock inventory. ## OpenAPI ````yaml /api-reference/build.yaml post /returns 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: Purchase Orders description: Get and modify purchase orders - 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: /returns: post: tags: - Customer Returns summary: Create customer return description: > Create a new customer return against an existing sales order. Use `transaction_type` to control whether a refund order is generated alongside the return: - `return-only` (default): just the return order - `refund-only`: refund only, no return order - `return-and-refund`: both, linked Returns are created in `Pending` status. Call `PATCH /returns/{id}/receive` to mark them received and (optionally) restock inventory. operationId: createReturn requestBody: required: true content: application/json: schema: type: object required: - sales_order_id - items properties: sales_order_id: type: integer order_date: type: string format: date nullable: true is_posted: type: integer enum: - 0 - 1 nullable: true description: Optional. When `1`, the return is created already received. restock: type: boolean nullable: true description: >- When true, inventory is restocked on receive (default behavior). transaction_type: type: string enum: - return-only - refund-only - return-and-refund nullable: true items: type: array minItems: 1 items: type: object required: - sales_order_item_id - quantity properties: sales_order_item_id: type: integer quantity: type: number minimum: 0.001 uom_id: type: integer nullable: true location_id: type: integer nullable: true lot_id: type: integer nullable: true lot_number: type: string nullable: true description: >- Lot number for the returned item (used when the product has lot tracking enabled). lot_name: type: string nullable: true description: Alias for `lot_number`. responses: '201': description: Created content: application/json: schema: type: object properties: data: type: object description: >- A customer return for a sales order — return-only, refund-only, or return-and-refund. Status is `Pending` until received, then `Received`. properties: id: type: integer sales_order_id: type: integer description: >- ID of the originating sales order. For return-and-refund flows the resolved sales order ID is read through the parent refund order. status: type: string enum: - Pending - Received restock: type: boolean description: >- When true, receiving the return puts stock back into inventory; false means stock is not adjusted (`skip_inventory` internally). order_date: type: string format: date nullable: true transaction_type: type: string enum: - return-only - return-and-refund description: >- Resolved from the parent order — return orders linked to a refund order surface as `return-and-refund`. created_at: type: string format: date-time updated_at: type: string format: date-time items: type: array description: Present when `orderItems` is loaded. items: type: object properties: id: type: integer sales_order_item_id: type: integer description: Originating sales order line ID. sku: type: string nullable: true quantity: type: number location_id: type: integer nullable: true lot_id: type: integer nullable: true lot_number: type: string nullable: true description: >- Lot number for the returned item (used on create when the product has lot tracking enabled; resolved to an existing lot, or created if missing). lot_name: type: string nullable: true description: Alias for `lot_number`. '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string '422': description: Validation error 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. ````