SimplicityPOS | Blueprints

Get Specific Table Information

Details

Call Details

Returns specific details about a given table, including any open tickets at the table (based on unique location ID and unique table ID)

Additional message

All unique location IDs will be obtained from SimplicityPOS (as all restaurants must be registered with SimplicityPOS prior to Go-Live). A test location is set up as "1234567" for all users.

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Description

Unique location ID assigned to registered location (i.e. 1234567 for the test system)

Parameter Name

Parameter Type

Description

Unique table ID that exists within the system (i.e. 1 on the test system). This can be gathered through "Get Table Info" call, using the "pos_table_id" object.

Example Call

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Additional message:

Get Ticket Details

Details

Call Details

Returns all details of a specific ticket (based on unique location ID & unique ticket ID)

Additional message

All unique location IDs will be obtained from SimplicityPOS (as all restaurants must be registered with SimplicityPOS prior to Go-Live). A test location is set up as "1234567" for all users.

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Description

Unique location ID assigned to registered location (i.e. 1234567 for the test system)

Parameter Name

Parameter Type

Description

Unique ticket ID that exists within the system (i.e. 7820). This can be gathered through "Get Tickets" call.

Example Call

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Additional message:

Create Ticket

Details

Call Details

Creates a new ticket in the Point of Sale requested (based on unique location ID). Duplicate "References" are not allowed

Additional message

All unique location IDs will be obtained from SimplicityPOS (as all restaurants must be registered with SimplicityPOS prior to Go-Live). A test location is set up as "1234567" for all users.

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Description

Unique location ID assigned to registered location (i.e. 1234567 for the test system)

Parameter Name

Parameter Type

Description

Revenue Center ID that exists within the system (i.e. 1 on the test system). This can be gathered through "Get Location Info" call.

Parameter Name

Parameter Type

Description

Order Type ID that exists within the system (i.e. 101 on the test system).

Parameter Name

Parameter Type

Description

Custom name you want to assign to the ticket (16-character limit).

Parameter Name

Parameter Type

Description

Employee ID to open the ticket under (i.e. 9999999 on the test system).

Example Call

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Additional message:

Create Ticket

Details

Call Details

Adds payment details (such as tip/payment) to a specific ticket when payment is accepted external to the POS.

Additional message

All unique location IDs will be obtained from SimplicityPOS (as all restaurants must be registered with SimplicityPOS prior to Go-Live). A test location is set up as "1234567" for all users.

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Description

Unique location ID assigned to registered location (i.e. 1234567 for the test system)

Parameter Name

Parameter Type

Description

Amount to be paid on the ticket (includes tip amount)

Parameter Name

Parameter Type

Description

Tip amount to be added to the ticket

Parameter Name

Parameter Type

Description

Tender type in the POS that is used to add the payment to a ticket (used for reconciliations).

Parameter Name

Parameter Type

Description

Option that determines if a discount should be added to the ticket (0=NO, 1=YES).

Parameter Name

Parameter Type

Description

Amount of discount to be added to the ticket.

Parameter Name

Parameter Type

Description

Discount object in the system to be used.

Parameter Name

Parameter Type

Description

Employee ID to pay the ticket under.

Example Call

Endpoint

Method

Parameters

Parameter Name

Parameter Type

Additional message:

API Error Codes

Details



Ticket#: Success
1:  Success
-1: Ticket not found/Does not exist
-2: Revenue Center not found/Does not exist
-3: Tender Type not found/Does not exist
-4: Parameter does not exist (i.e. discount object)
-5: Ticket not fully tendered
-6: Need more payment info
-7: Illegal tips declared
-8: Invalid payment
-9: Employee not authorized/Cannot clock in
-11: Ticket Name not unique/table in use
-12: Employee does not exist</br>
-13: Invalid database object/Invalid Check Item/Invalid Modifier
-14: Incorrect Menu level
-15: Ticket open on system
-16: Check is empty
-17: Aloha interface not running
-18: Discount too much
-100: General Error
-101: Check not service totaled
-102: Location is not active
-103: Discount not supported

Blueprints

Get Location Information

Get Table Information

Get Specific Table Information

Get Employee Information

Get Open Tickets

Get Ticket Details

Get Menu Details #1

Get Menu Details #2

Get All Ticket Info

Create Ticket

Create Ticket

Void Ticket

API Error Codes

Blueprints

Get Location Information

Get Table Information

Get Specific Table Information

Get Employee Information

Get Open Tickets

Get Ticket Details

Get Menu Details #1

Get Menu Details #2

Get All Ticket Info

Create Ticket

Create Ticket

Void Ticket

API Error Codes

Add New Restaurant