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

# List in-person sales

> List POS sales, newest first, with date and payment filters. Requires the READ_POS scope.

Only records with source `pos` are returned, so this route cannot be used to read online orders. Use `from` and `to` for the date range, `paymentMethod` to split cash, card, transfer and other, and `page`/`limit` to paginate.


## OpenAPI

````yaml apps-api/specs/pos.json GET /pos/sales
openapi: 3.1.0
info:
  title: 'Salesive Apps API: Point of Sale'
  version: 1.0.0
  description: >-
    Ring up in-person sales and reconcile them from an installed third-party
    app. Every endpoint authenticates with an installed-app access token (prefix
    `app_`) and requires `READ_POS` or `WRITE_POS`. The target store is bound to
    the token server-side from the installation, so never send a shop id.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
tags:
  - name: Point of sale
    description: In-person sales, their receipts and daily totals.
paths:
  /pos/sales:
    get:
      tags:
        - Point of sale
      summary: List in-person sales
      description: >-
        Lists POS sales, newest first. Only records with source `pos` are
        returned, so this cannot be used to read online orders. Requires
        `READ_POS`.
      operationId: listPosSales
      parameters:
        - name: from
          in: query
          required: false
          description: Inclusive lower bound on the sale date (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: Inclusive upper bound on the sale date (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: paymentMethod
          in: query
          required: false
          schema:
            type: string
            enum:
              - cash
              - card
              - transfer
              - other
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - processing
              - paid
              - cancelled
              - refunded
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
      responses:
        '200':
          description: The matching sales and pagination metadata.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          sales:
                            type: array
                            items:
                              $ref: '#/components/schemas/PosSale'
                          pagination:
                            $ref: '#/components/schemas/Pagination'
        '403':
          description: The app is missing `READ_POS`.
components:
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    PosSale:
      type: object
      description: >-
        An in-person sale. It is the same order record the dashboard's POS
        creates: source `pos`, status `paid`, stock reduced and a completed
        payment attached.
      properties:
        _id:
          type: string
        orderId:
          type: integer
          description: The store-facing order number.
        shop:
          type: string
        user:
          type: string
        items:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              name:
                type: string
              price:
                type: number
              quantity:
                type: integer
              sku:
                type:
                  - string
                  - 'null'
              imageUrl:
                type:
                  - string
                  - 'null'
              itemType:
                type: string
                enum:
                  - product
                  - food
                  - service
        subtotal:
          type: number
        discount:
          type: number
        tax:
          type: number
        shippingCost:
          type: number
        status:
          type: string
          enum:
            - pending
            - processing
            - paid
            - cancelled
            - refunded
        source:
          type: string
          enum:
            - online
            - pos
        paymentMethod:
          type: string
          enum:
            - cash
            - card
            - transfer
            - other
        posCustomerName:
          type:
            - string
            - 'null'
        posCustomerEmail:
          type:
            - string
            - 'null'
        posCustomerPhone:
          type:
            - string
            - 'null'
        additionalInfo:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInfoItem'
        payment:
          $ref: '#/components/schemas/PaymentSummary'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      description: Pagination metadata for list responses.
      properties:
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        pages:
          type: integer
        hasNext:
          type: boolean
        hasPrev:
          type: boolean
        nextPage:
          type:
            - integer
            - 'null'
        prevPage:
          type:
            - integer
            - 'null'
    AdditionalInfoItem:
      type: object
      required:
        - label
        - value
      properties:
        label:
          type: string
        value:
          type: string
    PaymentSummary:
      type: object
      description: The completed payment created with the sale.
      properties:
        _id:
          type: string
        status:
          type: string
        amount:
          type: number
        total:
          type: number
        channel:
          type: string
        provider:
          type: string
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side, so never send a shop
        id.

````

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