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

# Pause new orders

> The kitchen can't keep up. New orders stop for a while and come back by themselves at `busy_until`. Accepted orders continue.



## OpenAPI

````yaml POST /store/busy
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:
  /store/busy:
    post:
      tags:
        - Store
      summary: Pause new orders (busy)
      description: >-
        The kitchen can't keep up. New orders stop for a while and come back by
        themselves at `busy_until`. Accepted orders continue.
      operationId: setBusy
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - minutes
              properties:
                minutes:
                  type: integer
                  minimum: 15
                  maximum: 120
                  example: 30
                  description: How long to pause new orders.
      responses:
        '200':
          description: The store, now busy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store'
              examples:
                example:
                  $ref: '#/components/examples/Store'
        '422':
          $ref: '#/components/responses/Invalid'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Any unique string. Repeating a request with the same key within 24 hours
        returns the first answer instead of acting twice.
      schema:
        type: string
        example: 5f0c3d1e-8b6a-4e1f-9c2d-7a1b0e4f6d21
  schemas:
    Store:
      type: object
      properties:
        id:
          type: integer
          example: 64
        name:
          type: string
          example: TABOON Plus
        accepting_orders:
          type: boolean
          example: false
        reason:
          type:
            - string
            - 'null'
          enum:
            - busy
            - closed
            - outside_hours
            - null
          example: busy
        open:
          type: boolean
        busy_until:
          type:
            - string
            - 'null'
          format: date-time
        delivery:
          type: boolean
        pickup:
          type: boolean
        invoices:
          type: string
          enum:
            - xfaster
            - store
          description: >-
            xfaster = the store's PayPlus already issues the customer's invoice;
            store = your POS issues the receipt
        hours:
          type: array
          items:
            type: object
            properties:
              day:
                type: string
                example: friday
              open:
                type: string
                example: '11:00'
              close:
                type: string
                example: '01:00'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type:
                - object
                - 'null'
  examples:
    Store:
      value:
        id: 64
        name: TABOON Plus
        accepting_orders: true
        reason: null
        open: true
        busy_until: null
        delivery: true
        pickup: true
        invoices: xfaster
        hours:
          - day: sunday
            open: '11:00'
            close: '23:00'
          - day: friday
            open: '11:00'
            close: '01:00'
  responses:
    Invalid:
      description: A value is missing or breaks a rule
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: prep_time_out_of_range
              message: Preparation time must be between 5 and 120 minutes.
              details:
                min: 5
                max: 120
  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.