POST
/
buyers
/
{buyer_id}
/
shipping-details
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/buyers/{buyer_id}/shipping-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "John",
  "last_name": "Lunn",
  "email_address": "john@example.com",
  "phone_number": "+1234567890",
  "address": {
    "city": "London",
    "country": "GB",
    "postal_code": "789123",
    "state": "Greater London",
    "state_code": "GB-LND",
    "house_number_or_name": "10",
    "line1": "10 Oxford Street",
    "line2": "New Oxford Court",
    "organization": "Gr4vy"
  }
}'
{
  "type": "shipping-details",
  "id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
  "buyer_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
  "first_name": "John",
  "last_name": "Lunn",
  "email_address": "john@example.com",
  "phone_number": "+1234567890",
  "address": {
    "city": "London",
    "country": "GB",
    "postal_code": "789123",
    "state": "Greater London",
    "state_code": "GB-LND",
    "house_number_or_name": "10",
    "line1": "10 Oxford Street",
    "line2": "New Oxford Court",
    "organization": "Gr4vy"
  }
}

This endpoint requires the buyers.write scope.

Authorizations

​
Authorization
string
header
required

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.

Body

application/json

Shipping detail associated to a buyer.

​
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

201
application/json
Returns the shipping detail that was added.

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?

List buyer shipping detailsUpdate buyer shipping details