README

Selling Partner API for PHP

A PHP library for connecting to Amazon's Selling Partner API.

Warning

Amazon has deprecated most listings-related XML and flat-file feeds. I built an Amazon feed converter tool for easily converting the deprecated feeds to the newer JSON_LISTINGS_FEED format with a few lines of code. Read the full documentation here.

Related packages

highsidelabs/laravel-spapi: A Laravel wrapper for this package that makes SP API integration in Laravel projects quick and easy.
highsidelabs/amazon-business-api: A PHP library for Amazon's Business API.
highsidelabs/walmart-api: A PHP library for Walmart's seller and supplier APIs, including the Marketplace, Drop Ship Vendor, Content Provider, and Warehouse Supplier APIs.
shipstream/fedex-rest-sdk: A PHP library for interacting with FedEx's REST APIs, built by me on behalf of ShipStream.

I'm available for consulting work! If you need support designing and building applications with Amazon, Walmart, or other e-commerce APIs, or building SDKs in PHP, I can help. Shoot me an email at jesse@highsidelabs.co.

If you've found any of my packages useful, please consider becoming a Sponsor, or making a one-time donation via the button below. I appreciate any and all support! Keeping open source projects alive is a community effort.

Features

Supports all Selling Partner API operations (for Sellers and Vendors) as of 6/19/2024
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
Can handle the end-to-end OAuth flow, from building authorization URLs to converting authorization codes into refresh tokens

Installation

composer require jlevers/selling-partner-api

Contributing

See CONTRIBUTING.md for details.

Check out the Getting Started section below for a quick overview.

This README is divided into several sections:

Setup
- Configuration options
Debugging
Working with responses
Working with DTOs
Supported API segments
- Seller APIs
- Vendor APIs
Restricted operations
Uploading and downloading documents
OAuth
- Building authorization URIs
- Generating a refresh token from an authorization code
Naming conventions

Getting Started

Prerequisites

To get started, you need an approved Selling Partner API developer account, and SP API application credentials, which you can get by creating a new SP API application in Seller Central.

Setup

The SellingPartnerApi class acts as a factory to generate Seller and Vendor API connector instances. Its seller() and vendor() methods each take a set of identical (and optionally, named) parameters. Its basic usage looks like this:

use SellingPartnerApi\SellingPartnerApi;
use SellingPartnerApi\Enums\Endpoint;

$connector = SellingPartnerApi::seller(
    clientId: 'amzn1.application-oa2-client.asdfqwertyuiop...',
    clientSecret: 'amzn1.oa2-cs.v1.1234567890asdfghjkl...',
    refreshToken: 'Atzr|IwEBIA...',
    endpoint: Endpoint::NA,  // Or Endpoint::EU, Endpoint::FE, Endpoint::NA_SANDBOX, etc.
);

Note

Older versions of the Selling Partner API used AWS IAM credentials to authenticate, and so this library had additional AWS configuration options. If you're upgrading from an older version of this library and are confused about what to do with your AWS creds, you can just ignore them. The SP API no longer authenticates via AWS IAM roles or users.

Now you have a Selling Partner API connector instance, and you can start making calls to the API. The connector instance has methods for each of the API segments (e.g., sellers, orders, fba-inbound), and you can access them like so:

$ordersApi = $connector->ordersV0();
$response = $ordersApi->getOrders(
    createdAfter: new DateTime('2024-01-01'),
    marketplaceIds: ['ATVPDKIKX0DER'],
);

Once you have a response, you can either access the raw JSON response via $response->json(), or you can automatically parse the response into a DTO by calling $response->dto(). Once the response is turned into a DTO, you can access the data via the DTO's properties. For instance, you can get the first order's purchase date like so:

$dto = $response->dto();
$purchaseDate = $dto->payload->orders[0]->purchaseDate;

See the Working with responses section for more details on how to work with responses, and Working with DTOs for more details on how to use DTOs.

Configuration options

The SellingPartnerApi::seller() and SellingPartnerApi::vendor() builder methods accept the following arguments:

