laraditz/shopee

A simple laravel package for Shopee

1.0.0 2021-10-27 03:51 UTC

This package is auto-updated.

Last update: 2024-12-10 16:02:51 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

Laravel package for interacting with Shopee API.

Installation

You can install the package via composer:

composer require laraditz/shopee

Before Start

Configure your variables in your .env (recommended) or you can publish the config file and change it there.

SHOPEE_SANDBOX_MODE=true # true or false for sandbox mode
SHOPEE_PARTNER_ID=<your_shopee_partner_id>
SHOPEE_PARTNER_KEY=<your_shopee_partner_id>

(Optional) You can publish the config file via this command:

php artisan vendor:publish --provider="Laraditz\Shopee\ShopeeServiceProvider" --tag="config"

Run the migration command to create the necessary database table.

php artisan migrate

Available Methods

Below are all methods available under this package.

Usage

You may call the method by chaining the service name before calling the method name.

// Using service container
app('shopee')->order()->detail('211020BNFYMXXX');

// Using facade
\Shopee::order()->detail('211020BNFYMXXX');

Event

This package also provide an event to allow your application to listen for Shopee web push. You can create your listener and register it under event below.

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 raditzfarhan@gmail.com instead of using the issue tracker.

Credits

License

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