Watch Demo
CALL US TOLL FREE (855) 738-3555

Application Programming Interface

Items

GET /item/

 

GET /item/(int: item_id)/

Returns an item that is present at (item_id). 

Query Parameters:
  • item_id – the item_id of the item
Status Codes:
  • 200 – No error has occured
  • 404 – No item with that item_id

DELETE /item/

 

DELETE /item/(int: item_id)/

Deletes an item that is present at (item_id). 

Query Parameters:
  • item_id – the item_id of the item
Status Codes:
  • 200 – No error has occured
  • 404 – No item with that item_id

POST /item/

 

POST /item/(int: item_id)/

Returns a newly created Item with the (item_id). 

Query Parameters:
  • item_id – This value is the unique item_id of the item
  • restaurant_id – This value will be the unique ID of the location
  • temp_ids – A value that needs to increase by one everytime
  • printers – This value will contain the IP address of the printers the
    items will print to. If the item is being printed to more than one printer it has to be seperated by a comma.
  • mod_id – This value is the unique id of the modifier
  • mod_price – This value is the price of the the modifier being added to the item
  • item_tax – This value is the tax value of a specific item
  • pin_number
     – This value is the pin number of the user/employee adding the item to the order. In other cases if the order is an online web order you will have to specify a specific pin number to report it was online orders.
  • customer
     – This value is a text value of the customer name
  • sess_id
     – Session ID is unique per every order. It the way of associating the items in the order
  • dish_name
     – This is a text value for the item name
  • qty
     – The quantity of the item being ordered
  • item_discount
     – This is the positive numeric value of the discount associated to the product.
  • customertype
     – This is a text value for the customer type
  • item_discount_text
     – This is text value for the reason the item was discounted
  • printed
     – Check if the item printed to the kitchen printer
  • 1 = Printed
  • 0 = Did Not Print
  • date
     – The value has to be a unix timestamp of the time/date the order is purchased
  • co_price
     – The price of the item
Status Codes:
  • 200 – Ok, Item created
  • 500– Error, Item was not created

PUT /item/

PUT /item/(int: item_id)/
Updates the item associated to the (item_id). 

Query Parameters:
  • item_id – This value is the unique item_id of the item
  • restaurant_id – This value will be the unique ID of the location
  • temp_ids – A value that needs to increase by one everytime
  • printers – This value will contain the IP address of the printers the
    items will print to. If the item is being printed to more than one printer it has to be seperated by a comma.
  • mod_id – This value is the unique id of the modifier
  • mod_price – This value is the price of the the modifier being added to the item
  • item_tax – This value is the tax value of a specific item
  • pin_number
     – This value is the pin number of the user/employee adding the item to the order. In other cases if the order is an online web order you will have to specify a specific pin number to report it was online orders.
  • customer
     – This value is a text value of the customer name
  • sess_id
     – Session ID is unique per every order. It the way of associating the items in the order
  • dish_name
     – This is a text value for the item name
  • qty
     – The quantity of the item being ordered
  • item_discount
     – This is the positive numeric value of the discount associated to the product.
  • customertype
     – This is a text value for the customer type
  • item_discount_text
     – This is text value for the reason the item was discounted
  • printed
     – Check if the item printed to the kitchen printer
  • 1 = Printed
  • 0 = Did Not Print
  • date
     – The value has to be a unix timestamp of the time/date the order is purchased
  • co_price
     – The price of the item
Status Codes:
  • 200 – Ok, Item was update
  • 500– Error, Item was not updated

Orders

GET /order/

 

GET /order/(int: order_id)/

Returns an order that is present at (order_id). 

Query Parameters:
  • order_id – the order_id of the order
Status Codes:
  • 200 – No error has occured
  • 404 – No order with that order_id

 

 

DELETE /order/

 

DELETE /order/(int: order_id)/

Deletes an order that is present at (order_id). 

Query Parameters:
  • order_id – the oder_id of the order
Status Codes:
  • 200 – No error has occured
  • 404 – No order with that order_id

 

 

POST /order/

 

POST /order/(int: order_id)/

Creates an order that with the (order_id). 

Query Parameters:
  • order_id – The order_id of the order
  • comment – Comments that are on the order
  • restaurant_id – This value is the unique ID of the location
  • amt_credit – Amount credited at the time of order.
  • date – This value is a unix timestamp for the date of the order
  • cheque_no – This value is for the check number
  • totalprice – Price for total order.
  • delivery_charge – Charge for delivered orders
  • tip – This value is the amount that is being tipped in the order absolute value
  • delivery_process – This is value is for how delivered for that order
  • show_in_xml – This column used for xml output.
  • totaldisc – This values is the total discount applied to the order in a positive absolute value
  • l_name – This value is the Last name of the customer
  • f_name – This value is the First name of the customer
  • paid – If the order is Paid = 1 or Not Paid = 0
  • payable – This value is for the amount that needs to be paid for the balance
  • device – Its single character to speicfy device ipad or phone
  • amt_check – This value is the amount that is being paid with a check
  • pin_number – This is the pin number of the employee that completed the payment
  • sess_id – This value is the session unique session ID for each order
  • totaltax – This value is a summed total of the taxes on the order
  • amt_cash – This value is the amount that was paid in cash
  • cust_phone – This value is for the customer phone number
