jasara/php-amzn-selling-partner-api

A fluent interface for Amazon's Selling Partner API in PHP

v0.8.3 2024-12-19 08:49 UTC

Requires

• php: ^8.2
• aws/aws-sdk-php: ^3.199
• brick/money: ^0.5 || ^0.6 || ^0.7 || ^0.8 || ^0.9
• guzzlehttp/guzzle: ^7.4
• illuminate/http: ^10.0 || ^11.0
• illuminate/support: ^10.0 || ^11.0
• illuminate/validation: ^10.0 || ^11.0
• php-units-of-measure/php-units-of-measure: ^2.1
• psr/log: ^1.0.1 || ^2.0 || ^3.0
• vlucas/phpdotenv: ^5.3

Requires (Dev)

• laravel/pint: ^1.10
• phpstan/phpstan: ^2.0
• phpstan/phpstan-deprecation-rules: ^2.0
• phpunit/phpunit: ^10.0
• rector/rector: dev-main as 1.2.10
• spatie/ray: ^1.30

CC-BY-NC-SA-4.0

• Jasara Technology Inc.

README

PHP SDK for Amazon's Selling Partner API

This is a work-in-progress implementation of Amazon's Selling Partner API in PHP. This package aims to provide an easy to use, fluent interface to the API.

If you would like to participate in the development of this SDK, please get in touch with us at [e-mail]

Documentation

This README provides some basic details about the package; detailed documentation is available at: https://phpspa.com/docs/getting-started/

Installation

You can use Composer to install this package in your projects:

composer require jasara/php-amzn-selling-partner-api

Usage

The best way to understand how to use this SDK is by reading the documentation for the specific call you would like to make. In general, you should expect a fluent interface, such as:

use Jasara\AmazonSPA\AmznSPA;

$amazon = new AmznSPA($config);
$response = $amzn->feeds->getFeed($feed_id);
if($response->errors) {
    return $response->errors; // ErrorListSchema
}

if($response->feed) {
    $document = $amazon->feeds->getFeedDocument($feed->result_feed_document_id);
}

Config

When you instantiate the AmazonSPA class, the config is an object that should be initialized and then passed in:

use Jasara\AmznSPA\AmznSPAConfig;

$config = new AmznSPAConfig(
    marketplace_id: 'ATVPDKIKX0DER',
    application_id: '***',
    lwa_access_token: '***',
    lwa_refresh_token: '***', // If you would like the SDK to automatically fetch a new access token if necessary
    lwa_client_id: '***',
    lwa_client_secret: '***',
    aws_access_key: '***',
    aws_secret_key: '***',
);

License

This project is not licensed for commercial usage, but you are hereby granted the right to use this project for commercial purposes as long as your annual revenue is under $100,000 USD.

Above that level, please visit our Sponsors page to obtain an automatic commercial license.

You are free to use the project for non-commercial purposes.

Why a Non Commercial License?

Judging by the current pace of development by the Amazon Selling Partner API team, it looks like they plan to develop at a rapid pace, so it will be an effort to keep up with all the changes. We would like this project to start with sustainability in mind, rather than have a project that only works properly for several months and then no longer receives updates.

If reducing costs is more important to you than development speed and sustainability, you can always generate your own PHP SDK using the swagger-gen tools that the Selling Partner API team provides.