clientId (string): Required. The LWA client ID of the SP API application to use to execute API requests.
clientSecret (string): Required. The LWA client secret of the SP API application to use to execute API requests.
refreshToken (string): The LWA refresh token of the SP API application to use to execute API requests. Required, unless you're only using grantless operations, in which case you can pass a dummy string like 'grantless'.
endpoint: Required. An instance of the SellingPartnerApi\Enums\Endpoint enum. Primary endpoints are Endpoint::NA, Endpoint::EU, and Endpoint::FE. Sandbox endpoints are Endpoint::NA_SANDBOX, Endpoint::EU_SANDBOX, and Endpoint::FE_SANDBOX.
dataElements (array): Optional. An array of data elements to pass to restricted operations. See the Restricted operations section for more details.
delegatee (string): Optional. The application ID of a delegatee application to generate RDTs on behalf of.
authenticationClient (GuzzleHttp\Client): Guzzle client instance that will be used to generate the access token from the refresh token. If not provided, the default Saloon Guzzle client will be used.
cache (SellingPartnerApi\Contracts\TokenCache): A cache interface instance that will be used to cache access tokens. If not provided, a basic in-memory cache will be used. If set to null, caching will be disabled.

Debugging

To get detailed debugging output, you can take advantage of Saloon's debugging hooks. This package is built on top of Saloon, so anything that works in Saloon will work here. For instance, to debug requests:

use Psr\Http\Message\RequestInterface;
use Saloon\Http\PendingRequest;
use SellingPartnerApi\SellingPartnerApi;

$connector = SellingPartnerApi::seller(
    clientId: 'amzn1.application-oa2-client.asdfqwertyuiop...',
    clientSecret: 'amzn1.oa2-cs.v1.1234567890asdfghjkl...',
    refreshToken: 'Atzr|IwEBIA...',
    endpoint: Endpoint::NA,
);

$connector->debugRequest(
    function (PendingRequest $pendingRequest, RequestInterface $psrRequest) {
        var_dump($pendingRequest->headers()->all(), $psrRequest);
    }
);

Then make requests with the connector as usual, and you'll hit the closure above every time a request is fired. You can also debug responses in a similar fashion – check out the Saloon docs for more details.

If you want to output your debug data to a file, you can do so with the SellingPartnerApi::debugRequestToFile(), SellingPartnerApi::debugResponseToFile(), and SellingPartnerApi::debugToFile() methods. These methods all take an $outputPath argument and an optional $die argument.

Working with responses

As mentioned earlier, all endpoint methods return an instance of Saloon\Response. You can access the raw JSON response via $response->json(), or you can automatically parse the response into a DTO by calling $response->dto(). Once the response is turned into a DTO, you can access the data via the DTO's properties (described below). Saloon's response documentation gives a comprehensive guide to working with Saloon responses, including retrieving headers, status, and more.

Working with DTOs

Some methods take DTOs as parameters. For instance, the confirmShipment method in the Orders API takes a ConfirmShipmentRequest DTO as a parameter. You can call confirmShipment like so:

<?php

use SellingPartnerApi\Seller\OrdersV0\Dto;
use SellingPartnerApi\SellingPartnerApi;

$confirmShipmentRequest = new Dto\ConfirmShipmentRequest(
    packageDetail: new Dto\PackageDetail(
        packageReferenceId: 'PKG123',
        carrierCode: 'USPS',
        trackingNumber: 'ASDF1234567890',
        shipDate: new DateTime('2024-01-01 12:00:00'),
        orderItems: [
            new Dto\ConfirmShipmentOrderItem(
                orderItemId: '1234567890',
                quantity: 1,
            ),
            new Dto\ConfirmShipmentOrderItem(
                orderItemId: '0987654321',
                quantity: 2,
            )
        ],
    ),
    marketplaceId: 'ATVPDKIKX0DER',
);

$response = $ordersApi->confirmShipment(
    orderId: '123-4567890-1234567',
    confirmShipmentRequest: $confirmShipmentRequest,
);

Supported API segments

Each API accessor method contains the API's version. This allows for multiple versions of the same API to be accessible in a single version of this package. It makes the method names a little uglier, but allows for simultaneously using new and old versions of the same API segment, which is often useful. It also means that if a new version of an existing API is introduced, the library can be updated to include that new version without introducing breaking changes.

Seller APIs

Seller APIs are accessed via the SellingPartnerApi::seller() class:

<?php
use SellingPartnerApi\SellingPartnerApi;

$sellerConnector = SellingPartnerApi::seller(/* ... */);

Amazon Warehousing and Distribution API (v2024-05-09) (docs)

$amazonWarehousingAndDistributionApi = $sellerConnector->amazonWarehousingAndDistributionV20240509();

App Integrations API (v2024-04-01) (docs)

$appIntegrationsApi = $sellerConnector->appIntegrationsV20240401();

Application Management API (v2023-11-30) (docs)

$applicationManagementApi = $sellerConnector->applicationManagementV20231130();

A+ Content API (v2020-11-01) (docs)

$aPlusContentApi = $sellerConnector->aPlusContentV20201101();

Catalog Items API (v2022-04-01) (docs)

