> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Approve a return request

> Approves only a created request and returns `AdminReturnList`, without detail-only refund or replacement data. Records resolution and pickup_required without changing requested_settlement. Monetary refunds require an eligible paid order, an available refund mode and verified outbound bank details when needed; amount and allocation are computed by the backend. Credit-line refund approvals create no monetary refund here. Replacement approval does not create a replacement order. Pickup does not gate refunds. A missing request returns 404 before body validation; invalid decisions or state return 400. When the refund can't be made at that moment (the order's payments changed since the request was checked, a payment it draws on is held for review in payment exceptions, or refunds are briefly unavailable), the request returns 409 and nothing is approved. Requires store-scoped admin authentication and the runtime `orders:returns` permission for this operation. Returned item value subtracts prorated coupon and promotion discounts and includes tax once. A mixed return creates separate cash and loyalty-point refunds; a points-only return needs no cash refund mode or bank account. Earlier requested refunds reduce the available balance even while pending. Refunds and the points-credit request are recorded atomically with approval. A refund of a cash or other offline payment in the original mode is `manual`: done at once when the store marks that payment method paid, else `pending` until an admin marks it paid or forfeits it.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json post /orders/returns/{return_number}/approve
openapi: 3.2.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Create and update products; manage their channels and category
      assignments, and list SKUs.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Variants
    description: Create, read and update product variants individually or in bulk.
    summary: Variants
    kind: nav
    parent: section-catalog
  - name: Categories
    description: Manage catalog categories and the attributes assigned to them.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Product attributes
    description: Define product attributes and the attribute sets that organize them.
    summary: Product attributes
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Read stock and inventory activity, update inventory, and record stock-in
      and stock-out movements.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read, moderate and remove product reviews.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Media
    description: >-
      Request file uploads, manage uploaded files, and organize them into
      folders.
    summary: Media
    kind: nav
    parent: section-catalog
  - name: Catalog jobs
    description: Create catalog processing jobs and follow their status.
    summary: Catalog jobs
    kind: nav
    parent: section-catalog
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Create and update customers, view their details and activity, and manage
      profile images.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Users
    description: List the users attached to a customer and activate or deactivate them.
    summary: Users
    kind: nav
    parent: section-customers
  - name: Customer attributes
    description: Define customer attributes and manage the values assigned to customers.
    summary: Customer attributes
    kind: nav
    parent: section-customers
  - name: Customer groups
    description: Configure the customer groups available in the store.
    summary: Customer groups
    kind: nav
    parent: section-customers
  - name: Addresses
    description: Read and manage a customer’s saved addresses.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: Bank accounts
    description: Read and manage a customer’s bank accounts.
    summary: Bank accounts
    kind: nav
    parent: section-customers
  - name: KYC documents
    description: Configure the store’s KYC requirements and manage customer documents.
    summary: KYC documents
    kind: nav
    parent: section-customers
  - name: Visitors
    description: >-
      Read anonymous visitor profiles, their activity and their attribute
      values.
    summary: Visitors
    kind: nav
    parent: section-customers
  - name: Loyalty
    description: >-
      Configure loyalty programs, manage membership tiers, and inspect or record
      point activity.
    summary: Loyalty
    kind: nav
    parent: section-customers
  - name: Credit
    description: Set credit-line eligibility and read customer credit balances.
    summary: Credit
    kind: nav
    parent: section-customers
  - name: Mandates
    description: >-
      Inspect customer payment mandates and debit schedules, and pause, resume
      or revoke a mandate.
    summary: Mandates
    kind: nav
    parent: section-customers
  - name: Segments
    description: >-
      Manage customer segments, their members and associated advertising
      audiences.
    summary: Segments
    kind: nav
    parent: section-customers
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: List abandoned carts for follow-up.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: Manage coupons, coupon codes and promotions, and inspect their usage.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Read and update orders, accept or cancel them, check stock, and follow
      order activity.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Invoices
    description: List order invoices and retrieve an order’s invoice or receipt.
    summary: Invoices
    kind: nav
    parent: section-orders
  - name: Returns
    description: Read customer return requests and approve or reject them.
    summary: Returns
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      Create and manage shipments, follow delivery activity, and handle
      replacements and shortfalls.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Order payments
    description: >-
      Create and inspect payment requests, verify order payments, and cancel or
      mark a payment paid.
    summary: Order payments
    kind: nav
    parent: section-payments
  - name: Refunds
    description: Estimate and issue refunds, or mark an order refund paid or forfeited.
    summary: Refunds
    kind: nav
    parent: section-payments
  - name: Payment exceptions
    description: Inspect payment exceptions and resolve them.
    summary: Payment exceptions
    kind: nav
    parent: section-payments
  - name: Payment methods
    description: Configure manual payment methods and list available payment options.
    summary: Payment methods
    kind: nav
    parent: section-payments
  - name: Seller payouts
    description: >-
      Configure seller payouts and manage invoices, adjustments, charges and
      payout batches.
    summary: Seller payouts
    kind: nav
    parent: section-payments
  - name: section-marketplace
    summary: Marketplace
    kind: nav
  - name: Marketplace catalog
    description: Inspect and publish marketplace products, variants, reviews and inventory.
    summary: Marketplace catalog
    kind: nav
    parent: section-marketplace
  - name: Marketplace listings
    description: List, synchronize and remove the store’s product listings on marketplaces.
    summary: Marketplace listings
    kind: nav
    parent: section-marketplace
  - name: Marketplace settings
    description: >-
      Read marketplace configuration and configure category schemas and
      attributes.
    summary: Marketplace settings
    kind: nav
    parent: section-marketplace
  - name: Sellers
    description: Manage the sellers a customer is authorized to buy from.
    summary: Sellers
    kind: nav
    parent: section-marketplace
  - name: section-fulfillment
    summary: Fulfillment
    kind: nav
  - name: Shipping methods
    description: Configure shipping methods and costs, and check courier serviceability.
    summary: Shipping methods
    kind: nav
    parent: section-fulfillment
  - name: Shipping boxes
    description: Manage shipping boxes and read the boxes available for a product.
    summary: Shipping boxes
    kind: nav
    parent: section-fulfillment
  - name: Shipping zones
    description: Create, read and maintain shipping zones.
    summary: Shipping zones
    kind: nav
    parent: section-fulfillment
  - name: Warehouses
    description: Create, read and maintain the store’s warehouses.
    summary: Warehouses
    kind: nav
    parent: section-fulfillment
  - name: section-point-of-sale
    summary: Point of sale
    kind: nav
  - name: Devices
    description: Manage POS devices, generate pairing codes and revoke devices.
    summary: Devices
    kind: nav
    parent: section-point-of-sale
  - name: POS users
    description: Manage staff accounts used at the point of sale.
    summary: Staff
    kind: nav
    parent: section-point-of-sale
  - name: POS roles
    description: Manage POS roles and inspect available permissions.
    summary: Roles & permissions
    kind: nav
    parent: section-point-of-sale
  - name: section-store
    summary: Store
    kind: nav
  - name: Store
    description: Read and update the store configuration.
    summary: Store
    kind: nav
    parent: section-store
  - name: Locations
    description: List countries, states and pincodes.
    summary: Locations
    kind: nav
    parent: section-store
  - name: Notifications
    description: >-
      Manage notification templates and store or customer notification
      preferences.
    summary: Notifications
    kind: nav
    parent: section-store
  - name: Downloads
    description: Request data downloads and follow download jobs.
    summary: Downloads
    kind: nav
    parent: section-store
  - name: Search
    description: Search customers, orders and products across the store.
    summary: Search
    kind: nav
    parent: section-store
  - name: Filter options
    description: >-
      Retrieve the available filters for resource lists in the administration
      interface.
    summary: Filter options
    kind: nav
    parent: section-store
  - name: section-integrations
    summary: Integrations
    kind: nav
  - name: Catalog integrations
    description: Request catalog synchronization and inspect sync results and activity.
    summary: Catalog integrations
    kind: nav
    parent: section-integrations
  - name: Service providers
    description: Configure service providers and test their connections.
    summary: Service providers
    kind: nav
    parent: section-integrations
  - name: Webhooks
    description: >-
      Manage webhook subscriptions, rotate their secrets and send test
      deliveries.
    summary: Webhooks
    kind: nav
    parent: section-integrations
  - name: Webhook deliveries
    description: >-
      Inspect webhook delivery logs, retry deliveries and replay events to a
      subscription.
    summary: Webhook deliveries
    kind: nav
    parent: section-integrations
  - name: Events
    description: >-
      Browse recorded events and the event types available for webhook
      subscriptions.
    summary: Events
    kind: nav
    parent: section-integrations
  - name: Live updates
    description: Read the store’s live event stream and global state.
    summary: Live updates
    kind: nav
    parent: section-integrations
  - name: section-analytics
    summary: Analytics
    kind: nav
  - name: Analytics
    description: Query analytics data, read charts and inspect visitor sessions and events.
    summary: Analytics
    kind: nav
    parent: section-analytics
  - name: Metrics
    description: >-
      Read aggregate metrics for catalog, customers, orders, payments,
      fulfillment and webhooks.
    summary: Metrics
    kind: nav
    parent: section-analytics
