API docs by Redocly

ready2order Public API (R2-2025.38.5)

Download OpenAPI specification:

Intro

Authentication

  • ready2order API uses token-based authentication.
  • all requests require an Authorization HTTP header with the appropriate token.
  • ensure the header is spelled correctly as Authorization.

Getting Started

1. Obtain a Developer Token

  • Endpoint: Register at api.ready2order.com.
  • Details: No Authorization header is needed at this stage since you don’t yet have a token. Follow the signup instructions and provide the required request data.

2. Request a Grant Access Token

  • Endpoint: POST /v1/developerToken/grantAccessToken
  • Headers:
    • Authorization: Bearer <Developer-Token>
  • Request Body:
    • callbackUri (optional): The URI to redirect to after approval or denial (e.g., http://www.ready2order.com?your-extra-param=123).
  • Response:
    • grantAccessToken: The token for the next step.
    • grantAccessUri: The full URI to approve access.
  • Note: Use the grantAccessUri in the next step.

3. Obtain an Account Token

  • Steps:
    1. Navigate to the grantAccessUri from the previous step.
    2. Log in with existing ready2order account credentials.
    3. Approve or deny access via the confirmation dialog.
  • Redirect: If a callbackUri was specified, the API redirects to it with these parameters:
    • accountToken: The Account Token (if approved).
    • grantAccessToken: The Grant Access Token used.
    • status: approved or denied.
  • Example Redirect: http://www.ready2order.com?your-extra-param=123&accountToken=<ACCOUNT_TOKEN>&grantAccessToken=<GRANT_ACCESS_TOKEN>&status=approved
  • Expiration: The Grant Access Token expires after 10 minutes if not used.

Token Types

Developer Token

  • Purpose: Identifies the developer using the API. Used to request permissions for existing ready2order accounts.
  • How to Obtain:
    1. Visit api.ready2order.com.
    2. Sign up as a developer.
    3. Follow the instructions in the confirmation email, which includes your Developer Token.
  • Usage: Only required for requesting a Grant Access Token.

Grant Access Token

  • Purpose: Enables a developer to request permissions for ready2order accounts.
  • Expiration: Valid for 10 minutes. If not approved within this time, you must request a new one.

Account Token

  • Purpose: Grants access to account-specific data, such as products, product groups, customers, and more.
  • Requirement: Must be included in the Authorization header for all account data interactions.

Rate limit

  • Limit: 60 requests per minute per Account Token.
  • Exceeded Response Status: HTTP 429

Webhooks

Overview

ready2order supports webhooks to notify your application of events in real time, providing an optimal experience.

Available Events

Event Description
product.created Triggered when a new product is created.
product.updated Triggered when an existing product is updated.
product.deleted Triggered when an existing product is deleted.
productGroup.created Triggered when a new product group is created.
productGroup.updated Triggered when an existing product group is updated.
productGroup.deleted Triggered when an existing product group is deleted.
invoice.created Triggered when a new receipt (e.g., bill, invoice, payment receipt) is created.
orderItem.created Triggered when a gastro-order is booked on a table.

Payloads

  • For created and updated Events:
    • The full object is sent in the resource array of the webhook payload, eliminating the need for additional API calls.
  • For deleted Events:
    • Only the IDs of the deleted resources are provided.

Getting Started

  1. Set Up Webhook URL: Configure your webhook endpoint in the Webhook section of the API dashboard.
  2. Subscribe to Events: Select the events (listed above) you want to receive notifications for.