Replenishエンドポイント
Warning: ここではLegacy APIについて記載しています。新しいAPIについてはこちらを参照してください。
Replenishは、デバイス/スロットの組み合わせに対する注文を行ううえで核となるAPIです。Replenishエンドポイントを呼び出すと、デバイスの登録時にユーザーによって選択されたASINが発注されます。Replenishエンドポイントでは、ユーザーの登録時に使用されたLWAスコープデータに応じて、テスト注文と実際の注文の両方を行うことができます。詳細については、テストデバイスでの購入に関する記事を参照してください。
パス
/replenish/{SLOT_ID}
HTTPメソッド
POST
ヘッダーパラメーター
Authorization: Bearer <ACCESS_TOKEN>
x-amzn-accept-type: com.amazon.dash.replenishment.DrsReplenishResult@1.0
x-amzn-type-version: com.amazon.dash.replenishment.DrsReplenishInput@1.0
バージョニング
ユーザーに直接影響を及ぼさずにAPIの機能を段階的に更新するためにバージョニングが使用されます。x-amzn-type-version
およびx-amzn-accept-type
ヘッダーは、各呼び出しで送信する必要があります。Replenishエンドポイントでは、以下がサポートされています。
x-amzn-type-version: com.amazon.dash.replenishment.DrsReplenishInput@1.0
x-amzn-accept-type: com.amazon.dash.replenishment.DrsReplenishResult@1.0
レスポンス例
HTTP/1.1 200 Accepted
x-amzn-type-version: com.amazon.dash.replenishment.DrsReplenishResult@1.0
Content-Type: application/json
{
"eventInstanceId" : "SOME_EVENT_INSTANCE"
"detailCode" : "STANDARD_ORDER_PLACED"
}
レスポンス例の詳細
成功のレスポンスは、購入が実際に行われたことを示すものではありません。成功のレスポンスは、Amazonによってリクエストが受理され、何らかの処理が実行されたことを示します。注文が受理されると、Amazonから次の情報が返されます。
eventInstanceId
: 注文通知を元の購入イベントに対応付ける際に使用されます。長さは最大255文字です。detailCode
: 注文の結果を表します。
使用されるdetailCode
値は次のとおりです。
レスポンス | 説明 |
---|---|
STANDARD_ORDER_PLACED |
注文は正常に行われ、ユーザーに発送されます。 |
TEST_ORDER_PLACED |
注文はテストフラグ付きで正常に行われました。通知はすべて正常に進みますが、ユーザーへの請求は行われず、商品は発送されません。 |
ORDER_INPROGRESS |
既に進行中の注文があるため、注文は行われませんでした。ユーザーへの配送を控えている注文が存在する間は、この値が返されます。 |
Note: ASINの状態またはユーザーのアカウントの状態が原因で購入処理をすぐに実行できない場合でも、DRSは注文を受理し、STANDARD_ORDER_PLACEDレスポンスを返します。注文は非同期のワークフローです。このドキュメントで後述するSNS通知を使用する際は、状態の変化を把握するために、しっかりと計画を立ててください。詳細については、Amazon発注エラー解決手順を参照してください。
エラーレスポンス
エラーレスポンス | 説明 |
---|---|
HTTP/1.1 400 Bad Request | クライアントエラー: クライアントから渡されたデータが原因でエラーが発生しました(無効なトークンなど)。Amazonは、レスポンス本文に含まれるエラーの性質について可能な限りのフィードバックを提供できるよう努めます。 |
HTTP/1.1 404 Not Found | クライアントエラー: 存在しないスロットを補充しようとしています。 |
HTTP/1.1 500 | 内部サーバーエラー: サーバー内部でエラーが発生したことを示します。 |
Last updated: Aug 07, 2018