No results found

Try a different or more specific query
Sign In
Sign In

Buyer

The Buyer object includes details about the buyer such as name, email, unique Amazon Pay identifier, default shipping address postal and country code. You should only use this object if you’ve implemented Amazon Sign-in and only because you need to retrieve Buyer details before the buyer starts Amazon Pay checkout. Once checkout has started, you should use Get Checkout Session and Get Charge Permission instead.

Supported operations:

Buyer object

Parameter
Description
buyer

Type: buyer
Details about the buyer, such as their unique identifier, name, and email

Type: buyer

Parameter
Description
buyerId

Type: string
Unique Amazon Pay buyer identifier
countryCode

Type: string
Buyer default shipping address country
email

Type: string
Buyer email address
name

Type: string
Buyer name
postalCode

Type: string
Buyer default shipping address postal code
shippingAddress

Type: address
Buyer default shipping address
billingAddress

Type: address
Buyer default billing address
phoneNumber

Type: string
Buyer default billing address phone number
primeMembershipTypes

Type: list<primeMembershipType>
List of buyer Prime memberships. This data is not available for general use

Type: address

Parameter
Description
name

Type: string
Address name

Max length: 50 characters/bytes
addressLine1

Type: string
The first line of the address

Max length: 180 characters/bytes
addressLine2

Type: string
The second line of the address

Max length: 60 characters/bytes
addressLine3

Type: string
The third line of the address

Max length: 60 characters/bytes
city

Type: string
City of the address

Max length: 50 characters/bytes
county

Type: string
County of the address

Max length: 50 characters/bytes
district

Type: string
District of the address

Max length: 50 characters/bytes
stateOrRegion

Type: string
The state or region:
  • US and CA addresses - Response will always be a 2-character code
  • All other countries - This element is free text and can be either a 2-character code, fully spelled out, or abbreviated
Max length: 50 characters/bytes
postalCode

Type: string
Postal code of the address

Max length: 20 characters/bytes
countryCode

Type: string
Country code of the address in ISO 3166 format

Max length: 3 characters/bytes
phoneNumber

Type: string
Phone number

Max length: 20 characters/bytes

Operations

Get Buyer

Get Buyer will only return buyerId by default. You must explicitly request access to additional buyer details using the button signInScopes parameter.

Amazon Pay will only provide the token required to retrieve buyer details after the buyer signs in. It will be appended to the signInReturnUrl as a query parameter and expires after 24 hours.

Request

Request parameters

Name
Location
Description
buyerToken
(required)

Type: string
Path Parameter
Token used to retrieve buyer details. This value is appended as a query parameter to signInReturnUrl

Max length: 1000 characters/bytes

Response

Returns HTTP 200 status response code if the operation was successful.

{
	"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
}

Error codes

HTTP status code
Reason code
Description
400 BAD_REQUEST
InvalidBuyerToken
The token provided is expired, revoked, malformed, or invalid for some other reason

Generic errors can be found here.