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

# Retrieve order receipt

> Retrieves a printable receipt for a specific order using the order number. This endpoint returns either structured JSON data or a formatted PDF, suitable for customer presentation. Response format (JSON or PDF) is determined by an optional query parameter (e.g. format=pdf or format=json). Staff can retrieve orders across all store locations.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/receipt
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/orders/{order_number}/receipt:
    get:
      tags:
        - Orders
      summary: Retrieve order receipt
      description: >-
        Retrieves a printable receipt for a specific order using the order
        number. This endpoint returns either structured JSON data or a formatted
        PDF, suitable for customer presentation. Response format (JSON or PDF)
        is determined by an optional query parameter (e.g. format=pdf or
        format=json). Staff can retrieve orders across all store locations.
      operationId: pos-get-order-receipt
      parameters:
        - name: format
          in: query
          description: Response data format
          schema:
            type: string
            default: json
            enum:
              - json
              - pdf
        - name: order_number
          in: path
          description: order number
          required: true
          schema:
            type: string
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]{1,128}$
      responses:
        '200':
          description: PDF document
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      order_receipt:
                        $ref: '#/components/schemas/OrderReceiptJsonFormat'
                    required:
                      - order_receipt
                    type: object
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/AdminUnauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/AdminNotFound'
        '500':
          $ref: '#/components/responses/AdminInternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/operations/pos-get-order-receipt
