scopes

scopes defines the buyer details that you're requesting access to. You set scopes in Amazon Pay button rendering script.

Supported values:

• 'name' - Buyer name
• 'email' - Buyer email
• 'phoneNumber' - Default billing address phone number
• 'billingAddress' - Default billing address

By setting supported value in "scopes", you get such buyer information in Get Checkout Session API response. Below is a sample buyer data in API response when you set all supported values in "scopes".

"buyer": {
    "buyerId": "buyerId",
    "name": "name-1",
    "email": "name@amazon.com",
    "phoneNumber": "800-000-0000",
    "primeMembershipTypes": null
},
"billingAddress":{
    "name": "Work",
    "addressLine1": "440 Terry Ave",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Seattle",
    "county": "King",    
    "district": "Seattle",
    "stateOrRegion": "WA",
    "postalCode": "98121",
    "countryCode": "US",
    "phoneNumber": "800-000-0000"
}

If you don't set "scopes", you will receive following information as a default.

In case of PayAndShip

• name
• email

In case of PayOnly

• name
• email
• phoneNumber
• billindAddress

caution

• If a buyer chose to pay only with Gift Card, phoneNumber and billingAddress are not provided despite the "scopes" setting.
• There is no option not to receive buyer information at all.

Set at least one supported value in "scopes" in principle.