注文API v0ユースケースガイド

注文在庫の同期、ワークフロー、レポートツールを改善します。

APIバージョン:v0

注文APIとは何ですか?

を使う オーダー API 注文情報をプログラムで取得して送信する。このAPIは、販売パートナーが注文同期、注文調査、需要ベースの意思決定支援ツールを容易にする迅速で柔軟なカスタムアプリケーションを開発できるように設計されています。

📘

2 年以上経過した注文は、2016 年以降の注文をサポートする SG、JP、AU マーケットプレイスを除き、API レスポンスには表示されません。

認証と承認の詳細については、を参照してください。 販売パートナー API アプリケーションの承認。規制対象注文については、を参照してください。 規制対象注文 ガイド。

主な機能

  • フィルター条件を指定して注文情報を取得: ザ・ getOrders Orders API の操作により、指定された期間内に作成または更新された注文や、指定されたパラメーターで指定されたその他のフィルタリング基準が返されます。もし NextToken 存在する場合は、他の条件の代わりに注文の取得に使用されます。
  • 指定された注文情報を取得する:注文APIのgetOrderオペレーションにより、指定した注文情報が返されます。
  • 指定された注文の注文商品情報を取得する:注文APIのgetOrderItemsオペレーションにより、指定した注文の詳細な注文商品情報が返されます。NextTokenを指定した場合、注文商品の次のページを取得するために使用されます。
  • 指定された注文の出荷を確認する:注文APIのconfirmShipmentにより、指定された注文の出荷状況が確認されます。また、出荷された注文の出荷詳細を編集するのにも使用できます。

チュートリアル1:フィルター条件で注文情報を取得する

注文APIのgetOrdersオペレーションにより、指定されたパラメーターで示された期間またはその他のフィルター条件の間に作成または更新された注文が返されます。NextTokenが存在する場合、他の条件の代わりに注文を取得するために使用されます。

🚧

警告

getOrdersオペレーションにより、データ取得に体系的な遅延が発生します。更新された注文データのほとんどは、注文が作成または最終更新されてから2分後に利用できるようになります。最新の注文データを確実に取得するには、注文が作成または更新されてから2分後にオペレーションを呼び出してください。

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

購入者および配送先住所の情報にアクセスするには、以下を行う必要があります。

getOrdersリクエスト

getOrdersオペレーションを呼び出します。

クエリーパラメーター

名前説明必須
CreatedAfter指定した時刻より後に(またはその時刻に)作成された注文を選択するために使用される日付。指定した時刻より後に行われた注文のみが返されます。CreatedAfterパラメーターとLastUpdatedAfterパラメーターのいずれかを指定する必要があります。両方とも空の場合、呼び出しは無効です。いいえ
CreatedBefore指定した時刻より前 (またはそれ以降) に作成された注文を選択するために使用される日付。指定した時間より前に行われた注文のみが返されます。日付は必ず入力してください ISO 8601 フォーマット。いいえ
LastUpdatedAfter指定した時刻以降 (またはそれ以降) に最終更新された注文を選択するために使用される日付。更新とは、新しい注文の作成を含む、注文ステータスのあらゆる変更と定義されます。Amazon と出品者による更新が含まれます。日付は必ず入力してください ISO 8601 フォーマット。次のいずれかを指定する必要があります。 CreatedAfter パラメーターまたは LastUpdatedAfter パラメーター。両方が空の場合、呼び出しは無効です。いいえ
LastUpdatedBefore指定した時刻より前 (またはそれ以降) に最終更新された注文を選択するために使用される日付。更新とは、新しい注文の作成を含む、注文ステータスのあらゆる変更と定義されます。Amazon と出品者による更新が含まれます。日付は必ず入力してください ISO 8601 フォーマット。いいえ
OrderStatuses結果をフィルタリングするために使用されるOrderStatus値のリスト。