components:
  schemas:
    OrderReceiptJsonFormat:
      title: OrderReceiptJsonFormat
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/OrderReceiptJsonFormat
      allOf:
        - $ref: '#/components/schemas/AdminOrder'
        - type: object
          properties:
            billing_address:
              $ref: '#/components/schemas/AdminOrderAddress'
            shipping_address:
              $ref: '#/components/schemas/AdminOrderAddress'
            order_items:
              type: array
              items:
                $ref: '#/components/schemas/AdminOrderItemRead'
            payments:
              type: array
              items:
                anyOf:
                  - $ref: '#/components/schemas/AdminOrderPayment'
                  - $ref: '#/components/schemas/MsOrderPayment'
          required:
            - id
            - order_number
            - cart_id
            - order_date
            - status
            - payment_status
            - marketplace_synced
            - payment_success_date
            - customer_id
            - customer_email
            - customer_phone
            - customer_note
            - is_promotion_applied
            - promotion_discount_amount
            - promotion_discount_percent
            - is_coupon_applied
            - coupon_code
            - coupon_id
            - coupon_discount_amount
            - coupon_discount_percent
            - on_subscription
            - fulfillment_preference
            - sales_channel
            - subtotal
            - subtotal_tax
            - subtotal_including_tax
            - shipping_amount
            - shipping_tax_rate
            - shipping_total_tax
            - shipping_amount_including_tax
            - total_tax
            - grand_total
            - loyalty_point_redeemed
            - credit_balance_used
            - to_be_paid
            - loyalty_point_earned
            - order_items_count
            - currency
            - feedback
            - allowed_actions
            - applied_coupons
            - applied_promotions
            - created_at
            - modified_at
            - billing_address
            - shipping_address
            - order_items
            - payments
    AdminOrder:
      title: Order
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrder
      properties:
        id:
          description: Same value as `order_number`.
          type: string
          readOnly: true
        order_number:
          type: string
        cart_id:
          description: Identifier of the cart the order was created from.
          type:
            - string
            - 'null'
          readOnly: true
        order_date:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/AdminOrderStatus'
        payment_status:
          $ref: '#/components/schemas/PaymentStatus'
        marketplace_synced:
          description: Indicates whether the order was synced from Marketplace.
          type: boolean
        payment_success_date:
          type:
            - string
            - 'null'
          format: date-time
        customer_id:
          type: string
        customer_email:
          type:
            - string
            - 'null'
        customer_phone:
          type:
            - string
            - 'null'
        customer_note:
          type:
            - string
            - 'null'
        is_promotion_applied:
          type: boolean
        promotion_discount_amount:
          type:
            - number
            - 'null'
          format: double
        promotion_discount_percent:
          type:
            - number
            - 'null'
          format: double
          readOnly: true
        is_coupon_applied:
          type: boolean
        coupon_code:
          type:
            - string
            - 'null'
        coupon_id:
          type:
            - string
            - 'null'
          readOnly: true
        coupon_discount_amount:
          type:
            - number
            - 'null'
          format: double
        coupon_discount_percent:
          type:
            - number
            - 'null'
          format: double
          readOnly: true
        on_subscription:
          type: boolean
        fulfillment_preference:
          $ref: '#/components/schemas/AdminFulfillmentPreference'
        sales_channel:
          type: object
          properties:
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
            type:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - type
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
        subtotal:
          type: number
          format: double
        subtotal_tax:
          type: number
          format: double
        subtotal_including_tax:
          type: number
          format: double
        shipping_amount:
          type: number
          format: double
        shipping_tax_rate:
          type: number
          format: double
        shipping_total_tax:
          type: number
          format: double
        shipping_amount_including_tax:
          type: number
          format: double
        total_tax:
          type: number
          format: double
        grand_total:
          type: number
          format: double
        loyalty_point_redeemed:
          type: number
          format: double
        credit_balance_used:
          type: number
          format: double
        to_be_paid:
          type: number
          format: double
        loyalty_point_earned:
          type: number
          format: double
        order_items_count:
          type: integer
        currency:
          type: object
          properties:
            name:
              type: string
            code:
              type: string
            symbol:
              type: string
        feedback:
          type:
            - string
            - 'null'
        allowed_actions:
          type: array
          items:
            $ref: '#/components/schemas/OrderAction'
        applied_coupons:
          type: array
          items:
            $ref: '#/components/schemas/AdminAppliedCoupon'
        applied_promotions:
          type: array
          items:
            $ref: '#/components/schemas/AdminAppliedPromotion'
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
      x-tags:
        - Orders
    AdminOrderAddress:
      title: OrderAddress
      description: Address snapshot captured at checkout for an order or invoice.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrderAddress
      required:
        - first_name
        - phone
        - email
        - address_line1
        - pincode
        - city
        - state
        - country
      properties:
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        country_code:
          description: Phone country calling code, e.g. +91.
          type:
            - string
            - 'null'
        phone:
          description: 10 digit phone number without country code.
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        address_line1:
          type:
            - string
            - 'null'
        address_line2:
          type:
            - string
            - 'null'
        landmark:
          type:
            - string
            - 'null'
        pincode:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
        gstin:
          description: Use in shipping details only for third party.
          type:
            - string
            - 'null'
        business_name:
          description: Use in shipping details only for third party.
          type:
            - string
            - 'null'
        is_phone_verified:
          type: boolean
          readOnly: true
        is_email_verified:
          type: boolean
          readOnly: true
      x-tags:
        - Orders
    AdminOrderItemRead:
      title: OrderItemRead
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrderItemRead
      allOf:
        - $ref: '#/components/schemas/AdminOrderItem'
        - type: object
          required:
            - product_id
            - product_name
            - slug
            - product_slug
            - variant_slug
            - product_type
            - product_image_url
            - sku
            - on_offer
            - on_promotion
            - on_subscription
            - subscription_plan
            - subscription_interval
            - subscription_frequency
            - quantity
            - incremental_quantity
            - free_quantity
            - is_free_item
            - selling_price
            - selling_price_excluding_tax
            - listing_price
            - price_including_tax
            - promotion_discount_amount
            - promotion_discount_percent
            - coupon_discount_amount
            - coupon_discount_percent
            - tax_type
            - tax_rate
            - tax_amount
            - hsncode
            - handling_charge_excluding_tax
            - handling_charge_including_tax
            - handling_charge_tax_rate
            - variant_id
            - variant_name
            - product_variant_id
            - seller_id
            - seller_detail
            - seller_product_id
            - seller_variant_id
            - attributes
            - associated_options
    AdminOrderPayment:
      title: OrderPayment
      description: >-
        Order payment. Each array entry matches one method-specific shape; only
        fields for that method are present (for example `card_number` on card
        payments, `bank_name` on bank transfer).
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrderPayment
      anyOf:
        - $ref: '#/components/schemas/AdminCardPayment'
        - $ref: '#/components/schemas/AdminBankTransfer'
        - $ref: '#/components/schemas/AdminNetbankingPayment'
        - $ref: '#/components/schemas/AdminUpiPayment'
        - $ref: '#/components/schemas/AdminWalletPayment'
        - $ref: '#/components/schemas/LoyaltyPointPayment'
        - $ref: '#/components/schemas/OrderPaymentCommonOnly'
      x-tags:
        - Orders
    MsOrderPayment:
      title: MsOrderPayment
      description: Payment received in Marketplace for a marketplace-synced order.
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/MsOrderPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          required:
            - settlement_type
          properties:
            payment_date:
              type:
                - string
                - 'null'
              format: date-time
            settlement_type:
              enum:
                - prepaid
                - credit
      x-tags:
        - Orders
    AdminOrderStatus:
      title: OrderStatus
      type: string
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrderStatus
      enum:
        - draft
        - awaiting_approval
        - confirmed
        - schedule_requested
        - partially_scheduled
        - awaiting_shipment
        - shipped
        - partially_shipped
        - undelivered
        - partially_undelivered
        - return_to_origin
        - partially_return_to_origin
        - complete
        - partially_delivered
        - cancelled
        - pending
        - payment_failed
        - sent_to_store
        - ready_to_collect
        - processing
        - lost
    PaymentStatus:
      title: PaymentStatus
      type: string
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/PaymentStatus
      enum:
        - pending
        - success
        - failed
        - partially_paid
        - refund_initiated
        - refunded
        - unsettled
        - settled
        - partially_settled
        - manual_review
        - debit_scheduled
        - collection_due
    AdminFulfillmentPreference:
      title: FulfillmentPreference
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminFulfillmentPreference
      discriminator:
        propertyName: fulfillment_type
        mapping:
          collect-in-store: '#/components/schemas/AdminCollectInStoreFulfillment'
          delivery: '#/components/schemas/AdminDeliveryFulfillment'
          partial-collect-and-delivery: '#/components/schemas/AdminPartialCollectAndDelivery'
      oneOf:
        - $ref: '#/components/schemas/AdminCollectInStoreFulfillment'
        - $ref: '#/components/schemas/AdminDeliveryFulfillment'
        - $ref: '#/components/schemas/AdminPartialCollectAndDelivery'
      x-tags:
        - Orders
    OrderAction:
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/OrderAction
      enum:
        - create-shipment
        - update-order
        - download-invoice
        - download-shipping-label
        - inventory-check
        - refresh-payment-status
        - return-replace
        - update-payment-status
        - cancel-order
        - approve-order
    AdminAppliedCoupon:
      title: AppliedPromotion
      description: Details about an active coupon applied to a cart/order
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminAppliedCoupon
      required:
        - coupon_id
        - coupon_type
        - savings
        - product_id
        - variant_id
        - product_name
        - variant_name
      properties:
        coupon_id:
          type: string
        coupon_type:
          enum:
            - discount
            - free-goods
            - fixed-price
            - free-shipping
            - buy-x-get-y
            - volume-based
            - accelerated-rewards
        savings:
          type: number
        product_id:
          type:
            - string
            - 'null'
        variant_id:
          type:
            - string
            - 'null'
        product_name:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
    AdminAppliedPromotion:
      title: AppliedPromotion
      description: Details about an active promotion applied to a cart/order
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminAppliedPromotion
      required:
        - promotion_id
        - promotion_type
        - savings
        - product_id
        - variant_id
        - product_name
        - variant_name
        - applied_sequence
        - scope
      properties:
        promotion_id:
          type: string
        promotion_type:
          enum:
            - discount
            - free-goods
            - fixed-price
            - free-shipping
            - buy-x-get-y
            - volume-based
        savings:
          type: number
        product_id:
          type:
            - string
            - 'null'
        variant_id:
          type:
            - string
            - 'null'
        product_name:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
        applied_sequence:
          type: number
        scope:
          type: string
    AdminOrderItem:
      title: OrderItem
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrderItem
      required:
        - sku
        - quantity
      properties:
        product_id:
          type: string
          readOnly: true
        product_name:
          type: string
          readOnly: true
        slug:
          description: >-
            Slug of the thing actually ordered — the variant's slug when the
            item has a variant, otherwise the product's.
          type: string
          readOnly: true
        product_slug:
          type:
            - string
            - 'null'
          readOnly: true
        variant_slug:
          description: Null or an empty string when the item has no variant.
          type:
            - string
            - 'null'
          readOnly: true
        product_type:
          $ref: '#/components/schemas/ProductType'
        product_image_url:
          type:
            - string
            - 'null'
          readOnly: true
        sku:
          type: string
        on_offer:
          type: boolean
          readOnly: true
        on_promotion:
          type: boolean
          readOnly: true
        on_subscription:
          type: boolean
        subscription_plan:
          type:
            - string
            - 'null'
        subscription_interval:
          type:
            - integer
            - 'null'
          readOnly: true
        subscription_frequency:
          type:
            - string
            - 'null'
          readOnly: true
        quantity:
          type: integer
        incremental_quantity:
          description: Step the quantity can be changed by.
          type: integer
          readOnly: true
        free_quantity:
          type: integer
          readOnly: true
        is_free_item:
          type: boolean
          readOnly: true
        selling_price:
          type: number
          format: double
          readOnly: true
        selling_price_excluding_tax:
          type: number
          format: double
          readOnly: true
        listing_price:
          type: number
          format: double
          readOnly: true
        price_including_tax:
          description: >-
            Whether `selling_price` and `listing_price` already include tax. A
            flag, not an amount.
          type: boolean
          readOnly: true
        promotion_discount_amount:
          type: number
          format: double
          readOnly: true
        promotion_discount_percent:
          type: number
          format: double
          readOnly: true
        coupon_discount_amount:
          type: number
          format: double
          readOnly: true
        coupon_discount_percent:
          type:
            - number
            - 'null'
          format: double
          readOnly: true
        tax_type:
          description: >-
            Tax type from product pricing; seller order copies can use lowercase
            values.
          type: string
          default: GST
          enum:
            - gst
            - GST
            - VAT
            - ECO
            - vat
            - eco
          readOnly: true
        tax_rate:
          type: number
          format: float
          readOnly: true
        tax_amount:
          type: number
          format: double
          readOnly: true
        hsncode:
          description: HSN code used for the item's tax treatment.
          type:
            - string
            - 'null'
          readOnly: true
        handling_charge_excluding_tax:
          type: number
          format: double
          readOnly: true
        handling_charge_including_tax:
          type: number
          format: double
        handling_charge_tax_rate:
          type: number
          format: double
        variant_id:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
        product_variant_id:
          type:
            - string
            - 'null'
          readOnly: true
        seller_id:
          description: >-
            Seller ID. This field is relevant for marketplace type stores only.
            Will return null for b2b and b2c type stores.
          type:
            - string
            - 'null'
        seller_detail:
          description: >-
            Seller detail information. This field is relevant for marketplace
            type stores only. Will return null for b2b and b2c type stores.
          oneOf:
            - $ref: '#/components/schemas/SellerBasicDetail'
            - type: 'null'
        seller_product_id:
          description: >-
            Seller's own product identifier. Relevant to marketplace stores
            only; `null` for b2b and b2c stores.
          type:
            - string
            - 'null'
          readOnly: true
        seller_variant_id:
          description: >-
            Seller's own variant identifier. Relevant to marketplace stores
            only; `null` for b2b and b2c stores.
          type:
            - string
            - 'null'
          readOnly: true
        attributes:
          description: Product attributes captured on the item at the time of the order.
          type:
            - array
            - 'null'
          items:
            type: object
            properties:
              id:
                type: string
              key:
                description: Attribute name in snake case.
                type: string
              name:
                type: string
              type:
                description: >-
                  Attribute type, e.g. `single-select`, `boolean`, `text`,
                  `multi-select`, `date`, `color`.
                type: string
              value:
                description: >-
                  The attribute value captured on the order item. Its JSON shape
                  follows the attribute type: strings for text, single-select
                  and date; booleans for boolean; lists for multi-select;
                  structured values for color.
          readOnly: true
        associated_options:
          description: >-
            Variant options, keyed by the option's snake-case key. `null` for
            items with no variant.
          type:
            - object
            - 'null'
          additionalProperties:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              value:
                type: string
          readOnly: true
      x-tags:
        - Orders
    AdminCardPayment:
      title: CardPayment
      description: Payments using credit card, debit card
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminCardPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            card_number:
              description: "masked card number\r\ne.g. ************1111"
              type:
                - string
                - 'null'
            card_type:
              description: Card brand supplied by the payment provider.
              type:
                - string
                - 'null'
    AdminBankTransfer:
      title: BankTransfer
      description: Bank transfer payment - IMPS, NEFT, RTGS
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminBankTransfer
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            bank_account_number:
              description: "masked account number\r\ne.g. ************1234"
              type:
                - string
                - 'null'
            bank_name:
              type:
                - string
                - 'null'
    AdminNetbankingPayment:
      title: NetbankingPayment
      description: Payments using payment gateway netbanking option.
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminNetbankingPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            bank_name:
              type: string
    AdminUpiPayment:
      title: UpiPayment
      description: UPI Payment
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminUpiPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            upi_id:
              type:
                - string
                - 'null'
    AdminWalletPayment:
      title: WalletPayment
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminWalletPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            wallet_name:
              type:
                - string
                - 'null'
    LoyaltyPointPayment:
      title: LoyaltyPointPayment
      description: Loyalty point redemption.
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/LoyaltyPointPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
      x-tags:
        - Orders
    OrderPaymentCommonOnly:
      title: OrderPaymentCommonOnly
      description: >-
        Order payment with only common fields, for methods such as Cash, NACH,
        or POS entries with no method-specific metadata.
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/OrderPaymentCommonOnly
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
      x-tags:
        - Orders
    OrderPaymentInfo:
      title: OrderPaymentInfo
      description: Common fields in all types of payments.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/OrderPaymentInfo
      properties:
        transaction_type:
          enum:
            - payment
            - refund
        request_number:
          type: string
        amount:
          type: number
          format: double
        payment_status:
          type: string
          enum:
            - pending
            - success
            - failed
            - partially_paid
            - refund_initiated
            - refunded
            - unsettled
            - settled
            - partially_settled
            - manual_review
            - debit_scheduled
            - collection_due
            - initiated
            - forfeited
        payment_date:
          type:
            - string
            - 'null'
          format: date-time
        payment_reference_number:
          type:
            - string
            - 'null'
        payment_method:
          description: >-
            How it was paid, e.g. `Card`, `Credit Card`, `Debit Card`,
            `Netbanking`, `UPI`, `Wallet`, `Loyalty Point`, `IMPS`, `NEFT`,
            `RTGS`, `Cash`, `NACH`. A manual payment carries the method it was
            requested or recorded with. Empty string when recorded without a
            method, as on point-of-sale orders; null for refunds and payments
            not paid yet.
          type:
            - string
            - 'null'
        payment_mode:
          type: string
        icon_url:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
      x-tags:
        - Orders
    AdminCollectInStoreFulfillment:
      title: CollectInStoreFulfillment
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminCollectInStoreFulfillment
      required:
        - fulfillment_type
        - pickup_location_id
      properties:
        fulfillment_type:
          type: string
          const: collect-in-store
        preference_type:
          type: string
          enum:
            - user
            - auto
          readOnly: true
        pickup_location_id:
          type:
            - string
            - 'null'
        pickup_location_name:
          type:
            - string
            - 'null'
          readOnly: true
    AdminDeliveryFulfillment:
      title: DeliveryFulfillment
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminDeliveryFulfillment
      required:
        - fulfillment_type
        - shipping_provider_id
      properties:
        fulfillment_type:
          type: string
          const: delivery
        preference_type:
          type: string
          enum:
            - user
            - auto
          readOnly: true
        shipping_provider_id:
          type:
            - string
            - 'null'
        shipping_provider_name:
          type:
            - string
            - 'null'
          readOnly: true
        courier_company_id:
          type:
            - string
            - 'null'
        courier_company_name:
          type:
            - string
            - 'null'
          readOnly: true
    AdminPartialCollectAndDelivery:
      title: PartialCollectAndDelivery
      description: >-
        Automatic preferences can omit `collect_in_store` and `delivery`.
        Provide both for a user-selected preference.
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminPartialCollectAndDelivery
      required:
        - fulfillment_type
      properties:
        fulfillment_type:
          type: string
          const: partial-collect-and-delivery
        preference_type:
          type: string
          enum:
            - user
            - auto
          readOnly: true
        collect_in_store:
          type: object
          properties:
            pickup_location_id:
              type:
                - string
                - 'null'
            pickup_location_name:
              type:
                - string
                - 'null'
              readOnly: true
            items:
              type: array
              items:
                $ref: '#/components/schemas/AdminFulfillmentItem'
          required:
            - items
            - pickup_location_id
        delivery:
          type: object
          properties:
            shipping_provider_id:
              type: string
            shipping_provider_name:
              type:
                - string
                - 'null'
              readOnly: true
            courier_company_id:
              type:
                - string
                - 'null'
            courier_company_name:
              type:
                - string
                - 'null'
              readOnly: true
            items:
              type: array
              items:
                $ref: '#/components/schemas/AdminFulfillmentItem'
          required:
            - shipping_provider_id
            - items
    ProductType:
      title: ProductType
      description: Type of product
      type: string
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ProductType
      enum:
        - physical
        - digital
        - bundle
      x-tags:
        - Catalog
    SellerBasicDetail:
      title: SellerBasicDetail
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/SellerBasicDetail
      properties:
        id:
          type: string
        trade_name:
          type: string
        legal_name:
          type: string
        business_type:
          $ref: '#/components/schemas/SellerBusinessType'
        tax_identification_number:
          type: string
    AdminFulfillmentItem:
      title: FulfillmentItem
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminFulfillmentItem
      required:
        - product_id
        - product_name
        - variant_id
        - variant_name
        - quantity
      properties:
        product_id:
          type: string
        product_name:
          type: string
          readOnly: true
        variant_id:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
          readOnly: true
        quantity:
          type: integer
    SellerBusinessType:
      title: SellerBusinessType
      type: string
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/SellerBusinessType
      enum:
        - sole_proprietorship
        - private_limited
        - public_listed
        - public_limited
        - state_owned
        - charity
        - individual
  responses:
    BadRequest:
      description: Bad request
      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
              errors:
                type: object
              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
    AdminNotFound:
      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
    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.