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

# List orders

> Open orders by default. Use `updated_since` as a safety net next to the webhooks: it returns every order that changed, finished ones included.
The list is short on purpose. Fetch each order you need with `GET /orders/{id}`.




## OpenAPI

````yaml GET /orders
openapi: 3.1.0
info:
  title: XFaster Partner API
  version: '1.0'
  description: >
    Receive XFaster orders in your POS, send their status back, and keep the
    menu, stock and prices in sync.

    One API key per store, or one integrator key for all your stores (it names
    the store in X-XFaster-Store). Money is in agorot (integers, VAT included).
    Times are ISO 8601 with the Israel offset.
servers:
  - url: https://staging2.xfaster.net/api/partner/v1
    description: Sandbox (test keys, xfp_test_…)
  - url: https://apps.xfaster.net/api/partner/v1
    description: Live (live keys, xfp_live_…)
security:
  - apiKey: []
  - apiKey: []
    storeHeader: []
tags:
  - name: Store
  - name: Orders
  - name: Menu
  - name: Market
  - name: Reports
  - name: Sandbox
paths:
  /orders:
    get:
      tags:
        - Orders
      summary: List orders
      description: >
        Open orders by default. Use `updated_since` as a safety net next to the
        webhooks: it returns every order that changed, finished ones included.

        The list is short on purpose. Fetch each order you need with `GET
        /orders/{id}`.
      operationId: listOrders
      parameters:
        - name: status
          in: query
          description: Comma-separated statuses. Default `new,preparing,ready`.
          schema:
            type: string
            example: new,preparing
        - name: updated_since
          in: query
          description: >-
            Orders changed after this time. Encode the `+` of the offset as
            `%2B`.
          schema:
            type: string
            format: date-time
            example: '2026-10-14T19:00:00+03:00'
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: cursor
          in: query
          description: From `next` of the previous page.
          schema:
            type: string
      responses:
        '200':
          description: A page of orders
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 183761
                        status:
                          $ref: '#/components/schemas/OrderStatus'
                        updated_at:
                          type: string
                          format: date-time
                  next:
                    type:
                      - string
                      - 'null'
                    description: URL of the next page, or null
components:
  schemas:
    OrderStatus:
      type: string
      enum:
        - new
        - preparing
        - ready
        - picked_up
        - delivered
        - collected
        - cancelled
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        The store's API key (xfp_test_… on the sandbox, xfp_live_… on live).
        XFaster creates it and shows it once. An integrator key (one key for a
        POS company) also sends X-XFaster-Store.
    storeHeader:
      type: apiKey
      in: header
      name: X-XFaster-Store
      description: >-
        Integrator keys only: the XFaster store id this request is for. It must
        be linked to your key (else 403 store_not_linked); without it 400
        store_header_required. Store keys don't send it.

````

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