Shopee Partner API PHP SDK

0.2.1 2021-02-07 07:25 UTC

This package is auto-updated.

Last update: 2021-08-23 12:53:03 UTC


tests Latest Stable Version Latest Unstable Version composer.lock

This is a Shopee Partner API Client for PHP.



Execute the following command to get the package:

$ composer require minchao/shopee-php


Create an instance of the Shopee client, then use to access the Shopee Partner API.


use Shopee\Client;

require __DIR__ . '/vendor/autoload.php';

$client = new Client([
    'secret' => getenv('SHOPEE_PARTNER_KEY'),
    'partner_id' => getenv('SHOPEE_PARTNER_ID'),
    'shopid' => getenv('SHOPEE_SHOP_ID'),


Get detail of item

$response = $client->item->getItemDetail(['item_id' => 1978]);

Alternatively, you can also use the parameter model within request.

$parameters = (new \Shopee\Nodes\Item\Parameters\GetItemDetail())
$response = $client->item->getItemDetail($parameters);


Use webhook to receive incoming push notifications:


 * Push Mechanism (WebHook)
 * @see  https://open.shopee.com/documents?module=63&type=2&id=55

use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Shopee\SignatureGenerator;
use Shopee\SignatureValidator;
use Slim\Factory\AppFactory;

require __DIR__ . '/vendor/autoload.php';

$app = AppFactory::create();
$signatureGenerator = new SignatureGenerator(getenv('PARTNER_KEY'));
$signatureValidator = new SignatureValidator($signatureGenerator);

$app->post('/webhook', function (Request $request, Response $response) use ($signatureValidator) {
    // Verify push content
    if (!$signatureValidator->isValid($request)) {
        error_log('Invalid authorization signature');
        return $response;

    // TODO here to handle your business logic

    // HTTP response must with status code 2xx and empty body
    return $response;



See the LICENSE file for license rights and limitations (BSD 3-Clause).