Amazon Marketplace Web Service

122 Pages·2010·0.79 MB·English

Amazon Marketplace
Web Service
Developer Guide (Version 2009-01-01)
10/31/2010
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
Amazon Marketplace Web Service: Developer Guide (Version
2009-01-01)
Copyright © 2009-2010 Amazon.com, Inc. or its affiliates.
AMAZON and AMAZON.COM are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property
of their respective owners.
10/31/2010
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
Table of Contents
Welcome ............................................................................................................................................................ 1
What's New ....................................................................................................................................................... 4
Introduction to Amazon Marketplace Web Service ........................................................................................... 6
What Is Amazon MWS? ........................................................................................................................ 7
What Is a Feed? ................................................................................................................................... 9
Managing Inventory ............................................................................................................................. 11
Managing Orders ................................................................................................................................. 13
Managing Reports ............................................................................................................................... 15
Programming Guide ........................................................................................................................................ 17
Understanding Requests and Responses ........................................................................................... 18
Requests .................................................................................................................................... 19
MWS Endpoints ......................................................................................................................... 21
MWS Account Throttling ............................................................................................................ 22
Responses ................................................................................................................................. 24
Authentication and Authorization ......................................................................................................... 25
What Is Authentication? ............................................................................................................. 26
MWS Credentials ....................................................................................................................... 27
Calculating Signatures ............................................................................................................... 28
Authorization ............................................................................................................................... 31
Required Headers ............................................................................................................................... 33
User-Agent Header .................................................................................................................... 34
Using the Content-MD5 Header with SubmitFeed ..................................................................... 36
API Reference ................................................................................................................................................. 37
Batch Data Exchange API .................................................................................................................. 38
Operations .................................................................................................................................. 39
SubmitFeed ....................................................................................................................... 39
GetFeedSubmissionList .................................................................................................... 45
GetFeedSubmissionListByNextToken ............................................................................... 48
GetFeedSubmissionCount ................................................................................................ 50
CancelFeedSubmissions .................................................................................................. 52
GetFeedSubmissionResult ............................................................................................... 55
RequestReport .................................................................................................................. 57
GetReportRequestList ....................................................................................................... 59
GetReportRequestListByNextToken ................................................................................. 62
GetReportRequestCount ................................................................................................... 65
CancelReportRequests ..................................................................................................... 67
GetReportList .................................................................................................................... 70
GetReportListByNextToken ............................................................................................... 73
GetReportCount ................................................................................................................ 76
GetReport ......................................................................................................................... 79
ManageReportSchedule ................................................................................................... 81
GetReportScheduleList ..................................................................................................... 83
GetReportScheduleListByNextToken ................................................................................ 85
GetReportScheduleCount ................................................................................................. 87
UpdateReportAcknowledgements ..................................................................................... 89
Enumerations ............................................................................................................................. 92
FeedType .......................................................................................................................... 93
ReportType ....................................................................................................................... 95
Schedule ......................................................................................................................... 113
Error Codes .............................................................................................................................. 114
Glossary ........................................................................................................................................................ 116
Index .............................................................................................................................................................. 118
10/31/2010
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
Audience
Welcome
Topics
• Audience (p. 1)
• Required Knowledge and Skills (p. 1)
• How This Guide Is Organized (p. 2)
• Related Resources (p. 2)
This is the Amazon Marketplace Web Service Developer Guide. This section describes who should
read this guide, how the guide is organized, and other resources related to Amazon Marketplace Web
Service.
Amazon Marketplace Web Service will occasionally be referred to within this guide as simply "Amazon
MWS"; all copyrights and legal protections still apply.
Audience
This guide is intended for developers who are building web-enabled applications that will use Amazon
Marketplace Web Service to handle product listing, download orders for fulfillment, confirm shipments,
and other management tasks.
To use Amazon MWS, you must have access to an eligible Amazon account and be signed up to use
Amazon MWS and have your MWS account identifier and credentials. See the Authentication and
Authorization (p. 25) topic for more information.
Required Knowledge and Skills
Use of this guide assumes you are familiar with the following:
• XML (For an overview, go to the W3 Schools XML Tutorial)
• Basic understanding of web services. For an overview, go to the W3 Schools Web Services Tutorial
• A programming language for consuming a Web service and any related tools.
• Basic knowledge about selling on Amazon. Comprehensive information about selling on Amazon is
located at:
10/31/2010 1
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
How This Guide Is Organized
• DE: https://sellercentral.amazon.de/gp/help/
• FR: https://sellercentral.amazon.fr/gp/help/
• JP: https://sellercentral-japan.amazon.com/gp/help/home.html
• UK: https://sellercentral.amazon.co.uk/gp/help/
• US: https://sellercentral.amazon.com/gp/help
How This Guide Is Organized
This guide is organized into several major sections described in the table below.
Information Relevant Sections
General information about Amazon Marketplace Web Service Introduction to Amazon
Marketplace Web Service (p.
6)
Introduces the key concepts for programming Amazon Marketplace Programming Guide (p. 17)
Web Service including information about requests, authentication
and authorization, and responses as well as detailed information,
procedures, and examples for using the API
Elemental reference to the Batch Data Exchange API API Reference (p. 37)
Glossary of terms Glossary (p. 116)
Index Index (p. 118)
Related Resources
The table below lists related resources that you'll find useful as you work with Amazon MWS.
Description Resource
MWS primary Web • DE: http://developer.amazonservices.de
page for MWS • FR: http://developer.amazonservices.fr
registration, which also
• JP: http://developer.amazonservices.jp
contains the MWS
documentation, the • UK: http://developer.amazonservices.co.uk
client libraries, and • US: http://developer.amazonservices.com
FAQ.
The Selling on Amazon https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/
Guide to XML contains XML_Documentation_Intl.pdf
important information
about using XML for
Amazon product feeds
and reports.
Comprehensive • DE: https://sellercentral.amazon.de/gp/help/
information about • FR: https://sellercentral.amazon.fr/gp/help/
selling on Amazon.
• JP: https://sellercentral-japan.amazon.com/gp/help/home.html
• UK: https://sellercentral.amazon.co.uk/gp/help/
• US: https://sellercentral.amazon.com/gp/help
10/31/2010 2
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
Related Resources
Description Resource
Community-based http://www.amazonsellercommunity.com/forums/forum.jspa?forumID=43
forum for developers
to discuss technical
questions related to
Amazon MWS.
10/31/2010 3
Amazon Marketplace Web Service
Developer Guide (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 31 October 2010.
The following table describes the important changes to this document since the last release of the
Amazon Marketplace Web Service Developer Guide.
Change Description Release Date
Eighth Release Added four new report types for FBA October 2010
to the ReportType (p. 95) topic.
API Version 2009-01-01 Also removed references to only Pro
Merchants being eligible to register for
Amazon MWS.
Seventh Release Rewrote several topics to describe June 2010
the MWS registration process and
API Version 2009-01-01 the developer account identifier and
credentials. Updated guide to refer
to MWS developer account identifier.
Added new report types for Product
Ads and FBA.
Sixth Release Changed U.S. MWS Website address March 2010
from http://mws.amazon.com to http://
API Version 2009-01-01 developer.amazonservices.com. Also
changed the U.S. MWS endpoint from
https://mws.amazonaws.com to https://
mws.amazonservices.com.
Fifth Release Removed all references to Beta in this February 2010
guide.
API Version 2009-01-01
Fourth Release Added new tab-delimited flat file January 2010
FBA fulfilled shipments report:
Public Beta _GET_AMAZON_FULFILLED_SHIPMENTS_DATA_ .
Third Release Added new report and feed types, December 2009
updated API functions with throttling
Public Beta limits, updated sample code for listing
functions, and other small changes.
10/31/2010 4
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
Change Description Release Date
Second Release Updated the ReportType (p. 95) July 2009
topic with additional information.
Public Beta
First Release This is the first public release of the April 2009
Amazon Marketplace Web Service
Public Beta Developer Guide.
10/31/2010 5
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
Introduction to Amazon
Marketplace Web Service
• What Is Amazon MWS? (p. 7)
• What Is a Feed? (p. 9)
• Managing Inventory (p. 11)
• Managing Reports (p. 15)
• Managing Orders (p. 13)
This section offers an introduction to Amazon Marketplace Web Service and the concepts you need to
know to be successful.
10/31/2010 6
Amazon Marketplace Web Service
Developer Guide (Version 2009-01-01)
What Is Amazon MWS?
What Is Amazon MWS?
Topics
• Overview of Amazon Marketplace Web Service (p. 7)
• Key Amazon Seller Concepts (p. 8)
This introduction to Amazon Marketplace Web Service is intended to give you a detailed summary.
After reading this section, you should have a good idea of what Amazon MWS offers and how it can fit
in with your business.
Overview of Amazon Marketplace Web Service
The Amazon MWS API functions are designed to facilitate and automate the stages of the business
process for selling on Amazon. All eligible Amazon sellers can use Amazon MWS to manage their
online business on Amazon.
Using Amazon MWS you can create applications that look up products for sale, download orders for
fulfillment, confirm shipment, and schedule and receive reports. The Amazon MWS API functions are
accessible by using a REST-like interface.
Amazon MWS is a secure environment that uses signatures for authentication and lets sellers delegate
calling rights to developers by using the MWS authorization service. To use MWS with an Amazon Pro
Merchant seller account, complete your registration at:
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
Amazon MWS provides the following major features:
• 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 and
adjust orders, and schedule reports.
• Reports—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.
10/31/2010 7