flairuk/good-till-system

The Good Till API for Laravel

dev-master 2020-06-23 14:34 UTC

Requires

• php: ^7.1
• illuminate/support: ^6.0|^7.0

Requires (Dev)

• orchestra/testbench: ^4.0
• phpunit/phpunit: ^8.0

MIT

• Phil Graham

• laravel
• flair
• good-till-system

README

This package is still a work in progress, extended documentation will follow.

Test Accounts

If you are building an integration and you would like to test the API without affecting your live account, or you are building an integration on behalf of a Goodtill customer, you request a fully-featured test account from [e-mail]. Please visit the Good Till API Documentation for more information.

Installation

You can install the package via composer:

composer require flairuk/good-till-system

Basic Usage

Add the environment variables to your .env file and enter the api credentials.

GOOD_TILL_DOAMIN=
GOOD_TILL_USERNAME=
GOOD_TILL_PASSWORD=

Use the GoodTillSystem Facade.

use GoodTillSystem;

Once you add the facade, you can now interact with the Good Till System API.

Good Till System API

Products

1. Get a list of products.

GoodTillSystem::products()->get();

1. Get a product by id.

GoodTillSystem::product($id)->get();

1. Create a new product.

GoodTillSystem::product()->create($data);

1. Update a product by id.

GoodTillSystem::product($id)->update($data);

1. Delete a product by id.

GoodTillSystem::product($id)->delete();

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Phil Graham
• FLAIR
• All Contributors

License

The MIT License (MIT). Please see License File for more information.