How to Start

Purpose of API Documentation

The purpose of the API documentation for OrderOut is to provide developers with the necessary technical details to integrate OrderOut's online ordering solutions with their existing restaurant POS systems. It outlines endpoints, request/response formats, authentication methods, and usage examples, enabling seamless order management, kitchen printing, and delivery processing through automated systems. This ensures smooth integration and optimal functionality for restaurants using OrderOut's services. This documentation aims to:

  • Integration Guidance: Assist developers in connecting OrderOut’s online ordering system with their restaurant POS systems.
  • API Endpoints: List and describe the endpoints available for managing orders, automating kitchen printing, and processing deliveries.
  • Authentication: Detail the methods required to securely access the API.
  • Usage Examples: Offer practical examples and sample code to demonstrate API usage.

Base URL

To interact with the OrderOut API, you will need to send HTTP requests to the appropriate endpoints. All endpoints are relative to the base URL provided below:

Base URL: https://api.orderout.co/api