Getting Started - PAR Ordering to Third Party Integration With POS

Overview

This guide helps PARTech development partners integrate their POS systems with the PAR Ordering dispatch system. The integration uses RESTful APIs secured with JWT-based authentication and HMAC-SHA256 payload signing.

Key Features

• Real-time Menu Synchronization - Keep menus up-to-date across all channels
• Order Validation - Validate orders before payment processing
• Secure Authentication - JWT tokens with HMAC-SHA256 signatures
• Asynchronous Processing - Handle long-running operations efficiently
• Order Status Tracking - Monitor orders from submission to completion

Integration Model

To integrate with PAR Ordering, PARTech development partners must implement the RESTful APIs described in this documentation. The PAR Ordering dispatch system will send orders to the endpoints you implement.

1. Implementing the API endpoints described in this guide:

   • Order validation endpoint (POST /posnext/order/validate)
   • Order submission endpoint (POST /posnext/order/submit)
   • Order status retrieval endpoint (GET /posnext/orders/{orderId})
   • Menu synchronization endpoint (POST /posnext/menus)

2. Receiving orders from PAR Ordering: The PAR Ordering system will make HTTP requests to the endpoints you implement based on PAR Ordering's specification to:

   • Validate orders before submission
   • Submit orders for processing
   • Retrieve order status (for polling after 202 responses)
   • Synchronize menu data

   Note: Requests will contain PAR-provided OrganizationId and LocationId values. You must map these to your internal business/brand or location identifiers (see ID Mapping Requirement).

3. Responding with appropriate status codes and payloads as specified in this documentation

   Flow Direction: PAR Ordering > Your API Implementation

   PAR Ordering initiates all API calls to the endpoints you implement based on this specification. Your implementation receives these calls, processes them according to your business logic, and returns responses in the format specified in this guide.

Integration Approach

You will implement RESTful API endpoints based on the PAR Ordering specification that PAR Ordering will call. The PAR Ordering dispatch system sends orders to the endpoints you implement. Your role is to:

• Implement and host the RESTful API endpoints specified in this guide
• Receive and process order requests from PAR Ordering
• Validate and respond with appropriate status codes and payloads
• Handle authentication by validating JWT tokens sent by PAR Ordering
• Ensure security by validating payload signatures

PAR Ordering acts as the client, making requests to the endpoints you implement. Your system acts as the server receiving and processing those requests.

PAR Ordering provides the following identifiers that you must use in your integration:

1. SharedId: A shared secret (minimum 10 characters) provided by PAR Ordering, used for:
   • JWT token signing
   • Payload signature generation
2. OrganizationId: Organization identifier provided by PAR Ordering.
3. LocationId: Location identifier provided by PAR Ordering for each location/restaurant.
4. API Endpoints: Implement the required RESTful API endpoints (see PAR Ordering API Endpoints) that PAR Ordering will call.