Amazon Marketplace Web Service: Getting Started Guide (API Version 2009-01-01)
Amazon Marketplace Web Service: Getting Started Guide (API Version 2009-01-01)
Amazon Marketplace Web Service: Getting Started Guide (API Version 2009-01-01)
Web Service
Getting Started Guide
(API Version 2009-01-01)
10/20/2010
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
10/20/2010
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Table of Contents
Welcome ............................................................................................................................................................ 1
What's New ....................................................................................................................................................... 3
Introduction to Amazon Marketplace Web Service ........................................................................................... 4
Getting Started .................................................................................................................................................. 5
Registering for a Seller Account ........................................................................................................... 6
Signing Up for MWS ............................................................................................................................. 7
Getting the Tools You Need ................................................................................................................. 9
Getting the Sample Code .................................................................................................................... 11
Configuring Your Credentials .............................................................................................................. 13
Running a Sample ............................................................................................................................... 16
Next Steps ....................................................................................................................................................... 18
Developing an MWS Application ......................................................................................................... 19
MWS Credentials ................................................................................................................................. 20
MWS Endpoints ................................................................................................................................... 21
10/20/2010
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Audience
Welcome
• Audience (p. 1)
• Required Knowledge and Skills (p. 1)
• Related Resources (p. 2)
This is the Amazon Marketplace Web Service Getting Started Guide. This section describes who
should read this guide and where to find other resources related to Amazon Marketplace Web Service.
Amazon Marketplace Web Service will occasionally be referred to within this guide as simply "Amazon
MWS" or "MWS"; all copyrights and legal protections still apply.
Audience
This guide is intended for developers who are building applications that will use Amazon Marketplace
Web Service to handle product listing, download orders for fulfillment, confirm shipments, and other
management tasks for Amazon sellers.
To use Amazon MWS, you must have an eligible Amazon seller account and be registered to use
Amazon MWS. See the Getting Started (p. 5) topic for more information.
10/20/2010
1
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Related Resources
Related Resources
The table below lists related resources that you'll find useful as you work with Amazon MWS.
Description Resource
Community-based http://www.amazonsellercommunity.com/forums/category.jspa?
forum for developers categoryID=4
to discuss technical
questions related to
Amazon MWS.
10/20/2010
2
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
What's New
This What's New is associated with the 2009-01-01 release of Amazon Marketplace Web Service. This
guide was last updated on 20 October 2010.
The following table describes the important changes since the last release of the Amazon Marketplace
Web Service Getting Started Guide.
Sixth Release Updated guide to include all eligible Amazon October 2010
seller types and to include information about the
API Version 2009-01-01 MWS Fulfillment operations in the overview topic.
Fourth Release Removed all references to Beta in this guide. February 2010
Public Beta
First Release This is the first public release of the Amazon April 2009
Marketplace Web Service Getting Started Guide.
Public Beta
10/20/2010
3
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Overview of Amazon Marketplace Web Service
Introduction to Amazon
Marketplace Web Service
This introduction to Amazon Marketplace Web Service is intended to give you a brief summary. After
reading this section, you should have an idea of what Amazon MWS offers and how it can fit in with
your business.
• Inventory management— You can perform batch uploads of inventory, add products, check
inventory levels, examine pricing information, and other inventory management tasks.
• Order management— You can download order information, obtain payment data, acknowledge
orders, and schedule reports.
• Reports management— You can use Amazon MWS to request generation of a variety of reports;
you can query the status of these reports, and then download them.
For Fulfillment by Amazon (FBA) sellers, Amazon MWS also allows you to:
• Create inbound shipments to the fulfillment center— You can automate the process for creating
labels for units you ship to a fulfillment center.
• Check status of inbound shipments— You can check to see if your shipment has reached a
fulfillment center and, if so, whether the shipment has been processed.
• Submit fulfillment orders— By integrating your system with Amazon MWS, you can enable your
customers to submit multi-channel fulfillment orders any time. There's no lag time while you process
or batch orders.
• Track and manage outbound shipment requests— Once orders have left our fulfillment centers,
you can track shipments and keep your customers aware of arrival times.
10/20/2010
4
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Getting Started
These sections walk you through each of the tasks you must complete before you can submit a request
to Amazon Marketplace Web Service. The sections are presented in the best order to follow so that
you can run a sample as quickly as possible.
10/20/2010
5
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Registering for a Seller Account
In the United States, you can find more information about eligible Amazon accounts by going to http://
www.amazonservices.com/.
If you need to sign up for a seller account or upgrade to a Pro Merchant Amazon seller account, go to:
• DE: http://www.amazon.de/gp/seller-account/mm-product-page.html?topic=200331350
• FR: http://www.amazon.fr/gp/seller-account/mm-product-page.html?topic=200328420
• JP: http://www.amazonservices.jp/jp/services/sell-on-amazon.htm
• UK: http://services.amazon.co.uk/services/sell-on-amazon/how-it-works/index.html
• US: http://www.amazonservices.com/content/sell-on-amazon.htm
Next, in order to use Amazon MWS, you need to register. For more information, see Signing Up for
MWS (p. 7).
10/20/2010
6
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Signing Up for MWS
• Use MWS for your own Amazon seller account— When you sign up to use MWS for your own
Amazon seller account, MWS will assign a developer account identifier to you. When you make
MWS requests, you'll use the developer account credentials that are associated with your developer
account, plus the Merchant ID and the Marketplace ID for your seller account. These credentials are
displayed on the final page of your registration.
• Authorize another developer to access your Amazon seller account with MWS— You can
authorize a third-party developer to access your account with MWS. First, the developer needs to
give you his or her MWS developer account identifier. You enter this developer account identifier
to authorize the third-party developer to access your account. On the last page of the MWS sign-
up process, you will see your Merchant ID and Marketplace ID, which you'll need to give to your
developer so MWS requests can be made on your behalf.
• Authorize an application to access your Amazon seller account with MWS— If you want to use
an application to access your Amazon seller account, simply choose that option during the MWS
registration process. You will need to enter the developer account identifier for the application. On
the last page of the MWS sign-up process, you will see your Merchant ID and Marketplace ID. Follow
your application provider's instructions for where to enter these credentials into the application.
Before you get started, make sure you know how to log into your eligible Amazon seller account.
1. Go to
DE: http://developer.amazonservices.de
FR: http://developer.amazonservices.fr
JP: http://developer.amazonservices.jp
UK: http://developer.amazonservices.co.uk
US: http://developer.amazonservices.com
To sign up to give a developer access to your Amazon seller account with MWS
1. Go to
DE: http://developer.amazonservices.de
10/20/2010
7
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Signing Up for MWS
FR: http://developer.amazonservices.fr
JP: http://developer.amazonservices.jp
UK: http://developer.amazonservices.co.uk
US: http://developer.amazonservices.com
2. Click Sign up for MWS.
3. Log into your Amazon account.
4. Select the I want to give a developer access to my Amazon seller account with MWS radio
button.
5. Click Next.
6. Type the developer's name into the text box. This name is for your own records and does not need
to be exact.
7. Type the developer's account identifier into the next text box. This number is provided to you by
the developer and must be valid.
8. Accept the MWS License Agreement.
9. Click Submit.
Your Merchant ID and your Marketplace ID are displayed.
10. Follow the instructions that your developer has supplied to you.
To sign up to use an application to access your Amazon seller account with MWS
1. Go to
DE: http://developer.amazonservices.de
FR: http://developer.amazonservices.fr
JP: http://developer.amazonservices.jp
UK: http://developer.amazonservices.co.uk
US: http://developer.amazonservices.com
2. Click Sign up for MWS.
3. Log into your Amazon account.
4. Select the I want to use an application to access my Amazon seller account with MWS radio
button.
5. Click Next.
6. Type the application name into the text box. This name is for your own records and does not need
to be exact.
7. Type the application provider's developer account identifier into the next text box. This number is
provided to you by the application provider and must be valid.
8. Accept the MWS License Agreement.
9. Click Submit.
Your Merchant ID and your Marketplace ID are displayed.
10. Follow the instructions that your application provider has supplied to you.
10/20/2010
8
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Getting the Tools You Need
Tip
You can hide the sections of this guide that don't apply to the programming language you are
using. There is a language selection menu in the upper-right corner of pages with language-
specific text. Select your language to hide all others, or select All to show the examples in all
available languages.
Java
In order to run the Amazon Marketplace Web Service sample code, you must have the Java 2 Platform
Standard Edition 5.0 Development Kit (JDK 5.0) or newer. If your version of the JDK is older than
5.0, you must install the newer version. For more information, go to http://java.sun.com/j2se/1.5.0/
download.jsp.
java -version
1. Follow the instructions on the Sun Java web site to install the JDK (for the instructions, go to http://
java.sun.com/j2se/1.5.0/install.html).
2. Set your JAVA_HOME environment variable to point to your JDK installation location. For more
information, go to http://wso2.org/project/wsas/java/2.0-beta/docs/setting-java-home.html)
C#
To use the C# sample code, you must have the following tools from Microsoft:
10/20/2010
9
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
PHP
When you download the tools, follow the instructions that Microsoft provides for installing them.
PHP
To use the PHP sample code, you must have the following tools:
When you download the tools, follow the instructions for installing them.
10/20/2010
10
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Getting the Sample Code
DE: http://developer.amazonservices.de
FR: http://developer.amazonservices.fr
JP: http://developer.amazonservices.jp
UK: http://developer.amazonservices.co.uk
US: http://developer.amazonservices.com
Java
To download the Java project files, unzip the contents of the Java Client Library to a directory of your
choice.
After you have downloaded the project files and libraries, configure the project for your environment.
1. In Eclipse, point to File, point to New, and click on Project to create a new Java project in your
workspace, and then click Finish.
2. In the Package Explorer, expand the new project, right-click on the src file, and click Delete.
Then click OK to delete the file.
3. To configure your buildpath, right-click on your project, select Build Path, and then Configure
Build Path.
4. Link the src directory to your build path by clicking the Source tab.
Click the Link Source button and browse to the src folder in the directory where you unzipped
the Java client library, then click Finish.
5. Add all the JAR files under the third-party/* directory to your build path, by clicking the
Libraries tab.
Navigate to the third-party folder in the directory where you unzipped the MWS Java client
library, open the first folder and select a JAR file.
6. Continue adding the JAR files in the third-party directory until all nine files have been added.
7. Add the Java client library file that is located in the dist\lib as the final external library JAR file,
and then click OK to return to your project.
To run the samples that are included with the Amazon MWS Java client library, you need to insert your
own credentials. For more information, go to the topic, Configuring Your Credentials (p. 13).
C#
1. To download the C# project files, unzip the contents of the C# Client Library to a directory of your
choice.
2. After you have downloaded the project files and libraries, configure the project for your
environment.
To run the samples that are included with the Amazon MWS C# client library, you need to insert your
own credentials. For more information, go to the topic, Configuring Your Credentials (p. 13).
10/20/2010
11
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
PHP
PHP
1. To download the PHP project files, unzip the contents of the PHP Client Library to a directory of
your choice.
2. After you have downloaded the project files and libraries, configure the project for your
environment.
To run the samples that are included with the Amazon MWS PHP client library, you need to insert your
own credentials. For more information, go to the topic, Configuring Your Credentials (p. 13).
10/20/2010
12
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Configuring Your Credentials
Note
Before you can send queries to Amazon MWS, you must sign up. For more information, see
the topic, Signing Up for MWS (p. 7).
For information about downloading the MWS client libraries, see the topic, Getting the Sample Code (p.
11).
For information about obtaining your MWS credentials, see the topic, MWS Credentials (p. 20).
For information about MWS endpoints, see the topic, MWS Endpoints (p. 21).
Java
1. In your development environment, in the src\com.amazonaws.mws.samples folder, open a
sample to configure.
2. Set your MWS endpoint by uncommenting the correct endpoint for your locale.
// US
// config.setServiceURL("https://mws.amazonservices.com");
// UK
// config.setServiceURL("https://mws.amazonservices.co.uk");
// JP
// config.setServiceURL("https://mws.amazonservices.jp");
// Germany
// config.setServiceURL("https://mws.amazonservices.de");
// France
// config.setServiceURL("https://mws.amazonservices.fr");
3. Set your Access Key ID and Secret Access Key by replacing the strings within the quotes with
your own developer credentials.
4. Set your Application or Company Name and Version by replacing the strings within the quotes with
your own credentials.
5. Set your Marketplace ID and Merchant ID by replacing the strings within the quotes with your own
credentials.
10/20/2010
13
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
C#
To run the samples that are included with the Amazon MWS Java client library, go to the topic,
Running a Sample (p. 16).
C#
1. Open the MarketplaceWebService.sln project file.
2. Open the MarketplaceWebServicesSample.cs file.
3. Set your MWS endpoint by uncommenting the correct endpoint for your locale.
// United States:
// config.ServiceURL = "https://mws.amazonservices.com";
//
// United Kingdom:
// config.ServiceURL = "https://mws.amazonservices.co.uk";
//
// Japan:
// config.ServiceURL = "https://mws.amazonservices.jp";
//
// Germany:
// config.ServiceURL = "https://mws.amazonservices.de";
//
// France:
// config.ServiceURL = "https://mws.amazonservices.fr";
4. Set your Access Key ID and Secret Access Key by replacing the strings within the quotes with
your own developer credentials.
5. Set your Application or Company Name and Version by replacing the strings within the quotes with
your own credentials.
6. Set your Marketplace ID and Merchant ID by replacing the strings within the quotes with your own
credentials.
To run the samples that are included with the Amazon MWS C# client library, go to the topic, Running
a Sample (p. 16).
PHP
1. Open the .config.inc.php file in the Samples directory.
2. Set your MWS endpoint by uncommenting the correct endpoint for your locale.
10/20/2010
14
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
PHP
// United States:
//$serviceUrl = "https://mws.amazonservices.com";
// United Kingdom
//$serviceUrl = "https://mws.amazonservices.co.uk";
// Japan
//$serviceUrl = "https://mws.amazonservices.jp";
// Germany
//$serviceUrl = "https://mws.amazonservices.de";
// France
//$serviceUrl = "https://mws.amazonservices.fr";
3. Set your Access Key ID and Secret Access Key by replacing the strings with your own developer
credentials.
4. Set your Application or Company Name and Version by replacing the strings with your own
credentials.
5. Set your Marketplace ID and Merchant ID by replacing the strings with your own credentials.
To run the samples that are included with the Amazon MWS PHP client library, go to the topic,
Running a Sample (p. 16).
10/20/2010
15
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Running a Sample
Running a Sample
The MWS client libraries include code samples for each available service API function. In order to run
any of these samples, you need to insert your own credentials. For more information, see the topic,
Configuring Your Credentials (p. 13).
Java
After you've entered your own credentials into a sample file, you can uncomment additional parameters
and then run the sample. For example, in the GetFeedSubmissionCountSample file:
// invokeGetFeedSubmissionCount(service, request);
GetFeedSubmissionCountResponse
GetFeedSubmissionCountResult
Count
72
ResponseMetadata
RequestId
a555ef03-d2c1-4f42-bae1-e82aee7488c6
C#
After you've entered your own credentials into the MarketplaceWebServicesSample.cs file,
you can uncomment additional parameters and then run the sample. For example, to run the
GetFeedSubmissionCountSample, complete the following steps.
1. Uncomment the first three and the fifth of the following lines.
GetFeedSubmissionCountResponse
GetFeedSubmissionCountResult
10/20/2010
16
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
PHP
Count
72
ResponseMetadata
RequestId
a555ef03-d2c1-4f42-bae1-e82aee7488c6
PHP
After you've entered your own credentials into the .config.inc.php file, you can
uncomment additional parameters and then run the sample. For example, to run the
GetFeedSubmissionCountSample, complete the following steps.
• Uncomment at least the first three and the fifth of the following lines.
//$request = new
MarketplaceWebService_Model_GetFeedSubmissionCountRequest();
//$request->setMerchant(MERCHANT_ID);
//$request->setMarketplace(MARKETPLACE_ID);
//object or array of parameters
//invokeGetFeedSubmissionCount($service, $request);
GetFeedSubmissionCountResponse
GetFeedSubmissionCountResult
Count
72
ResponseMetadata
RequestId
a555ef03-d2c1-4f42-bae1-e82aee7488c6
10/20/2010
17
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Next Steps
Now that you've completed the basic example presented in this guide, you're ready to start designing
your own application. These topics provide additional information.
10/20/2010
18
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
Developing an MWS Application
If you are a developer who wants to use Amazon MWS to build professional software for other eligible
Amazon sellers to use for managing their Amazon businesses, you must first sign up for Amazon MWS
with your own eligible Amazon account. On the last page of your Amazon MWS registration, make note
of your developer account identifier, as you'll need to provide this number to sellers who want to use
your developer services or application.
When your software is ready for testing with additional seller accounts, you can provide sellers with
your developer account identifier, which they can use to register for Amazon MWS. The sellers log into
their own eligible Amazon accounts and insert your developer account identifier during the registration
process. The sellers will need to make note of the Merchant ID and Marketplace ID for their accounts,
and pass that information to you. You will then be able to make Amazon MWS requests on their behalf,
using their seller credentials and your developer credentials.
When you have had several Amazon sellers using your software for a few months, and you believe
your software is ready to be available commercially, you can notify the Amazon MWS team by
contacting us at http://developer.amazonservices.com and we will assist you in developing a larger-
scale registration solution.
For further assistance with building your application, we suggest you use the other available resources
for Amazon MWS. For more information, see Related Resources (p. 2).
Note
• DE: http://developer.amazonservices.de
• FR: http://developer.amazonservices.fr
• JP: http://developer.amazonservices.jp
• UK: http://developer.amazonservices.co.uk
• US: http://developer.amazonservices.com
for additional information about developing MWS applications for Amazon sellers and the
authorization process.
10/20/2010
19
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
MWS Credentials
MWS Credentials
When you sign up to use MWS for your own Amazon seller account you are issued a pair of developer
credentials, which you need to make successful requests to Amazon MWS, as well as a developer
account identifier, which is necessary for you to retain for future use. If you are developing MWS
applications or otherwise providing MWS-related development services to other sellers, you will need
to provide this developer account identifier to those sellers so that they can authorize you to access
their Amazon seller accounts with MWS.
For information about signing up for MWS and getting your credentials, see the topic, Signing Up for
MWS (p. 7)
Caution
Your Secret Access Key is a secret that only you and MWS should know. It is important to
keep it confidential to protect your account. Never include it in your requests to MWS, and
never e-mail it to anyone. Do not share it outside your organization, even if an inquiry appears
to come from MWS or anyone else at Amazon. No one who legitimately represents Amazon
will ever ask you for your Secret Access Key.
The Access Key ID is associated with your MWS registration. You include it in all MWS requests to
identify yourself as the sender of the request.
The Access Key ID is not a secret. To provide proof that you truly are the sender of the request, you
must also include a digital signature. For all requests except those generated using the Amazon MWS
client libraries, you calculate the signature using your Secret Access Key. MWS uses the Access
Key ID in the request to look up your Secret Access Key and then calculates a digital signature with
the key. If the signature MWS calculates matches the signature you sent, the request is considered
authentic. Otherwise, the request fails authentication and is not processed.
10/20/2010
20
Amazon Marketplace Web Service Getting
Started Guide (API Version 2009-01-01)
MWS Endpoints
MWS Endpoints
AmazonMWS Endpoint MWS Website
Marketplace
DE https://mws.amazonservices.de http://developer.amazonservices.de
FR https://mws.amazonservices.fr http://developer.amazonservices.fr
JP https://mws.amazonservices.jp http://developer.amazonservices.jp
UK https://mws.amazonservices.co.uk http://
developer.amazonservices.co.uk
US https://mws.amazonservices.com http://developer.amazonservices.com
10/20/2010
21