This endpoint requires the buyers.read
scope. The buyers.billing-details.read
scope is needed to see personally identifiable information.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The unique ID for a buyer.
A list of shipping details.
A list of shipping details.
The physical shipping address associated to this buyer.
The city for the address.
Required string length: 1 - 100
The country for the address in ISO 3166 format.
Required string length: 2
items.address.house_number_or_name
The house number or name for the address. Not all payment
services use this field but some do.
Required string length: 1 - 255
The first line of the address.
Required string length: 1 - 255
The second line of the address.
Required string length: 1 - 255
items.address.organization
The optional name of the company or organisation to add
to the address.
Required string length: 1 - 255
items.address.postal_code
The postal code or zip code for the address.
Required string length: 1 - 50
The state, county, or province for the address.
Required string length: 1 - 255
The code of state, county, or province for the address in
ISO 3166-2 format.
Required string length: 4 - 6
The unique ID for a buyer.
The email address of the buyer.
Required string length: 1 - 320
The first name(s) or given name of the buyer.
Required string length: 1 - 255
The unique ID for a buyer's shipping detail.
The last name, or family name, of the buyer.
Required string length: 1 - 255
Required string length: 1 - 50
The type of this resource. Is always shipping-details
.
Available options:
shipping-details