API Guides

Explore the comprehensive guides below to effectively integrate with and leverage the POS Hub API:

Core Concepts

• Application Anatomy: Understand the structure and components of a POS Hub application.
• Authorization: Learn how to authenticate and authorize API requests using OAuth2.
• Authorization Using API: Automate connecting your application to a location via the API (reseller token, create account/location, onboarding URL, authorize).
• Environments: Overview of sandbox, staging, and production environments.
• Retry Policy: Details on implementing retries and backoff for reliable communication.
• Error Handling: Guidance on interpreting and handling API errors.

Data Structure

• Menu Structure: Understanding the hierarchical structure of menus, categories, items, and modifiers.
• Opening Hours: Understanding business hours, service availability, and how menu-level overrides work.

Endpoints

• Endpoints Reference: Detailed documentation for all available API endpoints.
• Request & Response Examples: Sample request and response payloads for common operations.
• Webhooks: Real-time event delivery via webhook integration.