Status Codes:
  • 200 – Ok, Order Created
  • 404 – No order with that order_id

 

 

PUT /order/

 

PUT /order/(int: order_id)/

Updates an order that is present at (order_id). 

Query Parameters:
  • order_id – The order_id of the order
  • comment – Comments that are on the order
  • restaurant_id – This value is the unique ID of the location
  • amt_credit – Amount credited at the time of order.
  • date – This value is a unix timestamp for the date of the order
  • cheque_no – This value is for the check number
  • totalprice – Price for total order.
  • delivery_charge – Charge for delivered orders
  • tip – This value is the amount that is being tipped in the order absolute value
  • delivery_process – This is value is for how delivered for that order
  • show_in_xml – This column used for xml output.
  • totaldisc – This values is the total discount applied to the order in a positive absolute value
  • l_name – This value is the Last name of the customer
  • f_name – This value is the First name of the customer
  • paid – If the order is Paid = 1 or Not Paid = 0
  • payable – This value is for the amount that needs to be paid for the balance
  • device – Its single character to speicfy device ipad or phone
  • amt_check – This value is the amount that is being paid with a check
  • pin_number – This is the pin number of the employee that completed the payment
  • sess_id – This value is the session unique session ID for each order
  • totaltax – This value is a summed total of the taxes on the order
  • amt_cash – This value is the amount that was paid in cash
  • cust_phone – This value is for the customer phone number
Status Codes:
  • 200 – Ok, Order Updated
  • 404 – No order with that order_id

 

Payments

 

GET /payment/

 

GET /payment/(int: payment_id)/

Returns a payment entry that is present at (payment_id). 

Query Parameters:
  • payment_id – the payment_id of the payment
Status Codes:
  • 200 – No error has occured
  • 404 – No payment with that payment_id

 

 

DELETE /payment/

 

DELETE /payment/(int: payment_id)/

Deletes a payment that is present at (payment_id). 

Query Parameters:
  • payment_id – the pament_id of the payment
Status Codes:
  • 200 – No error has occured
  • 404 – No payment with that payment_id

 

 

POST /payment/

 

POST /payment/(int: payment_id)/

Creates a payment entry with an (payment_id). 

Query Parameters:
  • payment_id – The payment_id of the payment
  • amt_cash – The amount paid in cash
  • amt_chq – The amount paid in check
  • amt_credit – The amount paid in credit card
  • amt_gift – The amount paid in gift card
  • amt_net_payable – The balance amount need to pay.
  • amt_reward – The amount paid in rewards card
  • card_type – The ID of the card type
  • cc4 – The last 4 digits of the credit card number
  • chq_num – The check number
  • credit_trans_id – Transaction ID of the credit card purchase
  • deposit – The amount that is depositedinto an order
  • fname – This value is the first name of the card holder
  • giftcardid – This value is the gift card id
  • lname – This value is the last name of the card holder
  • rest_id – Restaurant ID
  • sess_id – This is the session id for the payment
  • time – This is the value for unix timestamp
  • tip – This value is the total tip that is on the payment
  • tipsur_tax – This value is the total surcharge or tax on the tip
  • tipsurcharge – This value is the surcharge for tips when services are enabled
Status Codes:
  • 200 – No error has occured
  • 404 – No payment with that payment_id

 

 

PUT /payment/

 

PUT /payment/(int: payment_id)/

Updates a payment that is present at (payment_id). 

Query Parameters:
  • payment_id – The payment_id of the payment
  • amt_cash – The amount paid in cash
  • amt_chq – The amount paid in check
  • amt_credit – The amount paid in credit card
  • amt_gift – The amount paid in gift card
  • amt_net_payable – The balance amount need to pay.
  • amt_reward – The amount paid in rewards card
  • card_type – The ID of the card type
  • cc4 – The last 4 digits of the credit card number
  • chq_num – The check number
  • credit_trans_id – Transaction ID of the credit card purchase
  • deposit – The amount that is depositedinto an order
  • fname – This value is the first name of the card holder
  • giftcardid – This value is the gift card id
  • lname – This value is the last name of the card holder
  • rest_id – Restaurant ID
  • sess_id – This is the session id for the payment
  • time – This is the value for unix timestamp
  • tip – This value is the total tip that is on the payment
  • tipsur_tax – This value is the total surcharge or tax on the tip
  • tipsurcharge – This value is the surcharge for tips when services are enabled
Status Codes:
  • 200 – No error has occured
  • 404 – No payment with that payment_id

 

Privacy Policy
Google+