Buyer
購入者オブジェクトには、名前、メールアドレス、一意のAmazon Pay識別子、デフォルトの配送先住所、郵便番号、国コードなど、購入者に関する詳細情報が含まれます。このオブジェクトは、Amazonサインインを実装した場合にのみ使用する必要があります。これは、購入者がAmazon Payの決済を開始する前に購入者の詳細を取得する必要があるためです。決済が開始された後は、代わりにGet Checkout Session や Get Charge Permission を使用する必要があります。
サポートされている操作：
Buyerオブジェクト
| パラメータ
|
説明
|
| buyer Type: buyer |
buyerId、名前、メールアドレスなど購入者情報
|
Type: buyer
| パラメータ
|
説明
|
| buyerId Type: string |
一意のAmazon Pay購入者ID
|
| countryCode Type: string |
購入者のデフォルトの配送先住所の国
|
| email Type: string |
購入者のメールアドレス
|
| name Type: string |
購入者の名前
|
| postalCode Type: string |
購入者のデフォルトの配送先住所の郵便番号
|
| shippingAddress Type: address |
購入者のデフォルトの配送先住所
|
| billingAddress Type: address |
購入者のデフォルトの請求先住所
|
| phoneNumber Type: string |
購入者のデフォルトの請求先住所の電話番号
|
| primeMembershipTypes Type: list<primeMembershipType> |
購入者のプライム会員リスト。この値の一般利用はできません。 |
Type: address
| パラメータ
|
説明
|
| name Type: string |
アドレスの名前 最大長：50文字/バイト |
| addressLine1 Type: string |
アドレスの最初の行 最大長：180文字/バイト |
| addressLine2 Type: string |
アドレスの2行目 最大長：60文字/バイト |
| addressLine3 Type: string |
アドレスの3行目 最大長：60文字/バイト |
| city Type: string |
アドレスの市区町村 最大長：50文字/バイト 日本では利用できません。 |
| county Type: string |
アドレスの国 最大長：50文字/バイト 日本では利用できません。 |
| district Type: string |
アドレスの地域 最大長：50文字/バイト 日本では利用できません。 |
| stateOrRegion Type: string |
アドレスの州または行政区:
|
| postalCode Type: string |
アドレスの郵便番号 最大長：20文字/バイト |
| countryCode Type: string |
アドレスのISO3166形式国コード
最大長：3文字/バイト |
| phoneNumber Type: string |
電話番号 最大長：20文字/バイト |
オペレーション
Get Buyer
Get Buyerは、デフォルトで buyerId のみを返します。ボタンsignInScopes パラメータを使用して、追加の購入者の詳細へのアクセスを明示的に要求する必要があります。
Amazon Payは、購入者がサインインした後に購入者の詳細を取得するために必要なトークンのみを提供します。トークンはクエリパラメータとして signInReturnUrlに追加され、24時間後に期限切れになります。
リクエスト
リクエストパラメータ
| 名前
|
ロケーション
|
説明
|
| buyerToken (必須) Type: string |
Path Parameter
|
購入者の詳細を取得するために使用されるトークン。この値は、クエリパラメータとしてsignInReturnUrl追加されます。最大長：1000文字/バイト |
レスポンス
処理が成功した場合、HTTP 200 ステータスコードを返します。
{
"name": "John Example",
"email": "johnexample@amazon.com",
"postalCode": "12345",
"countryCode": "US",
"buyerId": "DIRECTEDBUYERID",
"phoneNumber": "1234567811" // default billing address phone number
"shippingAddress": {
"name": "John",
"addressLine1": "15th Street",
"addressLine2": "",
"addressLine3": "",
"city": "Seattle",
"county": "",
"district": "",
"stateOrRegion": "WA",
"country": "USA",
"postalCode": "98121",
"phoneNumber": "1234567899"
},
"billingAddress": null,
"primeMembershipTypes": null
}
エラーコード
| HTTPステータスコード
|
理由コード
|
説明
|
| 400 BAD_REQUEST
|
InvalidBuyerToken
|
トークンの有効期限が切れている、もしくは何かしらの理由で無効になってます
|
その他エラーはこちらを参照してください。