PHPackages                             sapioweb/omnivore - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. sapioweb/omnivore

ActiveLibrary[Framework](/categories/framework)

sapioweb/omnivore
=================

Laravel 5 wrapper for omnivore

1.0.4(9y ago)037MITPHP

Since Jan 12Pushed 9y ago1 watchersCompare

[ Source](https://github.com/SapioBeasley/omnivore)[ Packagist](https://packagist.org/packages/sapioweb/omnivore)[ RSS](/packages/sapioweb-omnivore/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

Omnivore classes and functions
==============================

[](#omnivore-classes-and-functions)

Place these values into your .ENV

```
OMNIVORE_API_URL
OMNIVORE_API_KEY
OMNIVORE_LOCATION_ID
ES_FROM
ES_SIZE
OMNIVORE_API_URL

```

Add the following into the construct that will utilize the wrapper

```
function locationList()
{
  $this->omnivoreGeneral = new OmnivoreGeneral;

  $this->omnivoreTickets = new OmnivoreTickets;

  $this->omnivoreTables = new OmnivoreTables;
}
```

Class OmnivoreTickets
---------------------

[](#class-omnivoretickets)

Interact with tickets of claimed locations from the POS.

### Available Functions

[](#available-functions)

List tickets for location

```
$ticketList = $this->omnivoreTickets->ticketList($locationId)
return response()->json($ticketList);
```

Open a new ticket

```
$ticketOpen = $this->omnivoreTickets->ticketOpen($locationId, $content)
return response()->json($ticketOpen);
```

Retrieve data for a specific ticket

```
$ticketRetrieve = $this->omnivoreTickets->ticketRetrieve($locationId, $ticketId);
return response()->json($ticketRetrieve);
```

Void a locations ticket

```
$ticketVoid = $this->omnivoreTickets->ticketVoid($locationId, $ticketId)
return response()->json($ticketVoid);
```

List discounts for a ticket

```
$ticketDiscountList = $this->omnivoreTickets->ticketDiscountList($locationId, $ticketId)
return response()->json($ticketDiscountList);
```

Apply a discount to a ticket

```
$ticketDiscountApply = $this->omnivoreTickets->ticketDiscountApply($locationId, $ticketId, $discount, $value)
return response()->json($ticketDiscountApply);
```

Retrieve a discount that was applied to a ticket

```
$ticketDiscountRetrieve = $this->omnivoreTickets->ticketDiscountRetrieve($locationId, $ticketId, $ticketDiscountId)
return response()->json($ticketDiscountRetrieve);
```

List items on a ticket

```
$ticketItemList = $this->omnivoreTickets->ticketItemList($locationId, $ticketId)
return response()->json($ticketItemList);
```

Add an item to a ticket

```
$ticketItemAdd = $this->omnivoreTickets->ticketItemAdd($locationId, $ticketId, $content)
return response()->json($ticketItemAdd);
```

Retrieve an item from a ticket

```
$ticketItemRetrieve = $this->omnivoreTickets->ticketItemRetrieve($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemRetrieve);
```

Void an item from a ticket

```
$ticketItemVoid = $this->omnivoreTickets->ticketItemVoid($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemVoid);
```

List modifiers form a ticket

```
$ticketItemModifierList = $this->omnivoreTickets->ticketItemModifierList($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemModifierList);
```

Retrieve a modifier form a ticket

```
$ticketItemModifierRetrieve = $this->omnivoreTickets->ticketItemModifierRetrieve($locationId, $ticketId, $ticketItemId, $ticketItemModifierId)
return response()->json($ticketItemModifierRetrieve);
```

List dicounts on a ticket

```
$ticketItemDiscountList = $this->omnivoreTickets->ticketItemDiscountList($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemDiscountList);
```

Retrieve a discount from a ticket

```
$ticketItemDiscountRetrieve = $this->omnivoreTickets->ticketItemDiscountRetrieve($locationId, $ticketId, $ticketItemId, $ticketItemDiscountId)
return response()->json($ticketItemDiscountRetrieve);
```

List payments

```
$paymentList = $this->omnivoreTickets->paymentList($locationId, $ticketId)
return response()->json($paymentList);
```

Retrieve a payment

```
$paymentRetrieve = $this->omnivoreTickets->paymentRetrieve($locationId, $ticketId, $paymentId)
return response()->json($paymentRetrieve);
```

Make a payment where a card is not present

```
$paymentCardNotPresent = $this->omnivoreTickets->paymentCardNotPresent($locationId, $ticketId, $content)
return response()->json($paymentCardNotPresent);
```

Make a payment where a card is present

```
$paymentCardPresent = $this->omnivoreTickets->paymentCardPresent($locationId, $ticketId, $content)
return response()->json($paymentCardPresent);
```

Make a payment with a 3rd party

```
$payment3rdParty = $this->omnivoreTickets->payment3rdParty($locationId, $ticketId, $content)
return response()->json($payment3rdParty);
```

Make a payment with a card

```
$paymentGiftCard = $this->omnivoreTickets->paymentGiftCard($locationId, $ticketId, $content)
return response()->json($paymentGiftCard);
```

Make a payment with cash

```
$paymentCash = $this->omnivoreTickets->paymentCash($locationId, $ticketId, $content)
return response()->json($paymentCash);
```

Class OmnivoreTables
====================

[](#class-omnivoretables)

Interact with tables of claimed locations from the POS.

### Available Functions

[](#available-functions-1)

List tables of claimed locations

```
$tableList = $this->omnivoreTables->tableList($locationId)
return response()->json($tableList);
```

Retrieve data for a specific table

```
$tableRetrieve = $this->omnivoreTables->tableRetrieve($locationId, $tableId)
return response()->json($tableRetrieve);
```

Class OmnivoreGeneral
=====================

[](#class-omnivoregeneral)

Interact with general labeled actions of claimed locations from the POS.

### Available Functions

[](#available-functions-2)

List all locations claimed.

```
$locations = $this->omnivoreGeneral->locationList();
return response()->json($locations);
```

Retrieve information about a location

```
$locationRetrieve = $this->omnivoreGeneral->locationRetrieve($locationId)
return response()->json($locationRetrieve);
```

List employees of a location

```
$employeeList = $this->omnivoreGeneral->employeeList($locationId)
return response()->json($employeeList);
```

Retrieve data of a specific location

```
$employeeRetrieve = $this->omnivoreGeneral->employeeRetrieve($locationId, $employeeId)
return response()->json($employeeRetrieve);
```

List location types

```
$orderTypeList = $this->omnivoreGeneral->orderTypeList($locationId)
return response()->json($orderTypeList);
```

Retrieve a locations type

```
$orderTypeRetrieve = $this->omnivoreGeneral->orderTypeRetrieve($locationId, $orderTypeId)
return response()->json($orderTypeRetrieve);
```

List the types of tender the location accepts

```
$tenderTypeList = $this->omnivoreGeneral->tenderTypeList($locationId)
return response()->json($tenderTypeList);
```

Retrive the tender type

```
$tenderTypeRetrieve = $this->omnivoreGeneral->tenderTypeRetrieve($locationId, $tenderTypeId)
return response()->json($tenderTypeRetrieve);
```

List a locations revenue centers

```
$revenueCenterList = $this->omnivoreGeneral->revenueCenterList($locationId)
return response()->json($revenueCenterList);
```

Retrieve information of a payment center

```
$revenueCenterRetrieve = $this->omnivoreGeneral->revenueCenterRetrieve($locationId, $revenueCenterId)
return response()->json($revenueCenterRetrieve);
```

List the discounts of a location

```
$discountList = $this->omnivoreGeneral->discountList($locationId)
return response()->json($discountList);
```

Retrieve the discount

```
$discountRetrieve = $this->omnivoreGeneral->discountRetrieve($locationId, $discountId)
return response()->json($discountRetrieve);
```

Grab the menu from POS

```
$menu = $this->omnivoreGeneral->menu($locationId)
return response()->json($menu);
```

List the menu categories

```
$categoryList = $this->omnivoreGeneral->categoryList($locationId)
return response()->json($categoryList);
```

Retrieve a category

```
$categoryRetrieve = $this->omnivoreGeneral->categoryRetrieve($locationId, $categoryId)
return response()->json($categoryRetrieve);
```

List items in a menu

```
$menuItemList = $this->omnivoreGeneral->menuItemList($locationId)
return response()->json($menuItemList);
```

Retrieve a menu item

```
$menuItemRetrieve = $this->omnivoreGeneral->menuItemRetrieve($locationId, $menuItemId)
return response()->json($menuItemRetrieve);
```

List location modifiers

```
$modifierList = $this->omnivoreGeneral->modifierList($locationId)
return response()->json($modifierList);
```

Retrieve a modifier

```
$modifierRetrieve = $this->omnivoreGeneral->modifierRetrieve($locationId, $modifierId)
return response()->json($modifierRetrieve);
```

List modifier groups

```
$modifierGroupList = $this->omnivoreGeneral->modifierGroupList($locationId, $menuItemId)
return response()->json($modifierGroupList);
```

Retrieve a modifier group

```
$modifierGroupRetrieve = $this->omnivoreGeneral->modifierGroupRetrieve($locationId, $menuItemId, $modifierGroupId)
return response()->json($modifierGroupRetrieve);
```

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 92.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~29 days

Total

5

Last Release

3287d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0b2dcde35ce666b8c302d89d26b9b0207ac0ca2b14d98fcc3455488d4aeb28d2?d=identicon)[SapioBeasley](/maintainers/SapioBeasley)

---

Top Contributors

[![SapioBeasley](https://avatars.githubusercontent.com/u/8516439?v=4)](https://github.com/SapioBeasley "SapioBeasley (12 commits)")[![abeasley54](https://avatars.githubusercontent.com/u/7516633?v=4)](https://github.com/abeasley54 "abeasley54 (1 commits)")

### Embed Badge

![Health badge](/badges/sapioweb-omnivore/health.svg)

```
[![Health](https://phpackages.com/badges/sapioweb-omnivore/health.svg)](https://phpackages.com/packages/sapioweb-omnivore)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M16.9k](/packages/laravel-framework)[laravel/socialite

Laravel wrapper around OAuth 1 &amp; OAuth 2 libraries.

5.7k96.9M669](/packages/laravel-socialite)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M255](/packages/laravel-dusk)[laravel/boost

Laravel Boost accelerates AI-assisted development by providing the essential context and structure that AI needs to generate high-quality, Laravel-specific code.

3.4k10.6M272](/packages/laravel-boost)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19462.3M1.3k](/packages/drupal-core)[laravel/vapor-cli

The Laravel Vapor CLI

31310.7M8](/packages/laravel-vapor-cli)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