$catalogItemsApi = $sellerConnector->catalogItemsV20220401();

Catalog Items API (v2021-12-01) (docs)

$catalogItemsApi = $sellerConnector->catalogItemsV20211201();

Catalog Items API (v0) (docs)

$catalogItemsApi = $sellerConnector->catalogItemsV0();

Data Kiosk API (v2023-11-15) (docs)

$dataKioskApi = $sellerConnector->dataKioskV20231115();

EasyShip API (v2022-03-23) (docs)

$easyShipApi = $sellerConnector->easyShipV20220323();

FBA Inbound API (v2024-03-20) (docs)

$fbaInboundApi = $sellerConnector->fbaInboundV20240320();

FBA Inbound API (v0) (docs)

$fbaInboundApi = $sellerConnector->fbaInboundV0();

FBA Inbound Eligibility API (v1) (docs)

$fbaInboundEligibility = $sellerConnector->fbaInboundEligibilityV1();

FBA Inventory API (v1) (docs)

$fbaInventoryApi = $sellerConnector->fbaInventoryV1();

FBA Outbound API (v2020-07-01) (docs)

$fbaOutboundApi = $sellerConnector->fbaOutboundV20200701();

Feeds API (v2021-06-30) (docs)

$feedsApi = $sellerConnector->feedsV20210630();

Finances API (v2024-06-19) (docs)

$financesApi = $sellerConnector->financesV20240619();

Finances API (v0) (docs)

$financesApi = $sellerConnector->financesV0();

Invoices API (v2024-06-19) (docs)

$invoicesApi = $sellerConnector->invoicesV20240619();

Listings Items API (v2021-08-01) (docs)

$listingsItemsApi = $sellerConnector->listingsItemsV20210801();

Listings Items API (v2020-09-01) (docs)

$listingsItemsApi = $sellerConnector->listingsItemsV20200901();

Listings Restrictions API (v2021-08-01) (docs)

$listingsRestrictionsApi = $sellerConnector->listingsRestrictionsV20210801();

Merchant Fulfillment API (v0) (docs)

$merchantFulfillmentApi = $sellerConnector->merchantFulfillmentV0();

Messaging API (v1) (docs)

$messagingApi = $sellerConnector->messagingV1();

Notifications API (v1) (docs)

$notificationsApi = $sellerConnector->notificationsV1();

Orders API (v0) (docs)

$ordersApi = $sellerConnector->ordersV0();

Product Fees API (v0) (docs)

$productFeesApi = $sellerConnector->productFeesV0();

Product Pricing API (v2022-05-01) (docs)

$productPricingApi = $sellerConnector->productPricingV20220501();

Product Pricing API (v0) (docs)

$productPricingApi = $sellerConnector->productPricingV0();

Product Type Definitions API (v2020-09-01) (docs)

$productTypeDefinitionsApi = $sellerConnector->productTypeDefinitionsV20200901();

Replenishment API (v2022-11-07) (docs)

$replenishmentApi = $sellerConnector->replenishmentV20221107();

Reports API (v2021-06-30) (docs)

$reportsApi = $sellerConnector->reportsV20210630();

Sales API (v1) (docs)

$salesApi = $sellerConnector->salesV1();

Sellers API (v1) (docs)

$sellersApi = $sellerConnector->sellersV1();

Services API (v1) (docs)

$servicesApi = $sellerConnector->servicesV1();

Shipment Invoicing API (v0) (docs)

$shipmentInvoicingApi = $sellerConnector->shipmentInvoicingV0();

Shipping API (v2) (docs)

$shippingApi = $sellerConnector->shippingV2();

Shipping API (v1) (docs)

$shippingApi = $sellerConnector->shippingV1();

Solicitations API (v1) (docs)

$solicitationsApi = $sellerConnector->solicitationsV1();

Supply Sources API (v2020-07-01) (docs)

$supplySourcesApi = $sellerConnector->supplySourcesV20200701();

Tokens API (v2021-03-01) (docs)

$tokensApi = $sellerConnector->tokensV20210301();

Transfers API (v2024-06-01) (docs)

$transfersApi = $sellerConnector->transfersV20240601();

Uploads API (v2020-11-01) (docs)

$uploadsApi = $sellerConnector->uploadsV20201101();

Vendor APIs

Vendor APIs are accessed via the SellingPartnerApi::vendor() method:

<?php
use SellingPartnerApi\SellingPartnerApi;

$vendorConnector = SellingPartnerApi::vendor(/* ... */);

Direct Fulfillment Inventory API (v1) (docs)