指定可能な値:
- PendingAvailability(このステータスは予約注文でのみ利用可能。注文は完了したが、支払いは承認されておらず、商品の発売日は未来の日付である)。
- Pending(注文は完了したが、支払いが承認されていない)。
- Unshipped(支払いが承認され、注文の出荷準備が整ったが、注文に含まれる商品はまだ出荷されていない)。
- PartiallyShipped(注文に含まれる1つ以上の商品が出荷されたが、すべてではない)。
- Shipped(注文のすべての商品が出荷された)。
- InvoiceUnconfirmed(注文のすべての商品が発送された。出品者はAmazonに対して、請求書が購入者に発送されたことをまだ確認していない)。
- Canceled(注文はキャンセルされた)。
- Unfulfillable(注文が出荷できない。このステータスはFBAマルチチャネルサービスの注文商品にのみ適用される)。
いいえ
MarketplaceIdsのリスト MarketplaceId 値。指定されたマーケットプレイスに出された注文を選択するために使用します。.br>
を参照してください マーケットプレイス ID の完全なリストについては marketplaceId 値。
最大数 : 50
はい
FulfillmentChannels注文がどのように処理されたかを示すリスト。結果を配送経路/発送元でフィルタリングします。指定可能な値:AFN(フルフィルメントby Amazon)、MFN(出品者出荷)。いいえ
PaymentMethods支払い方法の値のリスト。指定された支払い方法を使用して支払われた注文を選択するために使用されます。指定可能な値:COD(代金引換)、CVS(コンビニ決済)、Other(代金引換またはコンビニ決済以外の支払い方法)。いいえ
BuyerEmail購入者のメールアドレス。指定したメールアドレスを含む注文を選択するために使用されます。いいえ
SellerOrderId出品者が指定した注文識別子。注文識別子と一致する注文のみを選択するために使用されます。SellerOrderIdが指定されると、FulfillmentChannelsOrderStatusesPaymentMethodLastUpdatedAfterLastUpdatedBefore、およびBuyerEmailは指定できません。いいえ
MaxResultsPerPage1ページに返すことができる注文の最大数を示す数値。値は1~100でなければなりません。デフォルトは100です。いいえ
EasyShipShipmentStatusesEasyShipShipmentStatus値のリスト。ステータスが指定された値と一致するEasy Shipの注文を選択する場合に使用します。EasyShipShipmentStatusが指定されている場合、Amazon Easy Ship注文のみが返されます。

指定可能な値:
-PendingSchedule(パッケージは集荷待ちです。)
- PendingPickUp(Amazonはまだ出品者からパッケージを集荷していません。)
- PendingDropOff(出品者はパッケージを配送業者に渡します。)
- LabelCanceled(出品者が集荷をキャンセルしました。)
- PickedUp(Amazonが出品者からパッケージを集荷しました。)
- DroppedOff(パッケージは出品者によって配送業者に渡されました。)
- AtOriginFC(パッケージは配送元のフルフィルメントセンターにあります。)
- AtDestinationFC(パッケージは配送先のフルフィルメントセンターにあります。)
- Delivered(パッケージは配達されました。)
- RejectedByBuyer(パッケージは購入者によって拒否されました。)
- Undeliverable(パッケージは配達できません。)
- ReturningToSeller(パッケージは配達されず、出品者に返送中です。)
- ReturnedToSeller(パッケージは配達されず、出品者に返送されました。)
- Lost(パッケージは紛失しました。)
- OutForDelivery(パッケージは配達中です。)
- Damaged(荷物は配送業者によって破損しました。)
いいえ
ElectronicInvoiceStatusesElectronicInvoiceStatus値のリスト。電子請求書のステータスが指定された値と一致する注文を選択するために使用されます。

指定可能な値:
- NotRequired(この注文には電子請求書の送信は不要です。)
- NotFound(この注文の電子請求書は送信されていません。)
- Processing(この注文の電子請求書は処理中です。)
- Errored(この注文の最後に送信された電子請求書は拒否されました。)
- Accepted(最後に送信された電子請求書は送信および承認されました。)
いいえ
NextToken前のリクエストのレスポンスで返された文字列トークン。いいえ
AmazonOrderIdsAmazonOrderId値のリスト。AmazonOrderIdはAmazonが定義した注文識別子で、3-7-7形式です。
最大数:50
いいえ
ActualFulfillmentSupplySourceId推奨を示します sourceId どこから注文を出すべきか。いいえ
IsISPUtrueに設定すると、この注文は配達ではなく店舗での受け取りとしてマークされます。いいえ
StoreChainStoreIdストアチェーンのストア識別子。ストアチェーン内の特定のストアにリンクされています。いいえ

