# Centralized API Documentation

> Documentation for Centralized API

## Guides: Documentation
- [Introduction](https://developers.spoton.com/central-api/docs/getting-started.md)
- [Certification Process](https://developers.spoton.com/central-api/docs/certification-process.md)

## Guides: Getting Started
- [SpotOn OAuth - Integration Guide](https://developers.spoton.com/central-api/docs/spoton-oauth-integration-guide.md)
- [Rate Limiting](https://developers.spoton.com/central-api/docs/rate-limiting.md)

## Guides: Business
- [Business Locations Overview](https://developers.spoton.com/central-api/docs/retrieve-locations.md)

## Guides: Menus
- [Menu Overview](https://developers.spoton.com/central-api/docs/menu-overview.md)

## Guides: Orders
- [Orders Overview](https://developers.spoton.com/central-api/docs/create-order.md)

## Guides: Reservations
- [Reservations Overview](https://developers.spoton.com/central-api/docs/reservations-overview.md): Activate a location and manage the full lifecycle of a reservation.

## API Reference: Business
- Location
  - [Retrieve Location Details](https://developers.spoton.com/central-api/reference/businessservice_getlocation.md): Retrieve details for a merchant’s location.

## API Reference: Menu
- Menu Reference
  - [Retrieve all Menu Items](https://developers.spoton.com/central-api/reference/menuservice_listitems.md): Retrieve a list of all menu items for a given location (Express Only)
  - [Retrieve all Menu Modifiers](https://developers.spoton.com/central-api/reference/menuservice_listmodifiers.md): Retrieve a list of all menu modifiers for a given location (Express Only)
  - [Retrieve Reporting Categories](https://developers.spoton.com/central-api/reference/menuservice_listreportingcategories.md): Retrieve a list of all reporting categories for a given location.
- Menus
  - [Retrieve Menus](https://developers.spoton.com/central-api/reference/menuservice_getmenus.md): Retrieve a list of all available menus for a given location.
  - [Retrieve Menu Items](https://developers.spoton.com/central-api/reference/menuservice_getmenuitems.md): Retrieve the items associated with a location's menu.
  - [Retrieve Single Menu](https://developers.spoton.com/central-api/reference/menuservice_getmenu.md): Retrieve a single menu for a given location.

## API Reference: Order
- Ordering
  - [Submit Order](https://developers.spoton.com/central-api/reference/orderservice_submitorder.md): Inject an order into the POS at a given location.
  - [Propose Order](https://developers.spoton.com/central-api/reference/orderservice_proposeorder.md): Validate an order before injection to confirm pricing, taxes, and item availability.
  - [Cancel Order](https://developers.spoton.com/central-api/reference/orderservice_cancelorder.md): Cancel an order on the POS.

## API Reference: Labor
- Break Types
  - [Retrieve Break Types](https://developers.spoton.com/central-api/reference/laborservice_getbreaktypesbylocation.md): Retrieve all break types associated with a specific Business Location ID.
  - [Retrieve Break Type Details](https://developers.spoton.com/central-api/reference/laborservice_getbreaktypedetails.md): Retrieve details for a specific break type.
- Employees
  - [Retrieve Employees](https://developers.spoton.com/central-api/reference/laborservice_getemployeesbylocation.md): Retrieve all employees associated with a specific Business Location ID.
  - [Retrieve Employee Details](https://developers.spoton.com/central-api/reference/laborservice_getemployeedetails.md): Retrieve details for a specific employee.
  - [Create Employee](https://developers.spoton.com/central-api/reference/laborservice_createemployee.md): Create a new employee at a specific Business Location. EXPRESS ONLY
  - [Bulk Create Employees](https://developers.spoton.com/central-api/reference/laborservice_bulkcreateemployees.md): Create multiple employees at a specific Business Location in a single request. EXPRESS ONLY
  - [Update Employee](https://developers.spoton.com/central-api/reference/laborservice_updateemployee.md): Update an existing employee at a specific Business Location. EXPRESS ONLY
  - [Delete Employee](https://developers.spoton.com/central-api/reference/laborservice_deleteemployee.md): Delete an employee from a specific Business Location. EXPRESS ONLY
- Jobs
  - [Retrieve Jobs](https://developers.spoton.com/central-api/reference/laborservice_getjobsbylocation.md): Retrieve all jobs associated with a specific Business Location ID.
  - [Retrieve Job Details](https://developers.spoton.com/central-api/reference/laborservice_getjobdetails.md): Retrieve details for a specific job.
  - [Retrieve Job Details V2](https://developers.spoton.com/central-api/reference/laborservice_getjobdetailsv2.md): Retrieve details for a specific job.
- Shifts
  - [List Shifts](https://developers.spoton.com/central-api/reference/laborservice_getshiftsbylocation.md): Retrieve all shifts associated with a specific Business Location ID. EXPRESS ONLY
  - [Create Shift](https://developers.spoton.com/central-api/reference/laborservice_createshift.md): Create a new shift at a specific Business Location. EXPRESS ONLY
  - [Retrieve Shift Details](https://developers.spoton.com/central-api/reference/laborservice_getshiftdetails.md): Retrieve details for a specific shift. EXPRESS ONLY
  - [Delete Shift](https://developers.spoton.com/central-api/reference/laborservice_deleteshift.md): Delete a shift from a specific Business Location. EXPRESS ONLY
  - [Update Shift](https://developers.spoton.com/central-api/reference/laborservice_updateshift.md): Update an existing shift at a specific Business Location. EXPRESS ONLY
- Time Punches
  - [Retrieve Time Punches](https://developers.spoton.com/central-api/reference/laborservice_gettimepunchesbylocation.md): Retrieve all time punches for a specific Business Location ID within a specified date range.
  - [Retrieve Time Punch Details](https://developers.spoton.com/central-api/reference/laborservice_gettimepunchdetails.md): Retrieve details of a specific time punch.

## API Reference: Loyalty
- Loyalty Consumer
  - [Manage Customer](https://developers.spoton.com/central-api/reference/loyaltyservice_upsertcustomer-1.md): [Upsert] Retrieve customer details using an ID, email address, or phone number.  If the customer does not exist it will be created.  If the customer exists it will be updated.
  - [Accrue Loyalty Points](https://developers.spoton.com/central-api/reference/loyaltyservice_accruecustomer-1.md): Accrue loyalty points for a customer’s order
  - [Redeem Rewards](https://developers.spoton.com/central-api/reference/loyaltyservice_redeemcustomer-1.md): Redeem loyalty promotions for a customer’s order.
  - [Reverse Transaction](https://developers.spoton.com/central-api/reference/loyaltyservice_reversecustomer-1.md): Reverse all loyalty transactions associated with an order (ie. accruals & redemptions).  Only one successful transaction reversal is allowed per order.  All subsequent attempts after the first…
  - [Retrieve Available Promotions](https://developers.spoton.com/central-api/reference/loyaltyservice_calculatecartpromotion-1.md): Retrieve the available promotions that can be applied to a customer’s order.
  - [Retrieve Merchant Loyalty Status](https://developers.spoton.com/central-api/reference/loyaltyservice_getlocationstatus-1.md): Determine if loyalty is active at a merchant’s location.
  - [Lookup Customers](https://developers.spoton.com/central-api/reference/loyaltyservice_lookupcustomers.md): Look up customers at a location using one of two mutually exclusive modes:  - **Search:** set `search_text` (+ optional `max_results`) for a type-ahead query; returns any number of matches. - **Exact…

## API Reference: Reporting
- Orders
  - [Retrieve Orders](https://developers.spoton.com/central-api/reference/reportingservice_getorders.md): Retrieve a list of historical orders for a given location.

## API Reference: Reservation
- Reservation
  - [Activate Location](https://developers.spoton.com/central-api/reference/reservationservice_activatelocation.md): Activate reservations for a location.
  - [List Tables](https://developers.spoton.com/central-api/reference/reservationservice_listtables.md): List the dining tables configured for a location. To assign a table when seating or reseating a party, pass the table's `name` (not its `id`) in the `table_names` field of SeatReservation or…
  - [Seat Reservation](https://developers.spoton.com/central-api/reference/reservationservice_seatreservation.md): Create and seat a reservation at a location.
  - [Cancel Reservation](https://developers.spoton.com/central-api/reference/reservationservice_cancelreservation.md): Cancel a reservation.
  - [Change Party Size](https://developers.spoton.com/central-api/reference/reservationservice_changepartysize.md): Change the party size of a seated reservation.
  - [Reseat Reservation](https://developers.spoton.com/central-api/reference/reservationservice_reseatreservation.md): Reseat a reservation at a new table(s) and/or with a new server(s).
  - [Unseat Reservation](https://developers.spoton.com/central-api/reference/reservationservice_unseatreservation.md): Unseat a seated reservation and remove it from the POS.

## API Reference: Onboarding
- Onboarding
  - [Retrieve Location Candidates](https://developers.spoton.com/central-api/reference/onboardingservice_listlocationcandidates.md): Retrieves a list of locations assigned to the authenticated user that can be onboarded to the partner application.
  - [Onboard Location](https://developers.spoton.com/central-api/reference/onboardingservice_onboardlocation.md): Provide the merchant's Business Location ID to grant a third-party integration API access.
  - [Offboard Location](https://developers.spoton.com/central-api/reference/onboardingservice_offboardlocation.md): Provide the merchant's Business Location ID to revoke a third-party integration's API access. This endpoint supports both User Authorization tokens and Client Credential tokens for authentication.

## API Reference: Webhooks
- Events
  - [Delivery of an API event.](https://developers.spoton.com/central-api/reference/webhookevent_delivery-1.md): ## Verifying signatures  1. Base64-decode the `signature_key` returned on subscription creation (standard alphabet, no `=` padding) to get the raw key bytes. 2. Compute HMAC-SHA256 over the raw…