ベンダー出品者出荷配送API v2021-12-28ユースケースガイド
ベンダーダイレクトフルフィルメント (DF) 配送APIの使用方法をご覧ください。
を使う ダイレクトフルフィルメント配送 API 出荷関連書類をAmazonと交換するため。
チュートリアル
このセクションのチュートリアルでは、次の方法について説明します。
- 配送ラベルリクエストを送信
- 1つまたは複数の配送ラベルを取得
- 作成 配送ラベル そして コンテナラベル
- 送信 出荷確認 そして 配送状況の更新
- 1 つまたは複数の納品書を取得
- 1 通または複数の顧客請求書を取得 (インドのみ)
配送ラベルリクエストを送信
submitShippingLabelRequest
オペレーションでは、発注書ごとの配送ラベル情報をAmazonにリクエストできます。スキーマに従うことで、複数の配送ラベルリクエストを1回のAPI呼び出しで一括送信できます。配送ラベルがAmazonで作成されると、getShippingLabel
オペレーションを使用してダウンロードできます。
注
ザ・
submitShippingLabelRequest
この操作は Amazon 配送業者を利用するベンダーのみが利用できます。
配送ラベルの送信リクエストを確認する
配送ラベルリクエストのステータスは、以下を使用して確認できます。 ベンダー DF トランザクション API。送信後、システムにステータスが表示されるまで最大 15 分かかります。30 分経ってもトランザクションステータスが更新されない場合は、を開いてください お問い合わせ ベンダーセントラルのケース。
次の図は、配送ラベルリクエストを送信するためのワークフローを示しています。
ビジネスの要件
-
出荷ラベルリクエストを送信する前に、API、EDI、またはベンダーセントラルを使用して発注書を正常に確認する必要があります。未確認またはキャンセルされた注文の配送ラベルリクエストは拒否されます。
-
Amazon独自の配送ラベルを使用する場合、リクエストで商品情報やパッケージ情報を送信することは任意です。
submitShippingLabelRequest
が必須
submitShippingLabelRequest
が必須配送ラベルをリクエストするには、submitShippingLabelRequest
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
shippingLabelRequests | 1つまたは複数の配送ラベルをリクエストしてください。 タイプ: < ShippingLabelRequest > アレイ | はい |
リクエストの例
POST "https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/shippingLabels"
{
"shippingLabelRequests": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "XXXX",
"dimensions": {
"length": "12",
"width": "12",
"height": "12",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "B07DFVDRAB",
"packedQuantity": {
"amount": 1,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
submitShippingLabelRequest
が必須
submitShippingLabelRequest
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
transactionId | このトランザクションを識別するための GUID。この値は、次のものと一緒に使用できます。 ベンダー DF トランザクション API このトランザクションのステータスを返します。<バー。>タイプ:文字列 | いいえ |
レスポンスの例
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
配送ラベルの取得
nextToken">getShippingLabels
オペレーションは、リクエストで指定されたフィルター条件を満たす、すべての注文の配送ラベルを返します。このAPIを使用してフルフィルメント用の配送ラベルを取得するには、submitShippingLabelRequest
オペレーションを使用して配送ラベルをリクエスト済みである必要があります。 Amazonでは、営業時間中に少なくとも1時間に1回、配送ラベルを確認することをお勧めします。ビジネスの規模に応じて、確認の頻度を増やすとよいでしょう。1回のAPI呼び出しで最大100の配送ラベルを取得できます。配送ラベル数が100を超える場合は、nextTokenの値を使用して次の配送ラベルセットを取得できます。
配送ラベルは、作成日から 90 日後に有効期限が切れます ( submitShippingLabelRequest
日付)。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
次の図は、出荷ラベルを取得する場合の統合ワークフローを示しています。
getShippingLabels
が必須
getShippingLabels
が必須配送ラベルのリストを取得するには、getShippingLabels
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
shipFromPartyId | ベンダー warehouseId 注文処理用。指定しない場合、応答にはすべての倉庫の注文が含まれます。タイプ:文字列 | いいえ |
limit | 返されるレコード数の上限。 タイプ:整数 | いいえ |
createdAfter | この日時以降に入手可能になった配送ラベルは、回答に含まれます。必ず入っている必要があります。 ISO 8601 日付/時刻形式。 タイプ:文字列 (日付/時間) | はい |
createdBefore | この日付と時刻より前に利用可能になった配送ラベルが結果に含まれます。入っている必要があります ISO 8601 日付/時刻形式。 タイプ:文字列 (日付/時間) | はい |
sortOrder | 昇順にソート (ASC ) または降順 (DESC ) 注文作成日別。タイプ:列挙型 ( SortOrder ) | いいえ |
nextToken | 指定された結果サイズの制限を超える出荷ラベルがある場合のページネーションに使用されます。トークンの値は前回の API 呼び出しで返されます。 タイプ:文字列 | いいえ |
リクエストの例
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/shippingLabels?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
getShippingLabels
が必須
getShippingLabels
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
pagination | 100を超える配送ラベルが返される場合、ページ割り用のnextToken がレスポンスで返されます。 | いいえ |
shippingLabels | 船舶ラベルのリスト。 タイプ: < ShippingLabel > アレイ | いいえ |
レスポンスの例
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"shippingLabels": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
}, {
"purchaseOrderNumber": "2JK3S9VD",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG002",
"trackingNumber": "1Z6A34Y60369738805",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
}
]
}
配送ラベルの取得
getShippingLabel
オペレーションは、発注番号を使用して指定した配送ラベルに関する情報を返します。このレスポンスには、ラベルタイプ、発注詳細、配送方法など、その発注書の完全な配送ラベル情報が含まれます。
配送ラベルは、作成日から 90 日後に有効期限が切れます ( submitShippingLabelRequest
日付)。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
また、このAPIを使用して、配送ラベルの詳細を取得することもできます(過去6か月間のうち7日間、ベンダーがAPIの使用を開始後)。
次の図は、特定の配送ラベルを取得するための統合ワークフローを示しています。
ビジネスの要件
- どんな種類のラベルをダウンロードできますか?
サポートされているラベル形式は ZPL と PNG です。ラベルコンテンツは Base 64 文字列形式で提供されるので、文字列を目的のラベル形式に変換できます。ラベル形式の選択はベンダー次第であり、ベンダーはダイレクト・フルフィルメント・プログラムへの導入プロセスの一環としてこれを決定します。
- 配送ラベルはいつまでにリクエストすればいいですか?
配送ラベルは、注文品が発送された日にのみリクエストしてください。
getShippingLabel
が必須
getShippingLabel
が必須配送ラベルをリクエストするには、getShippingLabel
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | 発注番号。この配送ラベルが返されます。注文時に受け取ったものと同じpurchaseOrderNumber でなければなりません。 | はい |
リクエストの例
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/2JK3S9VC
getShippingLabel
が必須
getShippingLabel
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | この注文の発注番号。 タイプ:文字列 | はい |
sellingParty | 販売者またはベンダーの識別子。 タイプ: PartyIdentification | はい |
shipFromParty | ベンダーの倉庫コード。 タイプ: PartyIdentification | はい |
labelFormat | ラベルのフォーマット。 列挙 () LabelFormat ) | はい |
labelData | この納品に含まれるパッケージの詳細を提供します。 タイプ: < LabelData > アレイ | はい |
レスポンスの例
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here"
}
]
}
配送ラベルを作成
ザ・ createShippingLabels
オペレーションは発注書の配送ラベルを作成します。 そして ラベルを返します。これは同期操作なので、を呼び出す必要はありません。 ベンダー DF トランザクション API。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
次の図は、を使用して出荷ラベルを作成するワークフローを示しています。 createShippingLabels
オペレーション。
ビジネスの要件
1 回のリクエストにつき、1 回の注文分の配送ラベルを返品できます。1 回のリクエストで複数の発注書を作成することはできません。
createShippingLabels
が必須
createShippingLabels
が必須配送ラベルを同期して作成するには、 createShippingLabels
操作して次のパスパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | 必要な配送ラベルの注文番号。 タイプ:文字列 | はい |
以下のボディパラメータを含めることができます。
名前 | 説明 | 必須 |
---|---|---|
sellingParty | 販売者またはベンダーのID。 タイプ: PartyIdentification | はい |
shipFromParty | ベンダーの倉庫コード。 タイプ: PartyIdentification | はい |
containers | この納品に含まれるパッケージのリスト。 タイプ: < Container > アレイ | いいえ |
リクエストの例
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/
shipping/2021-12-28/shippingLabels/XhvBghry
{
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
}
}
createShippingLabels
が必須
createShippingLabels
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | この注文の発注番号。 タイプ:文字列 | はい |
sellingParty | 販売者またはベンダーの識別子。 タイプ: PartyIdentification | はい |
shipFromParty | ベンダーの倉庫コード。 タイプ: PartyIdentification | はい |
labelFormat | ラベルのフォーマット。 列挙 () LabelFormat ) | はい |
labelData | この納品に含まれるパッケージの詳細を提供します。 タイプ: < LabelData > アレイ | はい |
レスポンスの例
{
"purchaseOrderNumber": "XhvBghry",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "1",
"trackingNumber": "1Z69664F0310685739",
"shipMethod": "UPS_GR_RES_SIG",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here"
}
]
}
応答例 (エラー)
{
"errors": [
{
"code": "InvalidInput",
"message": "[MISMATCHED_ITEM]: Request Rejected: Order quantity does not match the shipped quantity. All items in the order must be provided. Ensure you add the correct quantity of shipped items to packages. For items - ${fnSku}, the expected quantity is ${expectedQuantity}, but the provided quantity is ${providedQuantity}.",
"details": ""
}
]
}
考えられるエラー応答の詳細のリスト
次の表には、考えられるすべてのエラー応答の詳細のリストが含まれています。リクエストを再試行する前にエラー状態を解決するために取るべき推奨手順がすべて記載されています。このような潜在的なエラーを予測して処理できるよう、アプリケーションの障害処理メカニズムを設計する必要があります。
時間の経過とともにエラーレスポンスが追加される可能性があるため、このリストに含まれていないエラーを正常に処理できるようにアプリケーションも準備しておく必要があります。
カッコで囲まれた値の前に a が付きます \$
メッセージ列に表示されるもの (たとえば、 \${fnSku}
) はエラー応答の実際の値に置き換えられます。
コード | メッセージ | Details |
---|---|---|
InvalidInput | [MISMATCHED_ITEM]: リクエストが拒否されました:注文数量が出荷数量と一致しません。注文に含まれるすべての商品を提供する必要があります。必ず正しい数量の出荷商品をパッケージに追加してください。商品の場合-${fnSku}、予想数量は ${expectedQuantity}ただし、提供された数量は ${providedQuantity}。 | なし |
InvalidInput | [アイテムなし]: リクエストは拒否されました:注文 ID ${shipmentId} どのパッケージにも割り当てられていないアイテムがあります。すべてのアイテムがパッケージにマップされていることを確認してください。 | なし |
InvalidInput | [パッケージの寸法が無効です]: リクエストは拒否されました:注文 ID ${shipmentId} パッケージの寸法が無効です。パッケージに有効な寸法を追加してください。 | なし |
InvalidInput | [パッケージの重量が無効です]: リクエストは拒否されました:注文 ID ${shipmentId} 荷物の重量が無効です。荷物の有効な重量を追加してください。 | なし |
InvalidInput | [PIECE_NUMBER_ONE_NOT_PROVISED]: 少なくとも1つのアイテムにコンテナシーケンス番号「1」が指定されていません。コンテナのシーケンス番号が欠落していないか確認してください。 | なし |
InvalidInput | [INCONSISTENT_PIECE_NUMBER_QUANTITY]: 少なくとも1つの商品のコンテナシーケンス番号が、商品の数量と一致していないか、一致していません。コンテナの連番が正しく、各品目の数量が品目の連番と同じであることを確認してください。 | なし |
InvalidInput | [無効なベンダーコード]: ベンダーコード $ が無効です{vendorCode}。ベンダーコードが注文の正しいことを確認する | なし |
InvalidInput | [注文ID_倉庫_組合せが無効です]: 配送ラベルが拒否されました:注文番号 ${shipmentId} 倉庫 $ には属していません{warehouseCode}。倉庫コードと注文 ID が正しいことを確認してください。 | なし |
InvalidInput | [不正なベンダー_グループ_ID]: ベンダーグループ ID $ が無効です{vendorGroupId}。ベンダーグループ ID が注文の正しいことを確認します。 | なし |
InvalidInput | [重複ベンダーパッケージ ID]: ベンダーパッケージ ID が重複しています。重複しているコンテナ識別子を修正して、もう一度試してください。 | なし |
InvalidInput | [空のベンダーパッケージ ID]: ベンダーパッケージ ID が無効です。無効なコンテナ識別子を修正して、もう一度試してください | なし |
InvalidInput | [配送方法はサポートされていません]: ${ship_method} はサポートされていません。既存の設定を使用して $ のラベルを生成してください{ship_method} | なし |
InvalidInput | [配送方法変更]: このPOの配送方法が$から変更されました{old_ship_method} $ へ{ship_method}。既存の設定を使用して $ のラベルを生成してください{ship_method} | なし |
InvalidInput | [INCONSISTENT_SHIP_METHODS]: リクエストが拒否されました:パッケージごとに異なる配送方法が割り当てられています。すべての商品を1つの箱にまとめて発送するようにしてください。それが不可能な場合は、当社までご連絡ください。 | なし |
ConflictError | [SHIPMENT_NOT_MUTABLE]: リクエストは拒否されました:注文番号 $ のパッケージ寸法{shipmentId} 現在のステータスでは更新できません。これ以上の操作は不要です。 | なし |
ConflictError | [ORDER_SHIPPED_WITH_VENDOR_LABEL]: あなたはすでにAmazonトランスポーテーション以外の配送業者に注文を出荷しているため、この注文のラベルを印刷することはできません。アクションは不要です。発送済みの注文はすでに確認済みです。 | なし |
InternalFailure | 内部エラーが発生しました。もう一度試してください。 | なし |
出荷通知の送信
submitShipmentConfirmations
オペレーションで、Amazonに出荷確認書を送信できます。出荷確認書によって、配送を効率的に追跡し、購入者に知らせることができます。内容は、発注番号、出荷日、お届け予定日、お問い合わせ番号など、出荷される商品に関する情報です。
出荷確認書により、配送業者と効果的に協力して配送荷物を追跡できます。
有効な出荷確認書がないと、次のような結果につながる可能性があります。
-
納品される内容がよくわからない。
-
実際の出荷と発注書との照合エラー。
-
不一致を解決するための手動調査。
正常に提出された出荷確認書の検証
ベンダーは、次の方法で出荷確認のステータスを確認できます。 ベンダーセントラル > 注文 > ダイレクト・フルフィルメント・オーダー または ベンダー DF トランザクション API。送信後、システムがステータスを判断するまで最大 10 分かかります。ベンダーセントラルが出荷確認の正しい値を表示していない場合は、を開いてください お問い合わせ ベンダーセントラルのケース。出荷確認の作成については、「ビジネス要件」セクションを参照してください。
次の図は、出荷確認書を送信するための統合ワークフローを示しています。
ビジネスの要件
-
このAPIを使用して、注文が倉庫から出荷されてから4時間以内に注文の出荷を確認します。
-
フロアが拒否された配送については、
shipmentStatus
フィールドの値をFLOOR_DENIAL
に設定します。 -
発注書のすべての品目が出荷確認書に記載されている必要があります。部分的な注文フルフィルメントは認められません。いずれかの品目が出荷できない場合、ベンダーは注文をフロア拒否として拒否する必要があります。
-
商品の
itemSequenceNumber
は、注文メッセージで受け取ったものと同じでなければなりません。 -
buyerProductIdentifier
またはvendorProductIdentifier
のどちらかを出荷確認書で送付することが必須です。発注書で受け取った値と同じものを送信する必要があります。 -
VOC の場合、送信
scacCode
は必須です。 -
Amazonから配送ラベルが提供されている場合、Amazonはパッケージ情報にアクセスできるため、「container」セクションは任意です。「items」セクションの送信は必須です。
-
出荷確認書のコンテナには、ShipMethodが指定されている必要があります。
submitShipmentConfirmations
が必須
submitShipmentConfirmations
が必須出荷確認書を送信するには、submitShipmentConfirmations
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
shipmentConfirmations | 確認済みの出荷のリスト。 タイプ: < ShipmentConfirmation > アレイ | はい |
リクエストの例
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/shipmentConfirmations
{
"shipmentConfirmations": [
{
"purchaseOrderNumber": "PO00050003",
"shipmentDetails": {
"shippedDate": "2019-08-07T19:56:45.632Z",
"shipmentStatus": "SHIPPED",
"isPriorityShipment": true,
"estimatedDeliveryDate": "2019-08-07T19:56:45.632Z"
},
"sellingParty": {
"partyId": "VENDORCODE"
},
"shipFromParty": {
"partyId": "VENDORWAREHOUSECODE"
},
"items": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
],
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "TRACK001",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "234",
"trackingNumber": "TRACK002",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "ABCD",
"trackingNumber": "TRACK003",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "id12",
"trackingNumber": "TRACK004",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
submitShipmentConfirmations
が必須
submitShipmentConfirmations
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
transactionId | このトランザクションを識別するための GUID。この値は、次のものと一緒に使用できます。 ベンダー DF トランザクション API このトランザクションのステータスを返します。 タイプ:文字列 | はい |
レスポンスの例
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
配送ステータス更新の送信
注意
納品状況更新を使用できるのは、ベンダー独自運送業者 (VOC) ベンダーのみです。つまり、顧客への貨物の配送には Amazon 配送業者ではなく、独自の運送業者を使用して配送を行うベンダーです。最終的にはVOCベンダーが輸送費と顧客への配送の責任を負担します。
submitShipmentStatusUpdates
オペレーションで、最終購入者に配送中の荷物の輸送ステータスイベントを更新できます。VOCベンダーは、輸送フェーズ中に配送ステータスを更新(一般的にはスキャン)する必要があります。
この情報はAmazonの購入者の「注文履歴」ページに転送されます。その結果、注文の追跡と配送プロセスの可視性が高まります。
配送ステータスの更新に失敗すると、スキャン率が低下したり、最終的には倉庫が一時停止するなど、運用KPIが悪くなる可能性があります。
配送ステータス更新が正常に送信されたことの確認
ベンダーは、出荷ステータスの更新状況を以下で確認できます。 ベンダーセントラル > 注文 > ダイレクト・フルフィルメント・オーダー または ベンダー DF トランザクション API。送信後、システムがステータスを判断するまで最大 10 分かかります。ベンダーセントラルが出荷確認の正しい値を表示していない場合は、を開いてください お問い合わせ ベンダーセントラルのケース。出荷確認の作成については、「ビジネス要件」セクションを参照してください。
次の図は、配送ステータス更新を送信するための統合ワークフローを示しています。
ビジネスの要件
-
このAPIは、自社の運送業者(VOCベンダー)を使用して顧客に貨物を輸送する場合にのみ使用してください。
-
この API を使用すると、出荷が確認された後に (API またはベンダーセントラルを通じて) 出荷のステータスを更新できます。
-
ザ・
trackingNumber
配送状況では、API は以下と一致する必要がありますtrackingNumber
出荷確認書に記載されています。一致しない場合、配送状況の更新は失敗します。 -
一つ
submitShipmentStatusUpdates
呼び出しは 1 つの物理パッケージに対応している必要があります。複数の荷物の出荷状況を、配送状況更新の配列として一括処理することで、1 回の API 呼び出しで更新できます。 -
出品者出荷注文では、注文を購入者に配送するために必要な物理パッケージが複数になる可能性があります。そのため、注文全体の配送ステータスを反映するには複数の配送ステータスを更新する必要があります。
-
ベンダーは、Amazonの配送ステータスガイドラインに従って、可能な限り配送ステータスを送信する必要があります。
-
お届け日時指定注文の場合は、お届け予定時間と配送時間帯を指定する
shipmentSchedule
配列を送信する必要があります。
その他のフィールド
statusCode
そして reasonCode
は EDI 標準 (ISA X12 や EDIFACT など) で使用される標準コードで、特定のステータスイベントとステータスイベントの理由を示すために使用されます。次のような特定の組み合わせが期待されます。 statusCode
そして reasonCode
これにより、最終顧客への出荷輸送段階におけるイベントが決まります。
以下に、サポートされているステータスコードと理由コードの組み合わせ、およびそれに対応する現在のVendor Centralのステータスコードを示します。
EDIFACT ステータスコード | EDIFACT 理由コード | オペレーションの説明 | Vendor Central UI equivalency |
---|---|---|---|
404 | 117 | 大規模な事故により出荷が遅れました | DELAYED |
301 | 000 | 商品は購入者に配達されました | DELIVERED |
101 | 000 | 商品はFCを出発しました | DEPARTED_FROM_FC |
201 | 000 | 商品は配送業者の施設に到着しました | IN_TRANSIT |
409 | 000 | 配送業者が商品を紛失しました | LOST |
302 | 000 | 商品は配送中です | OUT_FOR_DELIVERY |
407 | 000 | 受取人が商品の受け取りを拒否しました | REJECTED |
416 | 000 | 商品は配送不能で破棄されます | UNDELIVERABLE |
X12 ステータスコード | X12 理由コード | オペレーションの説明 | Vendor Central UI equivalency |
---|---|---|---|
DE | AF | 大規模な事故により出荷が遅れました | DELAYED |
D1 | NS | 商品は購入者に配達されました | DELIVERED |
XB | NS | 商品はFCを出発しました | DEPARTED_FROM_FC |
O1 | NS | 商品は配送業者の施設に到着しました | IN_TRANSIT |
CA | PL | 配送業者が商品を紛失しました | LOST |
OD | NS | 商品は配送中です | OUT_FOR_DELIVERY |
A7 | AM | 受取人が商品の受け取りを拒否しました | REJECTED |
AP | BG | 商品は配送不能で破棄されます | UNDELIVERABLE |
submitShipmentStatusUpdates
が必須
submitShipmentStatusUpdates
が必須配送ステータス更新を送信するには、submitShipmentStatusUpdates
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
shipmentStatusUpdates | 確認済みの出荷のリスト。 タイプ: < ShipmentStatusUpdate > アレイ | はい |
リクエストの例
POST https://sellingpartnerapi-na.amazon.com/ /vendor/directFulfillment/shipping/2021-12-28/shipmentStatusUpdates
{
"shipmentStatusUpdates": [
{
"purchaseOrderNumber": "DX00050015",
"sellingParty":
{
"partyId": "999US"
},
"shipFromParty":
{
"partyId": "ABCD"
},
"statusUpdateDetails":
{
"trackingNumber": "TRACK005",
"statusDateTime": "2020-08-07T19:56:45Z",
"statusCode": "D1",
"reasonCode": "NS",
"statusLocationAddress":
{
"name": "ABC",
"addressLine1": "1st street",
"city": "Seattle",
"countryCode": "US",
"postalCode": "124",
"stateOrRegion": "CA"
}
}
}
]
}
submitShipmentStatusUpdates
が必須
submitShipmentStatusUpdates
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
transactionId | このトランザクションを識別するための GUID。この値は、次のものと一緒に使用できます。 ベンダー DF トランザクション API このトランザクションのステータスを返します。 タイプ:文字列 | はい |
レスポンスの例
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
納品書を入手
getPackingSlips
オペレーションは、指定された基準を満たす注文の納品書のリストを返します。特定の注文について納品書を取得する必要がある場合は、代わりにgetPackingSlip
オペレーションを使用します。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
この API を使用して、発注書の納品書を発行してもらう必要があります。Amazonでは、ベンダーが営業時間中に少なくとも1時間に1回は注文を確認することを推奨しています。取引量によっては、チェックの頻度を増やすこともできます。1 回の API 呼び出しで最大 100 件の納品書を取得できます。納品書が 100 件を超える場合は、 nextToken
次のリクエストのパラメータとして値を指定すると、次の納品書セットが取得されます。
次の図は、納品書を取得する場合の統合ワークフローを示しています。
getPackingSlips
が必須
getPackingSlips
が必須納品書を取得するには、getPackingSlips
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
shipFromPartyId | ベンダー warehouseId ここから注文が処理されます。指定しない場合、結果にはすべての倉庫の注文が含まれます。タイプ:文字列 | いいえ |
limit | 返されるレコード数の上限。 タイプ:整数 | いいえ |
createdAfter | この日時以降に入手可能になった納品書が結果に含まれます。入っている必要があります ISO 8601 日付/時刻形式。 タイプ:文字列 (日付/時間) | はい |
createdBefore | この日付と時刻より前に利用可能になった納品書が結果に含まれます。入っている必要があります。 ISO 8601 日付/時刻形式。 タイプ:文字列 (日付/時間) | はい |
sortOrder | 昇順にソート (ASC ) または降順 (DESC ) 納品書作成日別。タイプ:列挙型 ( SortOrder ) | いいえ |
nextToken | 指定された結果サイズの制限を超える注文がある場合のページネーションに使用されます。トークンの値は前回の API 呼び出しで返されます。 タイプ:文字列 | いいえ |
リクエストの例
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/packingSlips?createdBefore=2020-06-12T12:00:00-08:00&createdAfter=2020-06-12T00:00:00-08:00&limit=2&sortOrder=DESC
getPackingSlips
が必須
getPackingSlips
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
pagination | 100件を超える注文が返される場合、ページ割り用のnextToken がレスポンスで返されます。 | いいえ |
packingSlips | 納品書の詳細が含まれています。 タイプ: < PackingSlip > アレイ | いいえ |
レスポンスの例
{
"pagination": {
"nextToken": "NEBxNEBxNEBxNR=="
},
"packingSlips": [
{
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
},
{
"purchaseOrderNumber": "VvgCDdBjR",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
]
}
納品書を取得
ザ・ getPackingSlip
オペレーションでは、指定した発注書番号の納品書が返されます。応答には、Base64 でエンコードされた梱包伝票の文字列が含まれます。コンテンツタイプは常に「アプリケーション/pdf」になります。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
次の図は、納品書を取得する場合の統合ワークフローを示しています。
ビジネスの要件
- 納品書はすべての注文に必要ですか?
納品書は、企業間 (B2B) 注文またはギフト注文の場合にのみ必要です。の金額が次の場合 isPslipRequired
フィールドが true の場合、注文には納品書が必要です。
getPackingSlip
が必須
getPackingSlip
が必須納品書を返すには、getPackingSlip
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | ザ・ purchaseOrderNumber ご希望の納品書用。タイプ:文字列 | はい |
リクエストの例
GET https://sellingpartnerapi-na.amazon.com /vendor/directFulfillment/shipping/2021-12-28/packingSlips/UkP3YkKDr
getPackingSlip
が必須
getPackingSlip
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | 貨物の発注書番号。 タイプ:文字列 | はい |
content | パッキングスリップ PDF の Base64 でエンコードされた文字列。 タイプ:文字列 | はい |
contentType | ファイルのフォーマット (PDF、JPEG など)。 タイプ:列挙型 ( ContentType ) | いいえ |
レスポンスの例
{
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
顧客請求書を取得 (インドのみ)
ザ・ getCustomerInvoices
オペレーションでは、指定したフィルター条件を満たすすべての発注書の顧客請求書が返されます。
重要
ザ・
getCustomerInvoices
インドのマーケットプレイスでは操作が必須です。他のマーケットプレイスではご利用いただけません。
Amazonでは、営業時間中に少なくとも1時間に1回は顧客請求書を確認するようベンダーに推奨しています。取引量によっては、確認頻度を増やすこともできます。1 回の API 呼び出しで最大 100 件の顧客請求書を取得できます。顧客請求書が 100 件を超える場合は、以下を使用できます。 nextToken
次のリクエストのパラメータとして値を指定すると、次の顧客請求書セットが取得されます。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
次の図は、顧客請求書を取得する場合の統合ワークフローを示しています。
getCustomerInvoices
が必須
getCustomerInvoices
が必須顧客請求書を返すには、getCustomerInvoices
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
shipFromPartyId | ベンダー warehouseId ここから注文が処理されます。指定しない場合、結果にはすべての倉庫の注文が含まれます。タイプ:文字列 | いいえ |
limit | 返されるレコード数の上限。 タイプ:整数 | いいえ |
createdAfter | この日時以降に利用可能になった注文は結果に含まれます。入っている必要があります ISO 8601 日付/時刻形式。 タイプ:文字列 (日付/時間) | はい |
createdBefore | この日付と時刻より前に利用可能になった注文が結果に含まれます。入っている必要があります ISO 8601 日付/時刻形式。 タイプ:文字列 (日付/時間) | はい |
sortOrder | 昇順にソート (ASC ) または降順 (DESC ) 注文作成日別。タイプ:列挙型 ( SortOrder ) | いいえ |
nextToken | 指定された結果サイズの制限を超える出荷ラベルがある場合のページネーションに使用されます。トークンの値は前回の API 呼び出しで返されます。 タイプ:文字列 | いいえ |
リクエストの例
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/customerInvoices?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
getCustomerInvoices
が必須
getCustomerInvoices
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
pagination | 100件を超える顧客請求書が返送された場合、 nextToken ページネーションのレスポンスで返されます。タイプ: ページネーション | いいえ |
customerInvoices | 顧客請求書のリスト。 タイプ: < CustomerInvoice > アレイ | いいえ |
レスポンスの例
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"customerInvoices": [
{
"purchaseOrderNumber": "PO98676856",
"content": "base 64 content goes here"
}
]
}
顧客請求書を取得 (インドのみ)
getCustomerInvoice
オペレーションは、発注番号を使用して指定された顧客請求書に関する情報を返します。このレスポンスには、その発注書の完全な顧客請求書情報が含まれます。
注
これは制限付きのオペレーションであるため、認可用の制限付きデータトークン(RDT)が必要です。詳細については、トークンAPIユースケースガイドを参照してください。
このAPIを使用して、顧客請求書の詳細を取得することもできます(過去6か月間のうち7日間、ベンダーがAPIの使用を開始後)。
次の図は、顧客請求書を返すための統合ワークフローを示しています。
ビジネスの要件
どのような種類の顧客請求書をダウンロードできますか?
顧客請求書は、binary64文字列形式でエンコードされたPDFファイルです。インド地域のすべての発注には、出荷と一緒に送信される顧客請求書が作成されている必要があります。
getCustomerInvoice
が必須
getCustomerInvoice
が必須顧客請求書を返すには、getCustomerInvoice
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | 請求書を返送する貨物の発注書番号。 タイプ:文字列 | はい |
リクエストの例
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/2JK3S9VC
getCustomerInvoice
が必須
getCustomerInvoice
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
purchaseOrderNumber | この注文の発注番号。 タイプ:文字列 | はい |
content | Base64 でエンコードされた顧客請求書。 タイプ:文字列 | はい |
レスポンスの例
{
"purchaseOrderNumber": "PO98676856",
"content": "base 64 encoded string"
}
コンテナラベルの作成
を使用してください createContainerLabel
パレタイズされた積荷ごとに Amazon にパレットラベルをリクエストして受け取るオペレーション。レスポンスには、ラベルタイプとパレット ID が記載された 4X6 インチの印刷可能なパレットラベルが含まれます。
ビジネスの要件
ザの createContainerLabel
オペレーションでは、1 回の API 呼び出しで複数のパレットラベルリクエストを行うことはできません。複数のパレットのパレットラベルを取得する場合は、複数のパレットを送信する必要があります。 createContainerLabel
並行リクエスト。
createContainerLabel
が必須
createContainerLabel
が必須配送ラベルをリクエストするには、createContainerLabel
オペレーションを呼び出し、次のパラメーターを渡します。
名前 | 説明 | 必須 |
---|---|---|
sellingParty | 販売者またはベンダーのID。タイプ: PartyIdentification | はい |
shipFromParty | ベンダーの倉庫コード。タイプ: PartyIdentification | はい |
vendorContainerId | コンテナのベンダー固有の識別子。タイプ: VendorContainerId | はい |
carrierId | コンテナ (パレット) ラベルの配送業者。タイプ: CarrierId | はい |
packages | 出荷パッケージとコンテナを関連付けるパッケージオブジェクトの配列。タイプ: Packages | はい |
リクエストの例
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/containerLabel
{
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"vendorContainerId": "000011189212211212",
"carrierId": "SWA",
"packages": [
{
"packageTrackingNumber": "TBA134335066000"
},
{
"packageTrackingNumber": "TBA214335089000"
},
{
"packageTrackingNumber": "TBA311235066000"
}
]
}
createContainerLabel
が必須
createContainerLabel
が必須成功レスポンスには、以下が含まれます。
名前 | 説明 | 必須 |
---|---|---|
containerTrackingNumber | 配送業者からのコンテナ (パレット) 追跡識別子。タイプ:文字列 | はい |
content | Base64 文字列にエンコードされたコンテナラベルの内容。タイプ:文字列 | はい |
format | コンテナラベルのフォーマット。タイプ: ContainerLabelFormat | はい |
レスポンスの例
{
"containerLabel": {
"containerTrackingNumber": "TBA134335066000",
"content": "Base64 encoded string",
"format": "PNG"
}
}
Updated 12 days ago