リクエストの例

GET https://sellingpartnerapi-eu.amazon.com/orders/v0/orders? MarketplaceIds=ATVPDKIKX0DER &CreatedAfter=2020-10-10 &MaxResultPerPage=2

レスポンス

成功レスポンスには、以下が含まれます。

名前説明必須
Orders注文のリスト。
タイプ: Order アレイ
はい
NextToken存在していて空でない場合は、次のリクエストでこの文字列トークンを渡して、次のレスポンスページを返します。いいえ
LastUpdatedBefore指定した時刻より前 (またはそれ以降) に最終更新された注文を選択するために使用される日付。更新とは、新しい注文の作成を含む、注文ステータスのあらゆる変更と定義されます。Amazon と出品者による更新が含まれます。すべての日付が入力されている必要があります ISO 8601 フォーマット。いいえ
CreatedBefore指定した時刻より前 (またはそれ以降) に作成された注文を選択するために使用される日付。指定した時間より前に行われた注文のみが返されます。日付は必ず入力してください ISO 8601 フォーマット。いいえ

レスポンスの例

以下は、からの一般的な応答の例です getOrders オペレーション。

{ "payload": { "NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4", "Orders": [ { "AmazonOrderId": "902-3159896-1390916", "PurchaseDate": "2017-01-20T19:49:35Z", "LastUpdateDate": "2017-01-20T19:49:35Z", "OrderStatus": "Pending", "FulfillmentChannel": "SellerFulfilled", "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "CreditCard", "GiftCertificate" ], "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "2017-01-20T19:51:16Z", "LatestShipDate": "2017-01-25T19:49:35Z", "IsBusinessOrder": false, "IsPrime": false, "IsAccessPointOrder": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false, "ShippingAddress": { "Name": "Michigan address", "AddressLine1": "1 Cross St.", "City": "Canton", "StateOrRegion": "MI", "PostalCode": "48817", "CountryCode": "US" }, "BuyerInfo": { "BuyerEmail": "user@example.com", "BuyerName": "John Doe", "BuyerTaxInfo": { "CompanyLegalName": "A Company Name" }, "PurchaseOrderNumber": "1234567890123" } } ] } }

注文品がブラジルの住所に配送されると、次の例に示すように、追加の住所フィールド (たとえば、番地、番地、補数、近所など) が表示される場合があります。

{ "ShippingAddress": { "Name": "Brazil address", "AddressLine1": "Street 9 450", "AddressLine2": "Suite 30 Central", "ExtendedFields": { "StreetName": "Street 9", "StreetNumber": "450", "Complement": "Suite 30", "Neighborhood": "Central" }, "City": "Rio de Janeiro", "StateOrRegion": "RJ", "PostalCode": "48817", "CountryCode": "BR" } }

配送先住所に拡張フィールドが含まれる場合の詳細については、以下を参照してください。 Order のスキーマ オーダー API v0 リファレンス

使用可能な拡張フィールドのリストについては、を参照してください。 AddressExtendedFieldsオーダー API v0 リファレンス

チュートリアル2:注文情報を取得する

このチュートリアルでは、の使用方法を説明します getOrder Orders API の操作で、指定した注文情報を取得します。

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

購入者および配送先住所の情報にアクセスするには、以下を行う必要があります。

リクエスト

パラメーター 説明 必須
orderId Amazonが定義した注文識別子。3-7-7形式。

タイプ:文字列

はい

リクエストの例

GET https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/

レスポンス

成功レスポンスには、以下が含まれます。

名前説明必須
Order注文情報。
タイプ:Order
はい

注文で使用可能なオブジェクトとプロパティの詳細については、APIリファレンスでOrderをご覧ください。

レスポンスの例

