Download the PHP package muhanz/shoapi without Composer
On this page you can find all versions of the php package muhanz/shoapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download muhanz/shoapi
More information about muhanz/shoapi
Files in muhanz/shoapi
Package shoapi
Short Description Laravel Shopee Open API SDK
License MIT
Homepage https://github.com/mu-hanz/shoapi
Informations about the package shoapi
ShoAPI - Laravel Shopee API SDK (V2)
This is a Unofficial Shopee PHP Client for Laravel 9|10 and currently supported API V2
ShoAPi lets you develop Shopee Open API in Laravel. ShoAPi is an HTTP-based interface created for developers interested Shopee Open API. To learn more about the Shopee Open API, please consult the Introduction on the official Shopee Open Platform site.
Installation
Via Composer
Before Start
Configure your variables in your .env
(recommended) or you can publish the config file and change it there.
(Optional) You can publish the config file via this command:
Authorization and Authentication
For cancel/disconnet auth partner
Get Access Token & Refresh Access Token
The access_token is a dynamic token, and you need to pass access_token to call non-public APIs. Each access_token is valid for 4 hours and can be used multiple times within 4 hours. However, you need to refresh the access token by calling RefreshAccessToken before it expires in order to obtain a new access_token.
Refresh_token is a parameter used to refresh access_token. Each refresh_token is valid for 30 days.
⚠️ Note: The access_token and refresh_token of each shop_id and merchant_id need to be saved separately.
Get Access Token:
Get Refresh Access Token:
Example Response:
Basic Usage
Other Example:
Example Response:
Support Methods
Currently supported all methods exclude GlobalProduct(CB seller only) please open Shopee Open Platform
Service (call) | Method (access) | |
---|---|---|
Product | add_item, get_category and 35 others |
✅ |
Global Product(CB seller only) | - Not Tested |
❌ |
MediaSpace | upload_image, upload_video, etc |
✅ |
Shop | get_info_shop, get_profile, update_profile, etc |
✅ |
Merchant | get_merchant_info, get_shop_list_by_merchant, etc |
✅ |
Order | get_order_list, get_order_detail and 11 others |
✅ |
Logistics | get_shipping_parameter, get_tracking_number, and 14 others |
✅ |
First Miles | get_unbind_order_list, get_detail, etc |
✅ |
Payment | get_escrow_detail, set_shop_installment_status, etc |
✅ |
Discount | add_discount, add_discount_item, etc |
✅ |
Bundle Deal | add_bundle_deal, add_bundle_deal_item, etc |
✅ |
Add-On Deal | add_add_on_deal, add_add_on_deal_main_item, etc |
✅ |
Voucher | add_voucher, delete_voucher, etc |
✅ |
Follow Prize | add_follow_prize, delete_follow_prize, etc |
✅ |
Top Picks | get_top_picks_list, add_top_picks, etc |
✅ |
Shop Category | add_shop_category, get_shop_category_list, etc |
✅ |
Returns | get_return_detail, get_return_list, etc |
✅ |
Account Health | shop_performance, shop_penalty |
✅ |
Public | get_shops_by_partner, get_access_token,refresh_access_token, etc |
✅ |
Push | set_app_push_config, get_app_push_config |
✅ |
Documentation
Please refer to the official documentation Shopee Open Platform
Change log
Please see the changelog for more information on what has changed recently.
Contributing
Please see contributing.md for details and a todolist.
Credits
- Mu Hanz
- All Contributors
License
MIT. Please see the license file for more information.