Ready2order Customer API
The Customer API from Ready2order — 3 operation(s) for customer.
OpenAPI Specification
openapi: 3.0.0
info:
title: ready2order Public Account Token Customer 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: Customer
paths:
/customers:
get:
tags:
- Customer
summary: List all Customers
description: ''
operationId: customerGetAll
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:
customer_id:
type: integer
example: 9999
customer_number:
type: integer
example: 9999
customer_name:
type: string
example: Maxi's custom name
vatId:
type: string
example: ATU1234567
customer_notes:
type: string
example: Some custom notes
customerCategory_id:
type: integer
example: 9999
customer_birthday:
type: string
example: '1991-09-20'
address:
type: array
items:
properties:
invoice:
type: array
items:
properties:
salutation:
type: string
example: Herr
title:
type: string
example: Professor
customer_company:
type: string
example: Maxi Gmbh
lastName:
type: string
example: Muster
firstName:
type: string
example: Max
zip:
type: string
example: 1030
city:
type: string
example: WIen
street:
type: string
example: Straße 1
country:
type: string
example: AT
email:
type: string
example: example@ready2order.com
phone:
type: string
example: +43 664 12345678
type: object
type: object
type: object
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- Bearer: []
post:
tags:
- Customer
summary: Create a new Customer
description: ''
operationId: customerCreate
requestBody:
content:
application/json:
schema:
required:
- customerCategory_id
properties:
customerCategory_id:
type: integer
example: 1126
birthday:
type: string
example: '1991-09-20'
city:
type: string
example: Wien
company:
type: string
example: Maxi Gmbh
email:
type: string
example: example@ready2order.com
firstName:
type: string
example: Max
lastName:
type: string
example: Muster
customer_name:
type: string
notes:
type: string
example: Some custom notes
customer_number:
type: integer
example: 9999
phone:
type: string
example: +43 12345678
salutation:
type: string
example: Herr
street:
type: string
example: Straße 1
title:
type: string
example: Herr
uid:
type: string
example: ATU1234567
zip:
type: string
example: 1030
address:
type: array
items: []
type: object
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
customer_id:
type: integer
example: 9999
customer_number:
type: integer
example: 9999
customer_name:
type: string
example: Maxi's custom name
vatId:
type: string
example: ATU1234567
customer_notes:
type: string
example: Some custom notes
customerCategory_id:
type: integer
example: 9999
customer_birthday:
type: string
example: '1991-09-20'
address:
type: array
items:
properties:
invoice:
type: array
items:
properties:
salutation:
type: string
example: Herr
title:
type: string
example: Professor
customer_company:
type: string
example: Maxi Gmbh
lastName:
type: string
example: Muster
firstName:
type: string
example: Max
zip:
type: string
example: 1030
city:
type: string
example: WIen
street:
type: string
example: Straße 1
country:
type: string
example: AT
email:
type: string
example: example@ready2order.com
phone:
type: string
example: +43 664 12345678
type: object
type: object
type: object
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- Bearer: []
/customers/{id}:
get:
tags:
- Customer
summary: Find Customer by Id
description: ''
operationId: customerFindById
parameters:
- name: id
in: path
description: Customer ID to find
required: true
schema:
type: integer
example: 123456
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
customer_id:
type: integer
example: 9999
customer_number:
type: integer
example: 9999
customer_name:
type: string
example: Maxi's custom name
vatId:
type: string
example: ATU1234567
customer_notes:
type: string
example: Some custom notes
customerCategory_id:
type: integer
example: 9999
customer_birthday:
type: string
example: '1991-09-20'
address:
type: array
items:
properties:
invoice:
type: array
items:
properties:
salutation:
type: string
example: Herr
title:
type: string
example: Professor
customer_company:
type: string
example: Maxi Gmbh
lastName:
type: string
example: Muster
firstName:
type: string
example: Max
zip:
type: string
example: 1030
city:
type: string
example: WIen
street:
type: string
example: Straße 1
country:
type: string
example: AT
email:
type: string
example: example@ready2order.com
phone:
type: string
example: +43 664 12345678
type: object
type: object
type: object
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
security:
- Bearer: []
put:
tags:
- Customer
summary: Update Customer by Id
description: ''
operationId: customerUpdate
parameters:
- name: id
in: path
description: Customer ID to update
required: true
schema:
type: integer
example: 12345
requestBody:
content:
application/json:
schema:
properties:
customerCategory_id:
type: integer
example: 1126
birthday:
type: string
example: '1991-09-20'
city:
type: string
example: Wien
company:
type: string
example: Maxi Gmbh
email:
type: string
example: example@ready2order.com
firstName:
type: string
example: Max
lastName:
type: string
example: Muster
customer_name:
type: string
notes:
type: string
example: Some custom notes
customer_number:
type: integer
example: 9999
phone:
type: string
example: +43 12345678
salutation:
type: string
example: Herr
street:
type: string
example: Straße 1
title:
type: string
example: Herr
uid:
type: string
example: ATU1234567
zip:
type: string
example: 1030
address:
type: array
items: []
type: object
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
customer_id:
type: integer
example: 9999
customer_number:
type: integer
example: 9999
customer_name:
type: string
example: Maxi's custom name
vatId:
type: string
example: ATU1234567
customer_notes:
type: string
example: Some custom notes
customerCategory_id:
type: integer
example: 9999
customer_birthday:
type: string
example: '1991-09-20'
address:
type: array
items:
properties:
invoice:
type: array
items:
properties:
salutation:
type: string
example: Herr
title:
type: string
example: Professor
customer_company:
type: string
example: Maxi Gmbh
lastName:
type: string
example: Muster
firstName:
type: string
example: Max
zip:
type: string
example: 1030
city:
type: string
example: WIen
street:
type: string
example: Straße 1
country:
type: string
example: AT
email:
type: string
example: example@ready2order.com
phone:
type: string
example: +43 664 12345678
type: object
type: object
type: object
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
security:
- Bearer: []
delete:
tags:
- Customer
summary: Delete Customer by Id
description: ''
operationId: customerDelete
parameters:
- name: id
in: path
description: Customer 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: Customer was successfully deleted!
type: object
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
security:
- Bearer: []
/customers/merge:
post:
tags:
- Customer
summary: Merge Customers
description: ''
operationId: customerMergeCustomers
requestBody:
content:
application/json:
schema:
required:
- masterCustomer
- customerIds
properties:
masterCustomer:
description: Customer into which the list of customerIds should be merged into.
type: integer
example: 5924
customerIds:
description: List of customers which shall be merged into masterCustomer.
type: array
items:
type: integer
example:
- 1
- 2
- 3
- 4
type: object
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
error:
type: boolean
example: false
success:
type: boolean
example: true
msg:
type: string
example: Merged successfully!
type: object
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
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