README

Amazon Marketplace Web Service (MWS) will no longer be available after December 31, 2023. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information

Please visit this repository from jlevers if you are searching for a good SP-API client

Amazon Marketplace Webservices

Interaction with the Amazon Api for vendors called MWS

Installation:

$ composer require matteocacciola/amazon-mws

Initiate the client

require_once 'vendor/autoload.php';

$client = new MCS\MWSClient([
    'Marketplace_Id' => '',
    'Seller_Id' => '',
    'Access_Key_ID' => '',
    'Secret_Access_Key' => '',
    'MWSAuthToken' => '' // Optional. Only use this key if you are a third party user/developer
]);

// Optionally check if the supplied credentials are valid
if ($client->validateCredentials()) {
    // Credentials are valid
} else {
    // Credentials are not valid
}

Get orders

$fromDate = new DateTime('2016-01-01');
$orders = $client->ListOrders($fromDate);
foreach ($orders as $order) {
    $items = $client->ListOrderItems($order['AmazonOrderId']);
    print_r($order);
    print_r($items['ListOrderItems']);
}

Update order delivery status

$client->SetDeliveryStatus([
    $AmazonOrderId => [
        "carrierCode" => "UPS",
        "carrierName" => "Carrier Name",
        "trackingCode" => "34JD943T6", // optional
        "shippingMethod" => "1 Day", // required
    ]
]);

One of the two between "carrierCode" or "carrierName" is required, as well as "shippingMethod".

Update order status