{ "payload": { "BuyerInfo": {}, "AmazonOrderId": "026-1520163-6049104", "EarliestShipDate": "2022-03-10T00:00:00Z", "SalesChannel": "Amazon.co.uk", "AutomatedShippingSettings": { "HasAutomatedShippingSettings": false }, "OrderStatus": "Canceled", "NumberOfItemsShipped": 0, "OrderType": "StandardOrder", "IsPremiumOrder": false, "IsPrime": false, "FulfillmentChannel": "MFN", "NumberOfItemsUnshipped": 0, "HasRegulatedItems": true, "IsReplacementOrder": false, "IsSoldByAB": false, "LatestShipDate": "2022-03-10T23:59:59Z", "ShipServiceLevel": "Std UK Dom_1", "IsISPU": false, "MarketplaceId": "A1F83G8C2ARO7P", "PurchaseDate": "2022-03-09T22:03:02Z", "IsAccessPointOrder": false, "IsBusinessOrder": false, "OrderTotal": { "CurrencyCode": "GBP", "Amount": "20.00" }, "PaymentMethodDetails": [ "Standard" ], "IsGlobalExpressEnabled": false, "LastUpdateDate": "2022-03-14T22:05:14Z", "ShipmentServiceLevelCategory": "Standard" } }

チュートリアル3:注文商品の詳細情報を取得する

このチュートリアルでは、の使用方法を説明します getOrderItems Orders API の操作で、指定した注文情報を取得します。

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

購入者および配送先住所の情報にアクセスするには、以下を行う必要があります。

リクエスト

Type パラメーター 説明 必須
Path orderId Amazonが定義した注文識別子。3-7-7形式。

タイプ:文字列

はい
Query NextToken 前のリクエストのレスポンスで返された文字列トークン。

タイプ:文字列

いいえ

リクエストの例

GET https://sellingpartnerapi-na.amazon.com/orders/v0/orders/902-9855239-8990202/orderItems

レスポンス

成功レスポンスには、以下が含まれます。

名前説明必須
OrderItems注文商品のリスト。
タイプ: OrderItem アレイ
はい
NextToken存在していて空でない場合は、次のリクエストでこの文字列トークンを渡して、次のレスポンスページを返します。いいえ
AmazonOrderIdAmazonが定義した注文識別子。3-7-7形式。はい

レスポンスの例

{ "payload": { "OrderItems": [ { "TaxCollection": { "Model": "MarketplaceFacilitator", "ResponsibleParty": "Amazon Services, Inc." }, "ProductInfo": { "NumberOfItems": "1" }, "BuyerInfo": {}, "ItemTax": { "CurrencyCode": "USD", "Amount": "1.13" }, "QuantityShipped": 1, "BuyerRequestedCancel": { "IsBuyerRequestedCancel": "false", "BuyerCancelReason": "" }, "ItemPrice": { "CurrencyCode": "USD", "Amount": "11.00" }, "ASIN": "B004RKQM8I", "SellerSKU": "AN-M9GI-4QE5", "Title": "Sony MDR-ZX100 ZX Series Headphones (White)", "IsGift": "false", "ConditionSubtypeId": "Acceptable", "IsTransparency": false, "QuantityOrdered": 1, "PromotionDiscountTax": { "CurrencyCode": "USD", "Amount": "0.00" }, "ConditionId": "Used", "PromotionDiscount": { "CurrencyCode": "USD", "Amount": "0.00" }, "OrderItemId": "43345934312798" } ], "AmazonOrderId": "902-0300094-5705429" } }

チュートリアル4:出荷を確認する

このチュートリアルでは、注文の出荷準備完了通知を受け取った後、confirmShipmentオペレーションで出荷を確認する方法を説明します。出荷APIまたは購入-出荷UIを使用して配送ラベルを購入した場合は、出荷を確認する必要はありません。confirmShipmentオペレーションは、注文ごとの複数のお問い合わせ伝票番号など、注文フルフィルメントフィードでサポートされていたすべてのユースケースをサポートしています。複数のパッケージお問い合わせ伝票番号を送信するには、注文IDが同じでパッケージ参照IDが異なる複数のリクエストを送信する必要があります。

例:

Call OrderID PackageReferenceId
1回目の呼び出し 902-0300094-570542 101
2回目の呼び出し 902-0300094-570542 102