$directFulfillmentInventoryApi = $vendorConnector->directFulfillmentInventoryV1();

Direct Fulfillment Orders API (v2021-12-28) (docs)

$directFulfillmentOrdersApi = $vendorConnector->directFulfillmentOrdersV20211228();

Direct Fulfillment Orders API (v1) (docs)

$directFulfillmentOrdersApi = $vendorConnector->directFulfillmentOrdersV1();

Direct Fulfillment Payments API (v1) (docs)

$directFulfillmentPaymentsApi = $vendorConnector->directFulfillmentPaymentsV1();

Direct Fulfillment Sandbox API (v2021-10-28) (docs)

$directFulfillmentSandboxApi = $vendorConnector->directFulfillmentSandboxV20211028();

Direct Fulfillment Shipping API (v2021-12-28) (docs)

$directFulfillmentShippingApi = $vendorConnector->directFulfillmentShippingV20211228();

Direct Fulfillment Shipping API (v1) (docs)

$directFulfillmentShippingApi = $vendorConnector->directFulfillmentShippingV1();

Direct Fulfillment Transactions API (v2021-12-28) (docs)

$directFulfillmentTransactionsApi = $vendorConnector->directFulfillmentTransactionsV20211228();

Direct Fulfillment Transactions API (v1) (docs)

$directFulfillmentTransactionsApi = $vendorConnector->directFulfillmentTransactionsV1();

Invoices API (v1) (docs)

$invoicesApi = $vendorConnector->invoicesV1();

Orders API (v1) (docs)

$ordersApi = $vendorConnector->ordersV1();

Shipments API (v1) (docs)

$shipmentsApi = $vendorConnector->shipmentsV1();

Transaction Status API (v1) (docs)

$transactionStatusApi = $vendorConnector->transactionStatusV1();

Restricted operations

When you call a restricted operation, a Restricted Data Token (RDT) is automatically generated. If you're calling restricted operations that accept a dataElements parameter, specify the restricted data elements you want to retrieve in the dataElements parameter of SellingPartnerApi::make(). Currently, getOrder, getOrders, and getOrderItems are the only restricted operations that take a dataElements parameter.

Note that if you want to call a restricted operation on a sandbox endpoint (e.g., Endpoint::NA_SANDBOX), you should not specify any dataElements. RDTs are not necessary for restricted operations in the sandbox.

If you would like to make calls on behalf of a delegatee application, you can specify the delegatee parameter in SellingPartnerApi::make(). This will cause the connector to generate a token for the delegatee application instead of the main application.

Uploading and downloading documents

The Feeds and Reports APIs include operations that involve uploading and downloading documents to and from Amazon. This library has integrated supports for uploading and downloading documents on the relevant DTOs: ReportDocument, CreateFeedDocumentResponse, and FeedDocument, which are the result of calling getReportDocument, createFeedDocument, and getFeedDocument, respectively.

Downloading a report document

use SellingPartnerApi\SellingPartnerApi;

$reportType = 'GET_MERCHANT_LISTINGS_DATA';
// Assume we already got a report document ID from a previous getReport call
$documentId = '1234567890.asdf';

$connector = SellingPartnerApi::seller(/* ... */);
$response = $connector->reportsV20210630()->getReportDocument($documentId, $reportType);

$reportDocument = $response->dto();

/*
 * - Array of arrays, where each sub array corresponds to a row of the report, if this is a TSV, CSV, or XLSX report
 * - A nested associative array (from json_decode) if this is a JSON report
 * - The raw report data if this is a TXT or PDF report
 * - A SimpleXMLElement object if this is an XML report
 */
$contents = $reportDocument->download($reportType);

The download method has three parameters:

documentType (string): The report type (or feed type of the feed result document being fetched). This is required if you want the document data parsed for you.
preProcess (bool): Whether to preprocess the document data. If true, the document data will be parsed and formatted into a more usable format. If false, the raw document text will be returned. Defaults to true.
encoding (string): The encoding of the document data. Defaults to UTF-8.

If you are working with huge documents you can use downloadStream() to minimize the memory consumption. downloadStream() returns a Psr\Http\Message\StreamInterface.

$streamContents = $reportDocument->downloadStream();  // The raw report stream

Uploading a feed document

use SellingPartnerApi\Seller\FeedsV20210630\Dto\CreateFeedDocumentSpecification;
use SellingPartnerApi\Seller\FeedsV20210630\Dto\CreateFeedSpecification;
use SellingPartnerApi\Seller\FeedsV20210630\Responses\CreateFeedDocumentResponse;

$feedType = 'POST_PRODUCT_PRICING_DATA';

