> ## 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.

# Refund shortfall

> Refunds items of an order's unscheduled shipment that won't be shipped: the shortfall moves to a shipment of its own and is refunded by the original payment or by bank transfer, never beyond what the order's payments have left. Fails with a 409, changing nothing, while refunds are briefly unavailable or the order's payment is held for an admin's review. 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-pos.json post /pos/shipping/shipments/{order_number}/refund-shortfall
openapi: 3.2.0
info:
  title: CE POS APIs
  description: >-
    The consolidated Point of Sale surface. Every operation is served under the
    storefront base URL; the POS backend proxies some of them to the admin
    service.
  version: '1.0'
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/storefront
    description: Staging Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: staging
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/storefront
    description: Prod Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: prod
security:
  - Authorization: []
tags:
  - name: section-identity
    summary: Identity
    kind: nav
  - name: Devices
    description: >-
      Set up the till: pair a device with the store using its pairing code, list
      the store's `PosLocation`s and `PosDevice`s, and claim a device for the
      signed-in user or release it.
    summary: Devices
    kind: nav
    parent: section-identity
  - name: Authentication
    description: >-
      Sign a staff member in on a paired device with a one-time password over
      SMS, WhatsApp or email, then refresh the access token or log out.
    summary: Authentication
    kind: nav
    parent: section-identity
  - name: Users
    description: >-
      The staff member signed in on the till, as a `PosUser` with their
      location, device and roles.
    summary: Users
    kind: nav
    parent: section-identity
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Look up the shopper at the till: list customers (`CustomerListItem`) and
      read one's full `CustomerDetail`.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Addresses
    description: >-
      A customer's saved addresses, as `Address` objects: list, add, update and
      remove them.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Browse and search the catalog at the till: list `Product`s and SKUs, read
      a product and its variants, and show similar, up-sell and cross-sell
      items.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read product reviews at the till.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Categories
    description: >-
      The store's categories, as `ProductCategory` objects with their child
      categories.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Stock at the store's locations: list it by item, read an item's
      `InventoryDetail`, and follow the `InventoryActivity` that moved it.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: >-
      The till's `Cart`: create it, add, update or remove items, link the
      customer, set the address, and apply loyalty points or credit balance.
      Each update returns the full, updated `Cart`.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: >-
      The coupons and promotions a cart can use: list what the store offers, see
      which apply to a cart and why the rest don't, and apply or remove a
      coupon.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: Fulfillment
    description: >-
      List the delivery and collect-in-store options for a cart, and save the
      cart's choice.
    summary: Fulfillment
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Place an order from the till's cart and follow it: list orders, read an
      `OrderDetail` and its activity, check stock before it ships, and get its
      invoice, receipt and shipments.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Order payments
    description: >-
      Collect payment for an order: add payments toward what is left to pay,
      across one or more methods, poll the payment status, and retry a failed or
      expired payment.
    summary: Order payments
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      The shipments that fulfill orders: list them, read a `ShipmentDetail` with
      its activity and invoice, approve, reject or update one, send a
      replacement, and refund a shortfall.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Payments
    description: >-
      The payment methods the till accepts and the checks around paying with
      them: card BIN details, VPA verification, and authenticating a payment
      with a direct OTP.
    summary: Payments
    kind: nav
    parent: section-payments
  - name: section-store
    summary: Store
    kind: nav
  - name: Locations
    description: States and pincodes for address forms.
    summary: Locations
    kind: nav
    parent: section-store
paths:
  /pos/shipping/shipments/{order_number}/refund-shortfall:
    post:
      tags:
        - Shipments
      summary: Refund shortfall
      description: >-
        Refunds items of an order's unscheduled shipment that won't be shipped:
        the shortfall moves to a shipment of its own and is refunded by the
        original payment or by bank transfer, never beyond what the order's
        payments have left. Fails with a 409, changing nothing, while refunds
        are briefly unavailable or the order's payment is held for an admin's
        review. 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: pos-refund-shortfall
      parameters:
        - name: order_number
          in: path
          description: Order Number
          required: true
          schema:
            type: string
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]{1,128}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: RefundShortfallToOriginalPaymentMode
                  type: object
                  properties:
                    items:
                      type: array
                      items:
                        type: object
                        required:
                          - product_id
                          - variant_id
                          - quantity
                        properties:
                          product_id:
                            type: string
                          variant_id:
                            description: >-
                              The unique identifier of the product variant. Use
                              `null` if the product has no variants.
                            type:
                              - string
                              - 'null'
                          quantity:
                            type: integer
                            minimum: 0
                          free_quantity:
                            type: integer
                            default: 0
                            minimum: 0
                        description: Supply `quantity` or `free_quantity` of at least 1.
                    payment_method:
                      type: string
                      const: original-payment-mode
                    bank_account_id:
                      description: >-
                        The customer’s verified outbound bank account. Needed
                        when the order has a paid bank-transfer payment: its
                        refund then goes by bank transfer even though the
                        original mode was requested.
                      type: string
                  required:
                    - items
                    - payment_method
                - title: RefundShortfallByBankTransfer
                  type: object
                  properties:
                    items:
                      type: array
                      items:
                        type: object
                        required:
                          - product_id
                          - variant_id
                          - quantity
                        properties:
                          product_id:
                            type: string
                          variant_id:
                            description: >-
                              The unique identifier of the product variant. Use
                              `null` if the product has no variants.
                            type:
                              - string
                              - 'null'
                          quantity:
                            type: integer
                            minimum: 0
                          free_quantity:
                            type: integer
                            default: 0
                            minimum: 0
                        description: Supply `quantity` or `free_quantity` of at least 1.
                    payment_method:
                      type: string
                      const: bank-transfer
                    bank_account_id:
                      description: >-
                        The customer’s verified outbound bank account to refund
                        to.
                      type: string
                  required:
                    - items
                    - payment_method
                    - bank_account_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/AdminBadRequest'
        '401':
          $ref: '#/components/responses/AdminUnauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The shortfall can't be refunded at the moment. Nothing is changed.
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        A shortfall refund waits for the payment ledger update
                        to finish; try again shortly
                      - >-
                        The order's payment is held for an admin to resolve; it
                        cannot be refunded until then.
                  success:
                    type: boolean
                    default: false
        '500':
          $ref: '#/components/responses/AdminInternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/operations/pos-refund-shortfall
components:
  responses:
    AdminBadRequest:
      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
    AdminUnauthorized:
      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
    Forbidden:
      description: >-
        Access denied. `token-required` requires an authenticated session;
        `permission-denied` means the caller cannot access this resource. On
        POS, `session-expired` requires signing in again.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    AdminInternalServerError:
      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
    GatewayTimeout:
      description: The request timed out.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
  securitySchemes:
    Authorization:
      type: http
      description: Access token
      scheme: bearer

````

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