External Seating API

Integrate third-party reservation platforms and custom seating management solutions with your POS system.

Overview

The External Seating API enables integration between external reservation platforms and your POS system. This allows restaurants using third-party booking systems or custom reservation solutions to maintain synchronization with their POS.

When to Use External Seating

Use the external seating system when:

  • You're already using a third-party reservation platform (OpenTable, Resy, etc.)
  • You have a custom-built reservation system
  • You need to aggregate reservations from multiple sources
  • You want flexibility in your seating management logic

API Documentation

The complete API reference for the External Seating system is hosted on Apiary, providing interactive documentation with live examples and testing capabilities.

View Full API Documentation

Access the complete API reference with interactive examples, request/response schemas, and live testing tools.

Open API Documentation

Key Features

Reservation Synchronization

Sync reservation data between external systems and your POS:

  • Name
    Create Reservations
    Description

    Push reservations from external platforms to the POS

  • Name
    Update Reservations
    Description

    Sync modifications to existing reservations

  • Name
    Cancel Reservations
    Description

    Propagate cancellations across systems

  • Name
    Real-time Updates
    Description

    Receive webhook notifications for reservation changes

Multi-Platform Support

Integrate with various reservation platforms:

  • Name
    Third-Party Platforms
    Description

    Connect popular booking platforms like OpenTable, Resy, or Yelp Reservations

  • Name
    Custom Systems
    Description

    Integrate proprietary or custom-built reservation systems

  • Name
    Multiple Sources
    Description

    Aggregate reservations from various channels into the POS

  • Name
    Unified View
    Description

    Maintain a single source of truth for all reservations

Flexible Data Models

Support for various reservation data structures:

  • Custom fields and attributes
  • Platform-specific metadata
  • Flexible guest information formats
  • Extensible note fields
  • Tags and categorization

Status Management

Track reservation lifecycle:

  • Pending/Confirmed states
  • Check-in status
  • No-show tracking
  • Cancellation reasons
  • Wait times and delays

Integration Scenarios

Third-Party Platform Integration

Connect popular reservation platforms to your POS:

  1. Platform Webhook - Receive reservation from external platform
  2. Validate Data - Transform to POS-compatible format
  3. Sync to POS - Create/update reservation via External Seating API
  4. Confirm Sync - Return success status to platform
  5. Monitor Changes - Handle updates and cancellations

Custom Booking System

Integrate your proprietary reservation system:

  • Build custom booking interface
  • Store reservations in your database
  • Sync to POS for operational use
  • Receive POS updates via webhooks
  • Maintain bidirectional sync

Aggregation Service

Combine reservations from multiple sources:

  • Collect reservations from various platforms
  • Deduplicate and validate entries
  • Sync consolidated view to POS
  • Manage conflicts and overlaps
  • Provide unified reporting

Differences from Built-in Seating

FeatureExternal SeatingBuilt-in Seating
Seating ChartsExternal system manages floor plansIntegrated POS floor plans
Table AssignmentManual or external logicAutomatic POS assignment
AvailabilitySynced from external sourceReal-time POS calculation
Use CaseThird-party platforms, custom systemsAll-in-one POS solution
FlexibilityHigh - custom data structuresStandardized POS formats

Authentication

The External Seating API uses the same HMAC-SHA256 authentication as other Shift4 APIs.

For authentication details, see the Authentication documentation.

Getting Started

  1. Review the API Documentation - Explore endpoints and data models on Apiary
  2. Assess Your System - Determine how your external platform will integrate
  3. Obtain API Credentials - Contact Shift4 support for your API keys
  4. Map Data Structures - Plan field mappings between systems
  5. Implement Sync Logic - Build bidirectional synchronization
  6. Test Integration - Validate in sandbox environment
  7. Configure Webhooks - Set up real-time notifications
  8. Deploy to Production - Launch your integrated system

Webhooks

Subscribe to reservation events for real-time updates:

  • Reservation Created - New reservation added in POS
  • Reservation Updated - Reservation details modified
  • Reservation Cancelled - Reservation cancelled
  • Guest Checked In - Party arrived and seated

For webhook implementation, see the Webhooks documentation.

Support

Need help with the External Seating API?

Was this page helpful?