パッケージ参照IDは任意の正の数値をサポートし、出荷を確認した後に出荷を編集するためのものです。packageReferenceIDなどの任意の数値を送信すると、データが保存されます。出荷を編集する必要がある場合は、別のconfirmShipmentオペレーションを同じpackageReferenceIDで送信してください。その他の出荷の詳細は、送信が完了すると編集されます。送信時にIDを入力しなかった場合、AmazonによってpackageReferenceIDが自動的に割り当てられます。

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

購入者への直送(制限あり)ロールが承認された場合は、confirmShipmentオペレーションにアクセスできます。

ステップ1. 1件の注文の出荷を確認する

confirmShipmentオペレーションを呼び出して、以下のパラメーターを渡します。

パスのパラメーター

パラメーター 説明 必須
orderId Amazonが定義した注文識別子。3-7-7形式。

タイプ:文字列

はい

ボディのパラメーター

名前説明必須
packageDetailパッケージのプロパティ
タイプPackageDetail
はい
codCollectionMethod代金引換回収方法。日本でのみサポート。
タイプCodCollectionMethod
いいえ
marketplaceId難読化されていないマーケットプレイス識別子。
タイプMarketplaceId
はい

リクエストの例

POST https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/shipmentConfirmation { "marketplaceId": "ATVPDKIKX0DER", "codCollectionMethod": "", "packageDetail": { "packageReferenceId": "123", "carrierCode": "UPS", "carrierName": "UPS", "shippingMethod": "SHIPPING", "trackingNumber": "1Z86V8030385598957", "shipDate": "2022-11-30T16:15:30Z", "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430", "orderItems": [ { "orderItemId": "60696125413094", "quantity": 1 } ] } }

レスポンス

レスポンスのプロパティ:

HTTP Code説明Schema
204成功。
ヘッダー
x-amzn-RateLimit-Limit(文字列):このオペレーションのレート制限(1秒あたりのリクエスト)。
x-amzn-RequestId(文字列):一意のリクエスト参照識別子。
コンテンツなし

エラーステータスコード、説明、およびスキーマについては、出荷のエラーレスポンスを確認するをご覧ください。

🌟

ヒント

複数の注文を確認するには、 フィード API 2021年6月30日 そして合格して POST_ORDER_FULFILLMENT_DATA フィードタイプ。詳細については、「」を参照してください。 注文処理フィードで複数の注文を確認する

ステップ2. 1件の注文の配送情報を編集する

ステップ1の後に、注文用のパッケージが作成されます。もう一度confirmShipmentオペレーションを呼び出すことで、出荷日、配送業者、配送サービス(または配送方法)、お問い合わせ伝票番号(配送業者が提供)などの配送情報を編集できます。

一貫性が必要なパラメーター

確実に同じ納品を編集するには、次のパラメータを変更しないでください。

パラメーター 説明 場所
orderId Amazonが定義した注文識別子。3-7-7形式。

タイプ:文字列

Path
packageReferenceId 注文の範囲内でパッケージを一意に識別する、出品者が提供する識別子。使用できるのは正の数値のみであることに注意してください。

タイプ:文字列

PackageDetail
orderItemId 注文商品の一意の識別子。

タイプ:文字列

ConfirmShipmentOrderItem
quantity 商品の数量。

タイプ:整数

ConfirmShipmentOrderItem

リクエストの例

POST https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/shipmentConfirmation { "marketplaceId": "ATVPDKIKX0DER", "codCollectionMethod": "", "packageDetail": { "packageReferenceId": "123", "carrierCode": "USPS", "carrierName": "USPS", "shippingMethod": "SHIPPING", "trackingNumber": "1Z86V8030385598957", "shipDate": "2022-11-30T20:15:30Z", "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430", "orderItems": [ { "orderItemId": "60696125413094", "quantity": 1 } ] } }

レスポンス

レスポンスのプロパティ:

HTTP Code説明Schema
204成功。
ヘッダー
x-amzn-RateLimit-Limit(文字列):このオペレーションのレート制限(1秒あたりのリクエスト)。
x-amzn-RequestId(文字列):一意のリクエスト参照識別子。
コンテンツなし

エラーステータスコード、説明、およびスキーマについては、エラーレスポンスとスキーマをご覧ください。


このページは役に立ちましたか?