Download the PHP package foodticket/jet-connect-client without Composer

On this page you can find all versions of the php package foodticket/jet-connect-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of foodticket/jet-connect-client

Informations about the package jet-connect-client

JET Connect API implementation for Laravel

GitHub license

This package allows you to easily make requests to JustEatTakeaway's JET Connect API.

Requirements

Installation

You can install the package via composer:

The package will automatically register itself.

Configuration

To start using the JET Connect API you will need an API key. Add the API key to your project's .env file:

Making requests

All endpoints are accessed through JetConnectApi:

setItemAvailability

Mark one or more menu items as available or unavailable for a given restaurant.

Parameter Type Required Description
availability Availability Yes Availability::AVAILABLE or Availability::UNAVAILABLE
itemsIds array Yes Array of item PLU/reference strings
restaurant string Yes Restaurant identifier
nextAvailableAt Carbon\|null No When the item becomes available again (only applies when marking unavailable)

ingestMenu

Push a full menu to JET Connect for one or more restaurants.

Parameter Type Required Description
restaurants array Yes Array of restaurant identifier strings
menus array Yes Menu payload array
callbackUrl string\|null No URL that JET Connect will call when ingestion completes

sentToPosSuccess

Confirm that an order was successfully sent to the POS.

Parameter Type Required Description
orderId string Yes The JET Connect order ID

sentToPosFailed

Report that sending an order to the POS failed.

Parameter Type Required Description
orderId string Yes The JET Connect order ID
errorCode ErrorCode Yes One of the error codes below
errorMessage string Yes Human-readable description of the failure

Available ErrorCode values:

Value Description
AUTH_FAILED Order authorization was incorrect
INCORRECT_SETUP Configuration details sent with the order are wrong (e.g. store ID)
IN_USE POS is currently in use and cannot take requests
INACTIVE POS is offline and cannot take orders
MALFORMED_REQUEST Order request was malformed (e.g. malformed JSON)
MENU_ERROR Order had incorrect items (not in stock, PLU not in POS)
NOT_SUPPORTED Integrated ordering is not supported at this restaurant
STORE_CLOSED Store is closed and cannot take orders
TENDER_ERROR Tender type sent to the POS is wrong
TIMEOUT Request to the POS timed out

orderItemModification

Report that one or more items could not be fulfilled, so JET can update the order accordingly.

Parameter Type Required Description
orderId string Yes The JET Connect order ID
modifications array Yes Array of modification objects (see structure below)

Each modification object:

Key Type Description
removedItems array Items that could not be fulfilled

Each removedItems entry:

Key Type Description
plu string PLU code of the item
missingQuantity int Number of units that could not be fulfilled

Custom requests

To call any JET Connect endpoint not covered above:

Webhooks

To start receiving webhooks from JET Connect, you need to add the following route the App\Providers\RouteServiceProvider file:

Security Vulnerabilities

If you discover a security vulnerability within this project, please report this by email to [email protected].

All versions of jet-connect-client with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
guzzlehttp/guzzle Version ^7.0
laravel/framework Version ^12.0|^13.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package foodticket/jet-connect-client contains the following files

Loading the files please wait ...