Download the PHP package hkonnet/selling-partner-api without Composer
On this page you can find all versions of the php package hkonnet/selling-partner-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package selling-partner-api
Selling Partner API for PHP
A PHP library for connecting to Amazon's Selling Partner API.
Sponsors
Powering companies like...
If you've found this library useful, please consider becoming a Sponsor, or making a one-time donation via the button below. I appreciate any and all support you can provide!
Features
- Supports all Selling Partner API operations (for Sellers and Vendors) as of 7/2/2021 (see here for links to documentation for all calls)
- Supports applications made with both IAM user and IAM role ARNs (docs)
- Automatically generates Restricted Data Tokens for all calls that require them -- no extra calls to the Tokens API needed
- Includes a
Document
helper class for uploading and downloading feed/report documents
Installation
composer require jlevers/selling-partner-api
Getting Started
Prerequisites
You need a few things to get started:
- A Selling Partner API developer account
- An AWS IAM user or role configured for use with the Selling Partner API
- A Selling Partner API application
If you're looking for more information on how to set those things up, check out this blog post. It provides a detailed walkthrough of the whole setup process.
Setup
The Configuration
constructor takes a single argument: an associative array with all the configuration information that's needed to connect to the Selling Partner API:
If you created your Selling Partner API application using an IAM role ARN instead of a user ARN, pass that role ARN in the configuration array:
Getter and setter methods exist for the Configuration
class's lwaClientId
, lwaClientSecret
, lwaRefreshToken
, awsAccessKeyId
, awsSecretAccessKey
, and endpoint
properties. The methods are named in accordance with the name of the property they interact with: getLwaClientId
, setLwaClientId
, getLwaClientSecret
, etc.
$config
can then be passed into the constructor of any SellingPartnerApi\Api\*Api
class. See the Example
section for a complete example.
Configuration options
The array passed to the Configuration
constructor accepts the following keys:
lwaClientId (string)
: Required. The LWA client ID of the SP API application to use to execute API requests.lwaClientSecret (string)
: Required. The LWA client secret of the SP API application to use to execute API requests.lwaRefreshToken (string)
: The LWA refresh token of the SP API application to use to execute API requests. Required, unless you're only using theConfiguration
instance to call grantless operations.awsAccessKeyId (string)
: Required. AWS IAM user Access Key ID with SP API ExecuteAPI permissions.awsSecretAccessKey (string)
: Required. AWS IAM user Secret Access Key with SP API ExecuteAPI permissions.endpoint (array)
: Required. An array containing aurl
key (the endpoint URL) and aregion
key (the AWS region). There are predefined constants for these arrays inlib/Endpoint.php
: (NA
,EU
,FE
, andNA_SANDBOX
,EU_SANDBOX
, andFE_SANDBOX
. See here for more details.accessToken (string)
: An access token generated from the refresh token.accessTokenExpiration (int)
: A Unix timestamp corresponding to the time when theaccessToken
expires. IfaccessToken
is given,accessTokenExpiration
is required (and vice versa).onUpdateCredentials (callable|Closure)
: A callback function to call when a new access token is generated. The function should accept a single argument of typeSellingPartnerApi\Credentials
.roleArn (string)
: If you set up your SP API application with an AWS IAM role ARN instead of a user ARN, pass that ARN here.
Example
This example assumes you have access to the Seller Insights
Selling Partner API role, but the general format applies to any Selling Partner API request.
Supported API segments
Seller APIs
- A+ Content API
- Authorization API
- Catalog API
- Old Catalog API (the original Catalog API)
- FBA Inbound API
- FBA Inbound Eligibility API
- FBA Inventory API
- FBA Outbound API
- Feeds API
- Fees API
- Finances API
- Listings API
- Merchant Fulfillment API
- Messaging API
- Notifications API
- Orders API
- Product Pricing API
- Product Type Definitions API
- Reports API
- Sales API
- Sellers API
- Service API
- Shipment Invoicing API
- Shipping API
- Small and Light API
- Solicitations API
- Restricted Data Tokens API
- Uploads API
Vendor APIs
- Direct Fulfillment Inventory API
- Direct Fulfillment Orders API
- Direct Fulfillment Payments API
- Direct Fulfillment Shipping API
- Direct Fulfillment Transactions API
- Invoices API
- Orders API
- Shipping API
- Transaction Status API
Uploading and downloading documents
The Feeds and Reports APIs include operations that involve uploading and downloading documents to and from Amazon. Amazon encrypts all documents they generate, and requires that all uploaded documents be encrypted. The SellingPartnerApi\Document
class handles all the encryption/decryption, given an instance of one of the Model\Reports\ReportDocument
, Model\Feeds\FeedDocument
, or Model\Feeds\CreateFeedDocumentResponse
classes. Instances of those classes are in the response returned by Amazon when you make a call to the getReportDocument
, getFeedDocument
, and createFeedDocument
endpoints, respectively.
Downloading a report document
Uploading a feed document
Models
Most operations have one or more models associated with it. These models are classes that contain the data needed to make a certain kind of request to the API, or contain the data returned by a given request type. All of the models share the same general interface: you can either specify all the model's attributes during initialization, or use setter methods to set each attribute after the fact. Here's an example using the Service API's Buyer
model (docs, (source).
The Buyer
model has four attributes: buyer_id
, name
, phone
, and is_prime_member
. (If you're wondering how you would figure out which attributes the model has on your own, check out the docs
link above.) To create an instance of the Buyer
model with all those attributes set:
Alternatively, you can create an instance of the Buyer
model and then populate its fields:
Each model also has the getter methods you might expect:
Models can (and usually do) have other models as attributes:
All versions of selling-partner-api with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2|^6.5|^7.0