Amazon Marketplace Web Service Fulfillment API Sections

94 Pages·2010·0.43 MB·English

Amazon Marketplace Web
Service Fulfillment API Sections
API Reference
API Version 2010-10-01
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Amazon Marketplace Web Service Fulfillment API Sections: API
Reference
Copyright © 2010 Amazon.com, Inc. or its affiliates. All rights reserved.
AMAZON and AMAZON.COM are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property of
their respective owners.
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Table of Contents
Welcome.............................................................................................................................................................1
What's New ........................................................................................................................................................ 4
Fulfillment Inbound Shipment API Section Reference........................................................................................5
Fulfillment Inbound Shipment API Section Operations...........................................................................5
CreateInboundShipment ............................................................................................................... 6
CreateInboundShipmentPlan ........................................................................................................ 7
GetServiceStatus (Inbound)........................................................................................................10
ListInboundShipmentItems..........................................................................................................11
ListInboundShipmentItemsByNextToken.....................................................................................13
ListInboundShipments.................................................................................................................15
ListInboundShipmentsByNextToken............................................................................................18
UpdateInboundShipment.............................................................................................................20
Data Types............................................................................................................................................22
Address ....................................................................................................................................... 22
InboundShipmentHeader ............................................................................................................ 23
InboundShipmentItem ................................................................................................................. 24
InboundShipmentPlan ................................................................................................................. 25
InboundShipmentPlanRequestItem.............................................................................................25
Fulfillment Inventory API Section Reference....................................................................................................27
Fulfillment Inventory API Section Operations.......................................................................................27
GetServiceStatus (Inventory) ...................................................................................................... 28
ListInventorySupply ..................................................................................................................... 30
ListInventorySupplyByNextToken ................................................................................................ 35
Inventory Data Types............................................................................................................................ 37
InventorySupply...........................................................................................................................37
SupplyDetailList...........................................................................................................................38
Fulfillment Outbound Shipment API Section Reference...................................................................................40
Fulfillment Outbound Shipment API Section Operations......................................................................41
CancelFulfillmentOrder................................................................................................................41
CreateFulfillmentOrder ................................................................................................................ 42
GetFulfillmentOrder ..................................................................................................................... 46
GetFulfillmentPreview..................................................................................................................50
GetServiceStatus (Outbound) ..................................................................................................... 55
ListAllFulfillmentOrders ............................................................................................................... 56
ListAllFulfillmentOrdersByNextToken .......................................................................................... 60
Outbound Data Types........................................................................................................................... 63
Address ....................................................................................................................................... 64
CreateFulfillmentOrderItem ......................................................................................................... 65
Currency......................................................................................................................................66
Fee .............................................................................................................................................. 67
FulfillmentOrder...........................................................................................................................67
FulfillmentOrderItem....................................................................................................................70
FulfillmentPreview ....................................................................................................................... 71
FulfillmentPreviewItem ................................................................................................................ 72
FulfillmentPreviewShipment ........................................................................................................ 73
FulfillmentShipment.....................................................................................................................74
FulfillmentShipmentItem..............................................................................................................75
FulfillmentShipmentStatus...........................................................................................................75
FulfillmentShipmentPackage ....................................................................................................... 76
GetFulfillmentPreviewItem...........................................................................................................77
UnfulfillablePreviewItem .............................................................................................................. 77
Weight ......................................................................................................................................... 78
Common Errors ................................................................................................................................................ 80
Document Conventions .................................................................................................................................... 83
Glossary ........................................................................................................................................................... 86
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Index.................................................................................................................................................................90
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Audience
Welcome
Topics
• Audience (p.1)
• Required Knowledge and Skills (p.1)
• How This Guide Is Organized (p.1)
• Resources (p.2)
The Amazon Marketplace Web Service Fulfillment API functionality is contained in three API sections:
Fulfillment Inbound Shipment API Section, Fulfillment Outbound Shipment API Section, and Fulfillment
Inventory API Section.
Audience
This guide is intended for developers who are building web-enabled applications that will use the fulfillment
operations to integrate listing, payment, or reconciliation tools with Amazon either to send inventory to
Amazon fulfillment centers or to request the centers to ship inventory to recipients.
To use the fulfillment operations, you must be registered for Fulfillment by Amazon (FBA) and registered
to use Amazon Marketplace Web Service (Amazon MWS).
Required Knowledge and Skills
Use of this guide assumes you are familiar with the following:
• XML
• Basic understanding of web services
• A programming language for consuming a web service and any related tools
How This Guide Is Organized
This guide is organized into several major sections described in the following table.
API Version 2010-10-01
1
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Resources
Information Relevant Sections
Recent changes to the documentation What's New (p.4)
Comprehensive reference for the Fulfillment Inbound Fulfillment Inbound
Shipment API Section Shipment API Section
Reference (p.5)
Comprehensive reference for the Fulfillment Outbound Fulfillment Outbound
Shipment API Section Shipment API Section
Reference (p.40)
Comprehensive reference for the Fulfillment Inventory Fulfillment Inventory API
API Section Section Reference (p.27)
Error code information Common Errors (p.80)
Resources
The following table lists related resources that you'll find useful as you work with this service.
Resource Description
Developer Guide The Developer Guide describes how
to use the service and all its
features through its application
programming interface.
• DE:https://sellercentral.amazon.de/gp/help/ The Seller Central Help page
contains topical help and answers
• FR:https://sellercentral.amazon.fr/gp/help/
to common questions for tasks
• JP:https://sellercentral-japan.amazon.com/gp/help/home.html relating to selling on Amazon and
using Amazon for fulfillment.
• UK:https://sellercentral.amazon.co.uk/gp/help/
• US:https://sellercentral.amazon.com/gp/help
• DE:http://developer.amazonservices.de MWS primary Web page for MWS
• FR:http://developer.amazonservices.fr registration and that contains the
MWS documentation, the client
• JP:http://developer.amazonservices.jp
libraries, and FAQ.
• UK:http://developer.amazonservices.co.uk
• US:http://developer.amazonservices.com
SOA Guide to XML The Selling on Amazon Guide to
XML contains important information
about using XML for Amazon
product feeds and reports.
API Version 2010-10-01
2
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Resources
Resource Description
• DE: Comprehensive information about
http://www.amazon.de/gp/seller-account/mm-product-page.html?topic=200331350 selling on Amazon.
• 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
Discussion Forums Community-based forum for
developers to discuss technical
questions related to Amazon MWS.
Conditions of Use Detailed information about the
copyright and trademark usage at
Amazon and other topics.
API Version 2010-10-01
3
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
What's New
This What's New is associated with the 2010-10-01 release of the Amazon Marketplace Web Service
Fulfillment API Sections.This guide was last updated on November 29, 2010.
The following table describes the important changes since the last release of this guide.
Change Description Release Date
GetServiceStatus The GetServiceStatus response was 18 November 2010
modified.
API Version 2010-10-01
4
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
Fulfillment Inbound Shipment API Section Operations
Fulfillment Inbound Shipment API
Section Reference
Topics
• Fulfillment Inbound Shipment API Section Operations (p.5)
• Data Types (p.22)
This reference describes the Fulfillment Inbound Shipment API Section.This is the what you use to create
inbound shipments to an Amazon fulfillment center.
Note
All Fulfillment Inbound Shipment API Section operations described in this guide are based the
Query web services protocol.
Fulfillment Inbound Shipment API Section
Operations
Topics
• CreateInboundShipment (p.6)
• CreateInboundShipmentPlan (p.7)
• GetServiceStatus (Inbound) (p.10)
• ListInboundShipmentItems (p.11)
• ListInboundShipmentItemsByNextToken (p.13)
• ListInboundShipments (p.15)
• ListInboundShipmentsByNextToken (p.18)
• UpdateInboundShipment (p.20)
This section details the request and response elements for the Fulfillment Inbound Shipment API Section
operations, including examples of raw Query requests for each operation.
API Version 2010-10-01
5
Amazon Marketplace Web Service Fulfillment API
Sections API Reference
CreateInboundShipment
CreateInboundShipment
Description
The CreateInboundShipment operation creates an inbound shipment. Once created, a the status of
the shipment is set to working.
This operation can include up to 200 items.To add more items or change the shipment status, use the
UpdateInboundShipment operation.
Request Parameters
Name Description Required
SellerId ID of the seller. Yes
Type: String
Marketplace The Marketplace ID for the specific Yes
marketplace to which the API action should
be applied.
Type: String
InboundShipmentHeader Information about the shipment. Yes
Type:InboundShipmentHeader (p.23)
InboundShipmentItems SKU and quantity information about the items. Yes
Type:InboundShipmentItem (p.24)
ShipmentId ID of the shipment. No
Response Elements
The CreateInboundShipment operation only returns the following metadata:
Name Description
ShipmentId The shipment identifier for your shipment.
Type: String
Default: None
Examples
Example Query Request
https://mws.amazonservices.com/FulfillmentInboundShipment/2010-10-01
?Action=CreateInboundShiment
&Version=2010-10-01
&AWSAccessKeyId=1QZHP81N5R44N89PFAKE
API Version 2010-10-01
6