Easy Ship API v2022-03-23ユースケースガイド
Easy Ship APIの使用方法。
APIバージョン:v2022-03-23
Easy Ship APIについて
Easy Shipの出品パートナーAPIを使用して、出品者がAmazon Easy Ship注文のパッケージを管理および出荷するためのアプリケーションを構築できます。
主な機能
- 利用可能なタイムスロットを取得できます。
- Easy Ship注文向けのEasy Shipパッケージのスケジュールと再スケジュールを行うことができます。
- 配送ラベル、請求書、保証書を印刷できます。
チュートリアル:Easy Shipパッケージのスケジュール
Easy Ship APIを使用してEasy Ship注文の荷物をスケジュールする方法をご覧ください。
ステップ1. 利用可能なタイムスロットの取得
listHandoverSlots
オペレーションを呼び出して、未スケジュールのEasy Ship注文で利用可能なタイムスロットのリストを取得します。以下の点に注意してください。
- 指定するAmazon注文IDはEasy Ship注文であり、未出荷の状態であることが必要です。
- リクエストには、希望するパッケージの重量と寸法を含める必要があります。
Easy Ship以外の注文や保留状態の注文では、エラーレスポンスが返されます。
リクエスト
Call the listHandoverSlots
operation.
リクエストの例:
POST https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/timeSlot
{
"amazonOrderId": "933-1443575-9112638",
"marketplaceId": "A21TJRUUN4KGV",
"packageDimensions": {
"length": 20.0,
"width": 10.0,
"height": 12.0,
"unit": "Cm",
"identifier": "test"
},
"packageWeight": {
"value": 100.0,
"unit": "G"
}
}
レスポンス
A successful response includes the list of available time slots. Each time slot will specify the method by which the seller will need to give the package to an Amazon carrier. Refer to supported handover methods for more details. Make sure to save the slotId
, startTime
, and endTime
of the desired slot for the next step.
レスポンスの例:
{
"amazonOrderId": "933-1443575-9112638",
"timeSlots": [
{
"handoverMethod": "Pickup",
"slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-09T23:30:00Z",
"endTime": "2022-03-10T02:00:00Z"
},
{
"handoverMethod": "Pickup",
"slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-10T02:00:00Z",
"endTime": "2022-03-10T04:30:00Z"
}
]
}
ステップ2. Easy Shipパッケージの作成
createScheduledPackage
オペレーションを呼び出して、未スケジュールのEasy Ship注文のパッケージを作成します。以下の点に注意してください。
- 指定するAmazon注文IDはEasy Ship注文であり、未出荷の状態であることが必要です。
- リクエストには、希望するパッケージの重量と寸法を含める必要があります。
Easy Ship以外の注文や保留状態の注文では、エラーレスポンスが返されます。
リクエスト
Call the createScheduledPackage
operation.
リクエストの例:
POST https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/package
{
"amazonOrderId": "933-1443575-9112638",
"marketplaceId": "A21TJRUUN4KGV",
"packageDetails": {
"packageTimeSlot": {
"slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-09T23:30:00Z",
"endTime": "2022-03-10T02:00:00Z"
}
}
}
レスポンス
呼び出しが成功した場合、レスポンスには、パッケージの重量と寸法、請求書の詳細(存在する場合)、選択されたタイムスロット、パッケージのステータスが含まれます。
レスポンスの例:
{
"packageDimensions": {
"identifier": "test",
"unit": "Cm",
"length": 20,
"width": 10,
"height": 12
},
"packageWeight": {
"unit": "G",
"value": 50
},
"invoice": {
"invoiceNumber": "IN-456",
"invoiceDate": "1.636404098172E9"
},
"scheduledPackageId": {
"amazonOrderId": "933-1443575-9112638",
"packageId": "b4be5116-98b1-6f20-a47b-03de178cfb4f"
},
"packageStatus": "ReadyForPickup",
"packageTimeSlot": {
"slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-09T23:30:00Z",
"endTime": "2022-03-10T02:00:00Z"
},
"trackingDetails": {
"trackingId": "2045079155"
}
}
チュートリアル:Easy Shipパッケージの再スケジュール
Learn how to use the Easy Ship API to reschedule a package for an Easy Ship order. To use the listHandoverSlots
and updateScheduledPackages
operations, the Amazon order with the specified orderId
must be scheduled and the Easy Ship Package must have a valid state. Refer to Tutorial: Check the status of an Easy Ship Package for more details.
ヒント
Easy Shipパッケージの選択した時間帯を更新できるのは出品者だけです。
ステップ1. 再スケジュールのための利用可能なタイムスロットの取得
listHandoverSlots
オペレーションを呼び出して、スケジュール済みのEasy Ship注文で利用可能なタイムスロットのリストを取得します。
リクエスト
Call the listHandoverSlots
operation.
リクエストの例:
POST https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/timeSlot
{
"amazonOrderId": "933-1443575-9112638",
"marketplaceId": "A21TJRUUN4KGV",
"packageDimensions": {
"length": 20.0,
"width": 10.0,
"height": 12.0,
"unit": "Cm",
"identifier": "test"
},
"packageWeight": {
"value": 100.0,
"unit": "G"
}
}
レスポンス
呼び出しが成功した場合、レスポンスには、利用可能なタイムスロットのリストが含まれます。次のステップで使用するため、希望するスロットのslotId
、startTime
、endTime
をメモしておきます。
レスポンスの例:
{
"amazonOrderId": "933-1443575-9112638",
"timeSlots": [
{
"handoverMethod": "Pickup",
"slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-09T23:30:00Z",
"endTime": "2022-03-10T02:00:00Z"
},
{
"handoverMethod": "Pickup",
"slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-10T02:00:00Z",
"endTime": "2022-03-10T04:30:00Z"
}
]
}
ステップ2. Easy Shipパッケージの更新
updateScheduledPackages
オペレーションを呼び出して、Easy Shipパッケージのタイムスロットを更新します。
リクエスト
Call the updateScheduledPackages
operation.
リクエストの例:
PATCH https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/package
{
"marketplaceId":"A21TJRUUN4KGV",
"updatePackageDetailsList":[
{
"scheduledPackageId":{
"amazonOrderId":"933-1443575-9112638",
"packageId":"b4be5116-98b1-6f20-a47b-03de178cfb4f"
},
"packageTimeSlot":{
"slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-10T02:00:00Z",
"endTime": "2022-03-10T04:30:00Z"
}
}
]
}
レスポンス
呼び出しが成功した場合、レスポンスには、パッケージの詳細と更新されたタイムスロットが含まれます。
レスポンスの例:
{
"packages": [
{
"packageDimensions": {
"identifier": "test",
"unit": "Cm",
"length": 20,
"width": 10,
"height": 12
},
"packageWeight": {
"unit": "G",
"value": 50
},
"invoice": {
"invoiceNumber": "IN-456",
"invoiceDate": "1.636404098172E9"
},
"scheduledPackageId": {
"amazonOrderId": "933-1443575-9112638",
"packageId": "b4be5116-98b1-6f20-a47b-03de178cfb4f"
},
"packageStatus": "ReadyForPickup",
"packageTimeSlot": {
"slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-10T02:00:00Z",
"endTime": "2022-03-10T04:30:00Z"
},
"trackingDetails": {
"trackingId": "2045079155"
}
}
]
}
チュートリアル:Easy Shipパッケージのステータスの確認
Easy Ship APIを使用してEasy Shipパッケージのステータスを確認する方法をご覧ください。この操作により、出品者はEasy Shipパッケージの指定された重量、寸法、時間帯、その他の詳細を確認できます。
パッケージのステータスは、パッケージに対してイベントが発生するたびに更新されます。以下のようなイベントが発生します。
- 荷物がAmazonの配送業者に提供されます。
- パッケージが購入者に配送された。
- パッケージがキャンセルされた。
- パッケージが輸送中に紛失した。
It is useful to check the current status of a package before rescheduling because packages cannot be rescheduled after they have been given to an Amazon carrier. Rescheduling operations will fail with an InvalidOrderState
code if it is attempted on a Easy Ship package in an invalid state. Refer to packageStatus
for all the different states of a package.
ステップ1. Easy Shipパッケージの取得
getScheduledPackage
オペレーションを呼び出して、Easy Shipパッケージの詳細を取得します。
リクエスト
Call the getScheduledPackage
operation.
リクエストの例:
GET https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/package?marketplaceId=A21TJRUUN4KGV&amazonOrderId=933-6451079-5067861
レスポンス
呼び出しが成功した場合、レスポンスには、パッケージの詳細が含まれます。
レスポンスの例:
{
"packageDimensions":{
"unit":"Cm",
"length":20,
"width":10,
"height":12
},
"packageWeight":{
"unit":"G",
"value":50
},
"invoice":{
"invoiceNumber":"IN-442"
},
"scheduledPackageId":{
"amazonOrderId":"933-6451079-5067861",
"packageId":"88be1771-923c-d581-5e29-e8a310916185"
},
"packageStatus":"ReadyForPickup",
"packageTimeSlot":{
"slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
"startTime": "2022-03-10T02:00:00Z",
"endTime": "2022-03-10T04:30:00Z"
},
"trackingDetails": {
"trackingId": "2045079155"
}
}
チュートリアル:シリアル番号が必要な注文商品の取り扱い
Amazon Easy Ship注文の一部の商品には、Amazonが保証書を作成できるようにシリアル番号が必要なものがあります。Easy Ship APIを使用して、どの商品にシリアル番号が必要かを確認する方法をご覧ください。
ステップ1. シリアル番号が必要な注文のリストの取得
Call the getOrderItems
operation, specifying the Amazon Order ID for the order that you want to create a scheduled package for.
注文に含まれる商品がAmazonから返されますが、シリアル番号が必要な商品にはSerialNumberRequired
=true
というマークが付加されています。
ステップ2. シリアル番号付きのEasy Shipパッケージのスケジュール
Call the createScheduledPackage
operation using PackageItems
to specify serial numbers for all of the items marked SerialNumberRequired
=true
in Step 1. Don't specify serial numbers for items marked SerialNumberRequired
=false
.
Amazon generates warranty documents for the items that you specified serial numbers for. For information about getting the documents that Amazon generates when you create a scheduled package, refer to Tutorial: Get invoice, shipping label, and warranty documents.
チュートリアル:配送ラベル、請求書、保証書を入手する
購入者がインドでAmazon Easy Ship注文を行うと、Amazonによって請求書が生成されます。CreateScheduledPackage
オペレーションを呼び出して、注文に対してAmazon Easy Shipタイムスロットをスケジュールすると、Amazonによって配送ラベルが生成されます。CreateScheduledPackage
の呼び出しで指定した商品に対してシリアル番号を含めた場合、その商品の保証書も生成されます。このトピックでは、スケジュール済みAmazon Easy Ship注文の請求書、配送ラベル、保証書を取得する方法について説明します。
ステップ1. Easy Shipフィードリクエストの送信
フィードリクエストを送信して、目的のEasy Ship注文のドキュメントをリクエストします。フィードリクエストが正常に処理された後、処理レポートをダウンロードしてレポート参照IDを取得できます。次のステップでは、このIDを使用して、リクエストしたEasy Shipドキュメントをダウンロードできます。
-
Follow the Tutorial: Submit a Feed to submit an Easy Ship feed. The tutorial explains all the steps from submitting the feed document to verifying the feed request has been completed successfully.
FeedContent.
UseEasyshipDocuments.xsd
to form the content of the feed document.FeedType.
SpecifyPOST_EASYSHIP_DOCUMENTS
when calling thecreateFeed
operation.ReportReferenceId.
フィード処理レポートにエラーがなければ、返された値は次のステップで使用できます。
Easy Shipフィードドキュメントの例:
<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd"> <Header> <DocumentVersion>1.01</DocumentVersion> <MerchantIdentifier>ABCDEFG007V</MerchantIdentifier> </Header> <MessageType>EasyShipDocument</MessageType> <Message> <MessageID>1</MessageID> <EasyShipDocument> <AmazonOrderID>933-6451079-5067861</AmazonOrderID> <DocumentType>ShippingLabel</DocumentType> <DocumentType>Invoice</DocumentType> <DocumentType>Warranty</DocumentType> </EasyShipDocument> </Message> </AmazonEnvelope>Easy Shipフィード処理レポートの例:
<EasyShipProcessingReport> <FeedSubmissionID>98765432100</FeedSubmissionID> <MessagesProcessed>1</MessagesProcessed> <MessagesSuccessful>1</MessagesSuccessful> <MessagesWithError>0</MessagesWithError> <DocumentReportReferenceID>123456789000</DocumentReportReferenceID> </EasyShipProcessingReport>
ステップ2. PDFの取得
Amazon Easy Ship注文の請求書、配送ラベル、保証書(利用可能な場合)を含むPDFを取得します。
-
Call the
getReport
operation. When specifying thereportId
parameter, use theReportReferenceId
value from Step 1. Submit an Easy Ship Feed Request.The operation returns a
reportDocumentId
value that you can pass into thegetReportDocument
operation in the following step. -
Call the
getReportDocument
operation, specifying thereportDocumentId
from the previous step. Refer to Retrieve a report for more details.
マーケットプレイスのサポート
Easy Shipオペレーションは一部のマーケットプレイスでのみ利用可能で、特定のオペレーションのサポートはマーケットプレイスごとに異なります。マーケットプレイスでサポートされている操作については、以下の表を参照してください。
マーケットプレイス | 地域 | Supported handover methods | Get time slots | Create package | Update package | Get package status | Shipping label | 請求書 | 保証 | Bulk Package Scheduling |
---|---|---|---|---|---|---|---|---|---|---|
メキシコ | NA | Pickup and Dropoff | 未スケジュールの注文のみ | サポート対象 | サポートなし | サポート対象 | サポート対象 | サポートなし | サポートなし | サポートなし |
インド | EU | Pickup またはall | 予定注文と予定外注文 | サポート対象 | サポート対象 | サポート対象 | サポート対象 | サポート対象 | サポート対象 | サポートなし |
トルコ | EU | Pickup and Dropoff | 未スケジュールの注文のみ | サポート対象 | サポートなし | サポート対象 | サポート対象 | サポートなし | サポートなし | サポートなし |
オーストラリア | FE | Pickup またはall | 未スケジュールの注文のみ | サポート対象 | サポートなし | サポート対象 | サポート対象 | サポートなし | サポートなし | サポートなし |
シンガポール | FE | Pickup またはall | 未スケジュールの注文のみ | サポート対象 | サポートなし | サポート対象 | サポート対象 | サポートなし | サポートなし | サポートなし |
日本 | FE | Pickup またはall | 未スケジュールの注文のみ | サポート対象 | サポートなし | サポート対象 | サポート対象 | サポートなし | サポートなし | サポートなし |
オランダ | EU | Dropoff またはall | サポートなし | サポートなし | サポートなし | サポートなし | サポートなし | サポートなし | サポートなし | サポート対象 |
ポーランド | EU | Pickup またはall | サポートなし | サポートなし | サポートなし | サポートなし | サポートなし | サポートなし | サポートなし | サポート対象 |
Updated 3 months ago