paths:
  /orders/returns/{return_number}/approve:
    parameters:
      - name: return_number
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
    post:
      tags:
        - Returns
      summary: Approve a return request
      description: >-
        Approves only a created request and returns `AdminReturnList`, without
        detail-only refund or replacement data. Records resolution and
        pickup_required without changing requested_settlement. Monetary refunds
        require an eligible paid order, an available refund mode and verified
        outbound bank details when needed; amount and allocation are computed by
        the backend. Credit-line refund approvals create no monetary refund
        here. Replacement approval does not create a replacement order. Pickup
        does not gate refunds. A missing request returns 404 before body
        validation; invalid decisions or state return 400. When the refund can't
        be made at that moment (the order's payments changed since the request
        was checked, a payment it draws on is held for review in payment
        exceptions, or refunds are briefly unavailable), the request returns 409
        and nothing is approved. Requires store-scoped admin authentication and
        the runtime `orders:returns` permission for this operation. Returned
        item value subtracts prorated coupon and promotion discounts and
        includes tax once. A mixed return creates separate cash and
        loyalty-point refunds; a points-only return needs no cash refund mode or
        bank account. Earlier requested refunds reduce the available balance
        even while pending. Refunds and the points-credit request are recorded
        atomically with approval. A refund of a cash or other offline payment in
        the original mode is `manual`: done at once when the store marks that
        payment method paid, else `pending` until an admin marks it paid or
        forfeits it.
      operationId: approve-admin-return
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnApprove'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                    example: Return request approved successfully.
                  success:
                    type: boolean
                  content:
                    properties:
                      order_return:
                        $ref: '#/components/schemas/AdminReturnList'
                    required:
                      - order_return
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            The return's refund can't be made at the moment. Nothing is
            approved.
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        The order's payments were just updated: less is left to
                        refund than this asks for. Please try again.
                      - >-
                        A payment this refund is drawn on is held for an admin
                        to resolve in payment exceptions; it cannot be refunded
                        now.
                      - >-
                        A refund waits for the payment ledger update to finish;
                        try again shortly
                  success:
                    type: boolean
                    default: false
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ReturnApprove:
      title: ReturnApprove
      description: >-
        Approve a created return. Refund value uses original item prices less
        prorated coupon and promotion discounts, with tax applied to the
        discounted amount. The returned share of redeemed loyalty points is
        refunded as points; only the remainder is cash. Each share is capped by
        its remaining refundable balance. Partial-return points use cumulative
        whole-point rounding so the final return retains the residual share.
        Replacement approval does not create a replacement order.
      type: object
      required:
        - resolution
        - pickup_required
      properties:
        resolution:
          type: string
          enum:
            - refund
            - replacement
        pickup_required:
          type: boolean
        refund_mode:
          description: >-
            Required and non-null when the return has a cash refund, subject to
            the order's available refund modes. Optional for points-only
            returns, which use loyalty-point refunds without bank details.
            Cleared for replacement or credit-line refund approval.
          type:
            - string
            - 'null'
          enum:
            - original-payment-mode
            - bank-transfer
            - null
        bank_account_id:
          description: >-
            Required for bank-transfer mode or a bank-transfer
            allocation/eligible paid leg. Must identify a verified outbound
            account for the order customer/user. Blank is accepted at field
            level; cleared when unnecessary.
          type:
            - string
            - 'null'
      x-tags:
        - Orders
    AdminReturnList:
      title: AdminReturnList
      description: Admin return summary, also returned after approval or rejection.
      type: object
      required:
        - request_number
        - status
        - created_at
        - modified_at
        - approved_at
        - rejected_at
        - items
        - received_at
        - resolution
        - requested_settlement
        - pickup_required
      properties:
        request_number:
          type: string
        status:
          description: >-
            Current workflow values include created, approved, rejected and
            cancelled. Open string; values are not restricted to a closed enum.
          type: string
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
        approved_at:
          type:
            - string
            - 'null'
          format: date-time
        rejected_at:
          type:
            - string
            - 'null'
          format: date-time
        items:
          type: array
          items:
            $ref: '#/components/schemas/AdminReturnItem'
        received_at:
          type:
            - string
            - 'null'
          format: date-time
        resolution:
          description: >-
            Admin decision, currently refund or replacement. Open string; values
            are not restricted to a closed enum.
          type:
            - string
            - 'null'
        requested_settlement:
          description: >-
            Customer preference, currently refund or replacement; independent of
            the admin decision. Open string; values are not restricted to a
            closed enum.
          type:
            - string
            - 'null'
        pickup_required:
          type:
            - boolean
            - 'null'
      x-tags:
        - Orders
    AdminReturnItem:
      title: AdminReturnItem
      description: Item included in an admin return request.
      type: object
      required:
        - shipment_number
        - product_id
        - product_name
        - product_image_url
        - variant_id
        - variant_name
        - quantity
        - return_reason
      properties:
        shipment_number:
          type:
            - string
            - 'null'
          readOnly: true
        product_id:
          type: string
          readOnly: true
        product_name:
          type:
            - string
            - 'null'
          readOnly: true
        product_image_url:
          type:
            - string
            - 'null'
          readOnly: true
        variant_id:
          type:
            - string
            - 'null'
          readOnly: true
        variant_name:
          type:
            - string
            - 'null'
          readOnly: true
        quantity:
          type: integer
          readOnly: true
        return_reason:
          type:
            - string
            - 'null'
          readOnly: true
      x-tags:
        - Orders
  responses:
    BadRequest:
      description: The request is invalid or cannot be completed in the current state.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              errors:
                description: Validation details as a field map, a bulk list or a string.
                anyOf:
                  - type: object
                    additionalProperties: true
                  - type: array
                  - type: string
              content:
                type: object
                additionalProperties: true
              details:
                type: string
    Unauthorized:
      description: >-
        The token is missing, invalid or expired, or does not grant access to
        this store and operation.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    InternalServerError:
      description: >-
        The request could not be completed. Quote error_id, when present, when
        contacting support.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
              error_id:
                type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Sign in to the admin dashboard and use the resulting ID token for a
        store and operation you can access. The authenticated dashboard cookie
        is accepted when the Authorization header is absent. Missing or
        insufficient access returns 401.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.