Ready2order User API

openapi: 3.0.0
info:
  title: ready2order Public Account Token User API
  contact:
    name: support@ready2order.com
  license:
    name: proprietary
  version: R2-2026.30.2
  description: "# First Steps\n\n## Authorization\n\nThe ready2order API uses a three-token flow to grant your integration access to a ready2order account. Your integration identifies itself with a Developer Token, requests permission from the account owner, and receives a long-lived Account Token to use for all subsequent requests.\n\nEvery API request to account data must include:\n\n```http\nAuthorization: Bearer <ACCOUNT_TOKEN>\n```\n\n| Token | Scope | Lifetime |\n|-------|-------|----------|\n| **Developer Token** | Identifies your integration | Permanent |\n| **Grant Access Token** | One-time permission request | 10 minutes |\n| **Account Token** | Access to a ready2order account | Until revoked |\n\n---\n\n## Setup\n\nThis is a one-time process per account you want to integrate with.\n\n### Step 1 — Get your Developer Token\n\nRegister at [https://api.ready2order.com](https://api.ready2order.com). Your Developer Token will be emailed to you.\n\nStore it securely — it identifies your integration across all accounts.\n\n---\n\n### Step 2 — Request a Grant Access Token\n\nCall this endpoint using your Developer Token:\n\n```http\nPOST /v1/developerToken/grantAccessToken\nAuthorization: Bearer <DEVELOPER_TOKEN>\n```\n\n```json\n{\n  \"callbackUri\": \"https://your-app.com/callback\"\n}\n```\n\n`callbackUri` is optional but strongly recommended (see Step 3).\n\n**Response:**\n\n```json\n{\n  \"grantAccessToken\": \"...\",\n  \"grantAccessUri\": \"https://app.ready2order.com/...\"\n}\n```\n\n---\n\n### Step 3 — Account owner approves access\n\nRedirect the account owner to the `grantAccessUri`. They will log in to their ready2order account and click **Approve**.\n\n**With `callbackUri`** — after approval, ready2order redirects the account owner back to your URL:\n\n```\nhttps://your-app.com/callback?accountToken=<ACCOUNT_TOKEN>&grantAccessToken=<GRANT_ACCESS_TOKEN>&status=approved\n```\n\nThe `accountToken` in that redirect is what you store and use for all future requests.\n\n**Without `callbackUri`** — poll for the result instead:\n\n```http\nGET /v1/developerToken/grantAccessToken/{grantAccessToken}\nAuthorization: Bearer <DEVELOPER_TOKEN>\n```\n\nThe response will include `accountToken` once the account owner has approved.\n\n> The Grant Access Token expires after **10 minutes**. If the account owner does not approve in time, repeat Step 2 to generate a new one.\n\n---\n\n## Training Mode\n\nSome resources support a training mode that keeps test transactions separate from live data. It is handy for staff training and demos where test sales should not show up in reports or fiscal records.\n\nWhen a cashier puts the POS into training mode, all transactions in that session are flagged as training records and kept separate from live data. On the API side, the `trainingMode` field on a resource tells you whether it is a training record, and most list endpoints accept a `trainingMode` query parameter to filter by it.\n\n---\n\n## Error Responses\n\n| Status | Likely cause |\n|--------|-------------|\n| `401 Unauthorized` | Wrong token type, or `Authorization` header missing |\n| `403 Forbidden` | Developer Token used where Account Token is required (or vice versa) |\n| `429 Too Many Requests` | Rate limit exceeded — max 60 requests per minute per Account Token |\n"
