PUT
/
buyers
/
{buyer_id}
/
shipping-details
/
{shipping_detail_id}

This endpoint requires the buyers.write scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

buyer_id
string
required

The unique ID for a buyer.

shipping_detail_id
string
required

The unique ID for a buyer's shipping detail.

Body

application/json
first_name
string | null

The first name(s) or given name for the buyer.

Required string length: 1 - 255
last_name
string | null

The last name, or family name, of the buyer.

Required string length: 1 - 255
email_address
string | null

The email address for the buyer.

Required string length: 1 - 320
phone_number
string | null

The phone number for the buyer which should be formatted according to the E164 number standard.

Required string length: 1 - 50
address
object

The physical shipping address associated to this buyer.

Response

200 - application/json

Shipping detail for a buyer.

type
enum<string>

The type of this resource. Is always shipping-details.

Available options:
shipping-details
id
string

The unique ID for a buyer's shipping detail.

buyer_id
string

The unique ID for a buyer.

first_name
string | null

The first name(s) or given name of the buyer.

Required string length: 1 - 255
last_name
string | null

The last name, or family name, of the buyer.

Required string length: 1 - 255
email_address
string | null

The email address of the buyer.

Required string length: 1 - 320
phone_number
string | null

The phone number of the buyer. This number is formatted according to the E164 number standard.

Required string length: 1 - 50
address
object

The physical shipping address associated to this buyer.

Was this page helpful?

New buyer shipping detailDelete buyer shipping detail