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



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}/receipt
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/{order_number}/receipt:
    parameters:
      - name: order_number
        in: path
        description: order number
        required: true
        schema:
          type: string
    get:
      tags:
        - Invoices
      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).
      operationId: get-order-receipt
      parameters:
        - name: format
          in: query
          description: Response data format
          schema:
            type: string
            default: json
            enum:
              - json
              - pdf
      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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    OrderReceiptJsonFormat:
      title: OrderReceiptJsonFormat
      allOf:
        - $ref: '#/components/schemas/Order'
        - type: object
          properties:
            billing_address:
              $ref: '#/components/schemas/OrderAddress'
            shipping_address:
              $ref: '#/components/schemas/OrderAddress'
            order_items:
              type: array
              items:
                $ref: '#/components/schemas/OrderItemRead'
            payments:
              type: array
              items:
                anyOf:
                  - $ref: '#/components/schemas/OrderPayment'
                  - $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
    Order:
      title: Order
      type: object
      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/OrderStatus'
        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/FulfillmentPreference'
        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/AppliedCoupon'
        applied_promotions:
          type: array
          items:
            $ref: '#/components/schemas/AppliedPromotion'
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
      x-tags:
        - Orders
    OrderAddress:
      title: OrderAddress
      description: Address snapshot captured at checkout for an order or invoice.
      type: object
      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
    OrderItemRead:
      title: OrderItemRead
      allOf:
        - $ref: '#/components/schemas/OrderItem'
        - 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
    OrderPayment:
      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).
      anyOf:
        - $ref: '#/components/schemas/CardPayment'
        - $ref: '#/components/schemas/BankTransfer'
        - $ref: '#/components/schemas/NetbankingPayment'
        - $ref: '#/components/schemas/UpiPayment'
        - $ref: '#/components/schemas/WalletPayment'
        - $ref: '#/components/schemas/LoyaltyPointPayment'
        - $ref: '#/components/schemas/OrderPaymentCommonOnly'
      x-tags:
        - Orders
    MsOrderPayment:
      title: MsOrderPayment
      description: Payment received in Marketplace for a marketplace-synced order.
      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
    OrderStatus:
      title: OrderStatus
      type: string
      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
      enum:
        - pending
        - success
        - failed
        - partially_paid
        - refund_initiated
        - refunded
        - unsettled
        - settled
        - partially_settled
        - manual_review
        - debit_scheduled
        - collection_due
    FulfillmentPreference:
      title: FulfillmentPreference
      discriminator:
        propertyName: fulfillment_type
        mapping:
          collect-in-store: '#/components/schemas/CollectInStoreFulfillment'
          delivery: '#/components/schemas/DeliveryFulfillment'
          partial-collect-and-delivery: '#/components/schemas/PartialCollectAndDelivery'
      oneOf:
        - $ref: '#/components/schemas/CollectInStoreFulfillment'
        - $ref: '#/components/schemas/DeliveryFulfillment'
        - $ref: '#/components/schemas/PartialCollectAndDelivery'
      x-tags:
        - Orders
    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
    AppliedCoupon:
      title: AppliedPromotion
      description: Details about an active coupon applied to a cart/order
      type: object
      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'
    AppliedPromotion:
      title: AppliedPromotion
      description: Details about an active promotion applied to a cart/order
      type: object
      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
    OrderItem:
      title: OrderItem
      type: object
      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
    CardPayment:
      title: CardPayment
      description: Payments using credit card, debit card
      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'
    BankTransfer:
      title: BankTransfer
      description: Bank transfer payment - IMPS, NEFT, RTGS
      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'
    NetbankingPayment:
      title: NetbankingPayment
      description: Payments using payment gateway netbanking option.
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            bank_name:
              type: string
    UpiPayment:
      title: UpiPayment
      description: UPI Payment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            upi_id:
              type:
                - string
                - 'null'
    WalletPayment:
      title: WalletPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            wallet_name:
              type:
                - string
                - 'null'
    LoyaltyPointPayment:
      title: LoyaltyPointPayment
      description: Loyalty point redemption.
      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.
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
      x-tags:
        - Orders
    OrderPaymentInfo:
      title: OrderPaymentInfo
      description: Common fields in all types of payments.
      type: object
      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
    CollectInStoreFulfillment:
      title: CollectInStoreFulfillment
      type: object
      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
    DeliveryFulfillment:
      title: DeliveryFulfillment
      type: object
      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
    PartialCollectAndDelivery:
      title: PartialCollectAndDelivery
      description: >-
        Automatic preferences can omit `collect_in_store` and `delivery`.
        Provide both for a user-selected preference.
      type: object
      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/FulfillmentItem'
          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/FulfillmentItem'
          required:
            - shipping_provider_id
            - items
    ProductType:
      title: ProductType
      description: Type of product
      type: string
      enum:
        - physical
        - digital
        - bundle
      x-tags:
        - Catalog
    SellerBasicDetail:
      title: SellerBasicDetail
      type: object
      properties:
        id:
          type: string
        trade_name:
          type: string
        legal_name:
          type: string
        business_type:
          $ref: '#/components/schemas/SellerBusinessType'
        tax_identification_number:
          type: string
    FulfillmentItem:
      title: FulfillmentItem
      type: object
      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
      enum:
        - sole_proprietorship
        - private_limited
        - public_listed
        - public_limited
        - state_owned
        - charity
        - individual
  responses:
    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.