$connector = SellingPartnerApi::seller(/* ... */);
$feedsApi = $connector->feedsV20210630();

// Create feed document
$contentType = CreateFeedDocumentResponse::getContentType($feedType);
$createFeedDoc = new CreateFeedDocumentSpecification($contentType);
$createDocumentResponse = $feedsApi->createFeedDocument($createFeedDoc);
$feedDocument = $createDocumentResponse->dto();

// Upload feed contents to document
$feedContents = file_get_contents('your/feed/file.xml');
$feedDocument->upload($feedType, $feedContents);

$createFeedSpec = new CreateFeedSpecification(
    marketplaceIds: ['ATVPDKIKX0DER'],
    inputFeedDocumentId: $feedDocument->feedDocumentId,
    feedType: $feedType,
);

// Create feed with the feed document we just uploaded
$createFeedResponse = $feedsApi->createFeed($createFeedSpec);
$feedId = $createFeedResponse->dto()->feedId;

If you are working with feed documents that are too large to fit in memory, you can pass anything that Guzzle can turn into a stream into FeedDocument::upload() instead of a string.

Downloading a feed result document

This process is very similar to downloading a report document:

use SellingPartnerApi\SellingPartnerApi;

$feedType = 'POST_PRODUCT_PRICING_DATA';
// Assume we already got a feed result document ID from a previous getFeed call
$documentId = '1234567890.asdf';

$connector = SellingPartnerApi::seller(/* ... */);
$response = $connector->feedsV20210630()->getFeedDocument($documentId);
$feedDocument = $response->dto();

$contents = $feedResultDocument->download($feedType);

OAuth

The Selling Partner API OAuth flow is fully documented here. I highly recommend reading that page in its entirety before trying to implement the OAuth flow.

Once your SP API application is configured for OAuth by specifying login and redirect URIs, you can use this library's OAuth connector to generate the authorization URIs you need, and to convert incoming OAuth requests into working client credentials.

Building authorization URIs

To create a seller-specific authorization URI, you'll need:

Your app's ID, LWA client ID and secret
A redirect URI that matches one you specified in your application config in Seller Central
A base64-encoded state string, which is used to verify that the authorization request was not altered

Then, all you need to do is:

use SellingPartnerApi\Enums\Marketplace;
use SellingPartnerApi\OAuth;

$oauth = new OAuth(
    clientId: 'amzn1.application-oa2-client.asdfqwertyuiop...',
    clientSecret: 'amzn1.oa2-cs.v1.1234567890asdfghjkl...',
    redirectUri: 'https://example.com/redirect',
);

$authUrl = $oauth->getAuthorizationUri(
    appId: 'amzn1.sp.solution...',
    state: 'unique-base64-encoded-string',
    // The marketplace that you want to authorize the seller in
    marketplace: Marketplace::US,
    // If your app is published on the Marketplace Appstore, pass this parameter:
    // draftApp: false,
);

// Redirect your user to $authUrl...

Generating a refresh token from an authorization code

The other half of the OAuth equation is receiving the inbound request from Amazon when the user finishes the authorization flow, and converting the authorization code from that request into working SP API credentials. Amazon sends that authorization code to the redirect URI you specified in the authorization URI, in the spapi_oauth_code query parameter. Once you've verified that the incoming state parameter matches the state value passed to OAuth::getAuthorizationUri(), you can generate a refresh token like so:

use SellingPartnerApi\OAuth;

// Parse query parameters from inbound Amazon request...
$authCode = $query['spapi_oauth_code'];

$oauth = new OAuth(
    clientId: 'amzn1.application-oa2-client.asdfqwertyuiop...',
    clientSecret: 'amzn1.oa2-cs.v1.1234567890asdfghjkl...',
    redirectUri: 'https://example.com/redirect',
);

$refreshToken = $oauth->getRefreshToken($authCode);

Now you can pass $refreshToken to SellingPartnerApi::seller() in order to make calls to the SP API as the seller that you authorized!

Naming conventions

Wherever possible, the names of the classes, methods, and properties in this package are identical to the names used in the Selling Partner API documentation. There are limited cases where this is not true, such as where the SP API documentation itself is inconsistent: for instance, there are some cases the SP API docs name properties in UpperCamelCase instead of camelCase, and in those cases the properties are named in camelCase in this package. Methods are named in camelCase, and DTOs are named in UpperCamelCase.

Instead of maintaining a redundant set of documentation, we link to the official SP API documentation whenever possible. If it's unclear how to use a particular method or DTO, check out the corresponding section of the official SP API documentation.

jlevers / selling-partner-api

Maintainers

Details