Download the PHP package lfrichter/omnivore without Composer
On this page you can find all versions of the php package lfrichter/omnivore. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lfrichter/omnivore
More information about lfrichter/omnivore
Files in lfrichter/omnivore
Package omnivore
Short Description Laravel Facade to easy access Omnivore Api
License MIT
Homepage https://github.com/lfrichter/omnivore
Informations about the package omnivore
Omnivore Facade 🍹
Installation
Via Composer
If you do not run Laravel 5.5 (or higher), then add in config/app.php:
-
service provider:
- facade to aliases:
Usage
Place these values into your .ENV
Tickets functions
Interact with tickets of claimed locations from the POS.
List tickets for location
Open a new ticket
Omnivore documentation
To open a new ticket you'll need the following:
- a valid employee id for the Location — we'll use EMPLOYEEID
- a valid order type id for the Location — we'll use ORDERTYPEID
- a valid revenue center id for the Location — we'll use REVENUECENTERID
- a valid table id for the Location — we'll use TABLEID
Sample JSON object to be send
You should get a 201 CREATED HTTP response to let you know your ticket has been added. You'll also get the ticket id field in the response which you need to add menu items or make payments.
Don't Send Items to the Kitchen
Did you notice the auto_send field we used when we opened the ticket? It determines whether new menu items are sent to the kitchen immediately, or if they're held until the ticket is paid. By default it's true which means as soon as you add a menu item to the ticket it will be made by the restaurant. If you set it to false nothing will be made until the ticket is paid in full and closed.
Retrieve data for a specific ticket
Void a locations ticket
List discounts for a ticket
Apply a discount to a ticket
Retrieve a discount that was applied to a ticket
List items on a ticket
You'll get a list of menu items each with two important pieces of information:
- the menu item
id
- the list of acceptable
price_levels
for the item
Add an item to a ticket
Omnivore documentation
For this example pick an item that looks tasty and note its id
then choose an arbitrary price_levels
element and note its id
as well. We'll refer to them as MENUITEMID and PRICELEVELID respectively. Now, let's place an order on the ticket from earlier.
Sample JSON object to be send
Making an Order with Modifiers
Let's say you've picked out a menu item, looked up its modifier groups, and figured out which modifiers you want to apply. You've noted all the modifier id values and the id for the appropriate price_level on each one. That's a lot, but now you're ready to place a personalized order.
Sample JSON object to be send
Retrieve an item from a ticket
Void an item from a ticket
List modifiers form a ticket
Retrieve a modifier form a ticket
List dicounts on a ticket
Retrieve a discount from a ticket
List payments
Retrieve a payment
Make a payment where a card is not present
Sample JSON object to be send
Make a payment where a card is present
Sample JSON object to be send
Make a payment with a 3rd party
Sample JSON object to be send
Make a payment with a card
Sample JSON object to be send
Make a payment with cash
Tables functions
Interact with tables of claimed locations from the POS.
List tables of claimed locations
Retrieve data for a specific table
General functions
Interact with general labeled actions of claimed locations from the POS.
List all locations claimed.
Retrieve information about a location
List employees of a location
Retrieve data of a specific location
List location types (Order Types)
Retrieve a locations type
List the types of tender the location accepts
Retrive the tender type
List a locations revenue centers
Retrieve information of a payment center
List the discounts of a location
Retrieve the discount
Grab the menu from POS
List the menu categories
Retrieve a category
List items in a menu
Retrieve a menu item
List location modifiers
Retrieve a modifier
List modifier groups
Retrieve a modifier group
Change log
Please see the changelog for more information on what has changed recently.
Testing
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email author email instead of using the issue tracker.
Credits
- Luis Fernando Richter
- This package was based in Onivore from Andreas Beasley
License
license. Please see the license file for more information.