PAR OPS Insights & Delivery API

This API is based on REST principles.

To gain access you will need an API Key; please contact PAR OPS Insights & Delivery to have an API key created for you.

All requests to the PAR OPS Insights & Delivery API must be via HTTPS.

Base URL

<your PAR-provided base URL>

Reach out to your PAR representative for the Base URL.

Common Usage Scenarios

Retrieving daily transactional data for an organization

1. For the organization make a call to /organizations.
2. Inspect the response: organization.locations for a list of locations.
3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/retail_transactions?date={date}

Retrieving daily financial data for an organization

1. For the organization make a call to /organizations.
2. Inspect the response: organization.locations for a list of locations.
3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/summary?date={date}

Retrieving daily time punch data for an organization

1. For the organization make a call to /organizations.
2. Inspect the response: organization.locations for a list of locations.
3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/time_cards?date={date}

Notes

All times are in the local timezone of the location, unless otherwise noted.