$client->OrderAcknowledgement([
    $AmazonOrderId => [
        "statusCode" => "Unshipped|PartiallyShipped|Shipped" // required
]);

Get product attributes

$searchField = 'ASIN'; // Can be GCID, SellerSKU, UPC, EAN, ISBN, or JAN

$result = $client->GetMatchingProductForId([
    '<ASIN1>', '<ASIN2>', '<ASIN3>'
], $searchField);

print_r($result);

Create or update a product

$product = new MCS\MWSProduct();
$product->sku = 'TESTNOTFORSALE';
$product->price = '1000.00';
$product->product_id = 'B0031S9***';
$product->product_id_type = 'ASIN';
$product->condition_type = 'New';
$product->quantity = 10;

if ($product->validate()) {
    // You can also submit an array of MWSProduct objects
    $result = $client->PostProduct($product);    
} else {
    $errors = $product->getValidationErrors();        
}

Update product stock

$result = $client->UpdateStock([
    'sku1' => 20,
    'sku2' => 9,
]);
print_r($result);

$info = $client->GetFeedSubmissionResult($result['FeedSubmissionId']);
print_r($info);

Update product stock with fulfillment latency specified

$result = $client->UpdateStockWithFulfillmentLatency([
    ['sku' => 'sku1', 'quantity' => 20, 'latency' => 1],
    ['sku' => 'sku2', 'quantity' => 20, 'latency' => 1],
]);
print_r($result);

$info = $client->GetFeedSubmissionResult($result['FeedSubmissionId']);
print_r($info);

Update product pricing

$result = $client->UpdatePrice([
    'sku1' => '20.99',
    'sku2' => '100.00',
]);
print_r($result);

$info = $client->GetFeedSubmissionResult($result['FeedSubmissionId']);
print_r($info);

Reports

For all report types, visit: http://docs.developer.amazonservices.com

$reportId = $client->RequestReport('_GET_MERCHANT_LISTINGS_DATA_');
// Wait a couple of minutes and get it's content
$report_content = $client->GetReport($reportId);
print_r($report_content);

Available methods

View source for detailed argument description. All methods starting with an uppercase character are also documented in the Amazon MWS documentation

// Returns the current competitive price of a product, based on ASIN.
$client->GetCompetitivePricingForASIN($asin_array = []);

// Returns the feed processing report and the Content-MD5 header.
$client->GetFeedSubmissionResult($FeedSubmissionId);

// Returns pricing information for the lowest-price active offer listings for up to 20 products, based on ASIN.
$client->GetLowestOfferListingsForASIN($asin_array = [], $ItemCondition = null);

// Returns lowest priced offers for a single product, based on ASIN.
$client->GetLowestPricedOffersForASIN($asin, $ItemCondition = 'New');

// Returns a list of products and their attributes, based on a list of ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN values.
$client->GetMatchingProductForId($asin_array, $type = 'ASIN');

// Returns a list of products and their attributes, based on an open text based query
$client->ListMatchingProducts($query, $query_context_id = null);

// Returns pricing information for your own offer listings, based on ASIN.
$client->GetMyPriceForASIN($asin_array = [], $ItemCondition = null);

// Returns pricing information for your own offer listings, based on SKU.
$client->GetMyPriceForSKU($sku_array = [], $ItemCondition = null);

// Returns an order based on the AmazonOrderId values that you specify.
$client->GetOrder($AmazonOrderId);

// Update the information about shipping of an order.
$client->SetDeliveryStatus(array $data);

// Update the information about status of an order.
$client->OrderAcknowledgement(array $data);

// Get eligible shipping services
$client->GetEligibleShippingServices($shipmentRequestDetails = []);

// create shipment
$client->CreateShipment($shipmentRequestDetails = []);

// Returns the parent product categories that a product belongs to, based on ASIN.
$client->GetProductCategoriesForASIN($ASIN);

// Returns the parent product categories that a product belongs to, based on SellerSKU.
$client->GetProductCategoriesForSKU($SellerSKU);

// Delete product(s) based on SKU
$client->DeleteProductBySKU(array $SKU);

// Get a report's content
$client->GetReport($ReportId);

// Returns a list of reports that were created in the previous 90 days.
$client->GetReportList($ReportTypeList = []);

// Returns a list of order report requests that are scheduled to be submitted to Amazon MWS for processing.
$client->GetReportScheduleList($ReportTypeList = []);

// Get a report's processing status
$client->GetReportRequestStatus($ReportId);

// Get a list's inventory for Amazon's fulfillment
$client->ListInventorySupply($sku_array = []);

// Returns a list of marketplaces that the seller submitting the request can sell in, and a list of participations that include seller-specific information in that marketplace
$client->ListMarketplaceParticipations();

// Returns orders created or updated during a time frame that you specify.
$client->ListOrders($from, $allMarketplaces = false, $states = ['Unshipped', 'PartiallyShipped'], $FulfillmentChannel = 'MFN', $tillDate = null, $fromUpdated = false);

// Returns orders created or updated during a time frame that you specify, surfing along all the next tokens.
$client->ListOrdersWithAllNextTokens($from, $allMarketplaces = false, $states = ['Unshipped', 'PartiallyShipped'], $FulfillmentChannel = 'MFN', $tillDate = null, $fromUpdated = false);

// Returns orders created or updated, by the next token.
$client->ListOrdersByNextToken($nextToken);

// Returns order items based on the AmazonOrderId that you specify.
$client->ListOrderItems($AmazonOrderId);

// Returns order items based on the AmazonOrderId that you specify, surfing along all the next tokens.
$client->ListOrderItemsWithAllNextTokens($AmazonOrderId);

// Returns order items, by the next token.
$client->ListOrderItemsByNextToken($NextToken);

// Returns your active recommendations for a specific category or for all categories for a specific marketplace.
$client->ListRecommendations($RecommendationCategory = null);

// Creates a report request and submits the request to Amazon MWS.
$client->RequestReport($report, $StartDate = null, $EndDate = null);

// Uploads a feed for processing by Amazon MWS.
$client->SubmitFeed($FeedType, $feedContent, $debug = false);

// Returns a list of all feed submissions submitted in the previous 90 days.
$client->GetFeedSubmissionList();

// Call this method to get the raw feed instead of sending it
$client->debugNextFeed();

// Post to create or update a product (_POST_FLAT_FILE_LISTINGS_DATA_)
$client->PostProduct($MWSProduct);

// Update a product's price
$client->UpdatePrice($array);

// Update a product(s) stock quantity
$client->UpdateStock($array);

// A method to quickly check if the supplied credentials are valid
$client->validateCredentials();

// List of Financial Events
$client->ListFinancialEvents($fromDate);

// List of Financial Events, surfing along all the next tokens.
$client->ListFinancialEventsWithAllNextTokens($fromDate);

// List of Financial Events by Next token
$client->ListFinancialEventsByNextToken($token);

matteocacciola / amazon-mws

Maintainers

Details