servers:
- url: https://api.ready2order.com/v1
tags:
- name: User
paths:
  /users:
    get:
      tags:
      - User
      summary: List all Users
      description: ''
      operationId: userGetAll
      parameters:
      - name: page
        in: query
        description: Page you want to display
        required: false
        schema:
          type: integer
          example: 1
      - name: limit
        in: query
        description: Items per page
        required: false
        schema:
          type: integer
          example: 25
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    user_id:
                      type: integer
                      example: 1234
                    user_firstName:
                      type: string
                      example: Christoph
                    user_lastName:
                      type: string
                      example: Müller
                    user_username:
                      type: string
                      example: christoph@some-email.com
                    user_printAccess:
                      type: integer
                      example: 1234
                    user_printer:
                      type: integer
                      example: 15
                    user_lastActionAt:
                      type: string
                      example: '2018-11-05 01:23:45'
                    user_lastLoginAt:
                      type: string
                      example: '2018-11-05 01:23:45'
                    user_trainingsMode:
                      type: boolean
                      example: true
                    right_id:
                      type: integer
                      example: 1234
                    loginLog:
                      properties:
                        loginLog_lastActionAt:
                          type: string
                          example: '2018-11-05 01:23:45'
                        loginLog_userAgent:
                          type: string
                          example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6)
                      type: object
                  type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - Bearer: []
    post:
      tags:
      - User
      summary: Create a new User
      description: ''
      operationId: userCreate
      requestBody:
        content:
          application/json:
            schema:
              required:
              - user_username
              - user_password
              - right_id
              properties:
                user_username:
                  type: string
                  example: christoph@email.com
                user_password:
                  type: string
                  example: StrongPassword123!
                user_firstName:
                  type: string
                  example: Christoph
                user_lastName:
                  type: string
                  example: Müller
                user_trainingsMode:
                  type: boolean
                  example: true
                user_printer:
                  type: integer
                  example: 123
                user_printAccess:
                  type: integer
                  example: 2457
                right_id:
                  type: integer
                  example: 1234
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  user_id:
                    type: integer
                    example: 1234
                  user_firstName:
                    type: string
                    example: Christoph
                  user_lastName:
                    type: string
                    example: Müller
                  user_username:
                    type: string
                    example: christoph@some-email.com
                  user_printAccess:
                    type: integer
                    example: 1234
                  user_printer:
                    type: integer
                    example: 15
                  user_lastActionAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_lastLoginAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_trainingsMode:
                    type: boolean
                    example: true
                  right_id:
                    type: integer
                    example: 1234
                type: object
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - Bearer: []
  /users/{id}:
    get:
      tags:
      - User
      summary: Find User by Id
      description: ''
      operationId: userFindById
      parameters:
      - name: id
        in: path
        description: User ID to find
        required: true
        schema:
          type: integer
          example: 123456
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  user_id:
                    type: integer
                    example: 1234
                  user_firstName:
                    type: string
                    example: Christoph
                  user_lastName:
                    type: string
                    example: Müller
                  user_username:
                    type: string
                    example: christoph@some-email.com
                  user_printAccess:
                    type: integer
                    example: 1234
                  user_printer:
                    type: integer
                    example: 15
                  user_lastActionAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_lastLoginAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_trainingsMode:
                    type: boolean
                    example: true
                  right_id:
                    type: integer
                    example: 1234
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer: []
    put:
      tags:
      - User
      summary: Update User by Id
      description: ''
      operationId: userUpdateById
      parameters:
      - name: id
        in: path
        description: User ID to update
        required: true
        schema:
          type: integer
          example: 12345
      requestBody:
        content:
          application/json:
            schema:
              required:
              - right_id
              properties:
                user_username:
                  type: string
                  example: christoph@email.com
                user_password:
                  type: string
                  example: StrongPassword123!
                user_firstName:
                  type: string
                  example: Christoph
                user_lastName:
                  type: string
                  example: Müller
                user_trainingsMode:
                  type: boolean
                  example: true
                user_printer:
                  type: integer
                  example: 123
                user_printAccess:
                  type: integer
                  example: 2457
                right_id:
                  type: integer
                  example: 1234
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  user_id:
                    type: integer
                    example: 1234
                  user_firstName:
                    type: string
                    example: Christoph
                  user_lastName:
                    type: string
                    example: Müller
                  user_username:
                    type: string
                    example: christoph@some-email.com
                  user_printAccess:
                    type: integer
                    example: 1234
                  user_printer:
                    type: integer
                    example: 15
                  user_lastActionAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_lastLoginAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_trainingsMode:
                    type: boolean
                    example: true
                  right_id:
                    type: integer
                    example: 1234
                type: object
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer: []
    delete:
      tags:
      - User
      summary: Delete User by Id
      description: ''
      operationId: userDeleteById
      parameters:
      - name: id
        in: path
        description: User ID to delete
        required: true
        schema:
          type: integer
          example: 12345
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: boolean
                    example: false
                  success:
                    type: boolean
                    example: true
                  msg:
                    type: string
                    example: User was successfully deleted!
                type: object
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer: []
    patch:
      tags:
      - User
      summary: Update Password By Id
      description: ''
      operationId: userUpdatePasswordById
      parameters:
      - name: id
        in: path
        description: User ID to update password
        required: true
        schema:
          type: integer
          example: 1234
      requestBody:
        content:
          application/json:
            schema:
              required:
              - user_password
              properties:
                user_password:
                  type: string
                  example: StrongPassword123!
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  user_id:
                    type: integer
                    example: 1234
                  user_firstName:
                    type: string
                    example: Christoph
                  user_lastName:
                    type: string
                    example: Müller
                  user_username:
                    type: string
                    example: christoph@some-email.com
                  user_printAccess:
                    type: integer
                    example: 1234
                  user_printer:
                    type: integer
                    example: 15
                  user_lastActionAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_lastLoginAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  user_trainingsMode:
                    type: boolean
                    example: true
                  right_id:
                    type: integer
                    example: 1234
                type: object
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer: []
  /users/{id}/signInToken:
    get:
      tags:
      - User
      summary: Get Sign In Token
      description: ''
      operationId: userGetSignInToken
      parameters:
      - name: id
        in: path
        description: User ID to generate token
        required: true
        schema:
          type: integer
          example: 123456
      - name: expiresIn
        in: query
        description: Life-time of token (seconds)
        required: false
        schema:
          type: integer
          example: 60
      requestBody:
        content:
          application/json:
            schema:
              properties:
                crmUserId:
                  type: string
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: boolean
                    example: false
                  token:
                    type: string
                    example: AAA.BBBBBBBBBBBB.CCC
                  issuedAt:
                    type: string
                    example: '2018-11-05 01:23:45'
                  expiresAt:
                    type: string
                    example: '2018-11-05 01:24:45'
                  loginURI:
                    type: string
                    example: https://ur.ready2order.com/sys/login.php?token=AAA.BBBBBBBBBBBB.CCC
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: apiKey
      description: Account Token obtained after completing the authorization flow. See First Steps for details.
      name: Authorization
      in: header
x-tagGroups:
- name: Essentials
  tags:
  - Product
  - Product Group
  - Bill
  - Storno
  - Payment Method
  - Payment Method Type
  - Coupon
  - Coupon Category
  - Discount
  - Discount Group
  - Customer
- name: Gastro
  tags:
  - Order
  - Table
  - Table Area
- name: POS
  tags:
  - Printer
  - Printer Profile
  - Print Job
  - Terminal Transaction
  - User
  - User Roles
- name: Reporting
  tags:
  - Daily Report
  - Accounting Financial Year
  - Export
- name: Reference Data
  tags:
  - Bill Type
  - Customer Group
  - Currency
  - Country
  - Device
  - Language
  - Legal Form
  - Units
  - Vat Rate
- name: Integration
  tags:
  - Account Token
  - Grant Access Token
  - Developer Token
  - Webhook
  - Job Status
- name: Internal
  tags:
  - Account
  - Admin
  - CashboxRegistration
  - ConfirmableAction
  - Constant
  - Item
  - License
  - MobileConstant
  - ReadyPaySellRate
  - Signup
  - Tss