Add buyer shipping details

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Buyers.ShippingDetails.CreateAsync(
    buyerId: "fe26475d-ec3e-4884-9553-f7356683f7f9",
    shippingDetailsCreate: new ShippingDetailsCreate() {}
);

// handle response

{
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "[email protected]",
  "phone_number": "+1234567890",
  "address": {
    "city": "San Jose",
    "country": "US",
    "postal_code": "94560",
    "state": "California",
    "state_code": "US-CA",
    "house_number_or_name": "10",
    "line1": "Stafford Appartments",
    "line2": "29th Street",
    "organization": "Gr4vy"
  },
  "id": "bf8c36ad-02d9-4904-b0f9-a230b149e341",
  "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "type": "shipping-details"
}

POST

buyers

{buyer_id}

shipping-details

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Buyers.ShippingDetails.CreateAsync(
    buyerId: "fe26475d-ec3e-4884-9553-f7356683f7f9",
    shippingDetailsCreate: new ShippingDetailsCreate() {}
);

// handle response

{
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "[email protected]",
  "phone_number": "+1234567890",
  "address": {
    "city": "San Jose",
    "country": "US",
    "postal_code": "94560",
    "state": "California",
    "state_code": "US-CA",
    "house_number_or_name": "10",
    "line1": "Stafford Appartments",
    "line2": "29th Street",
    "organization": "Gr4vy"
  },
  "id": "bf8c36ad-02d9-4904-b0f9-a230b149e341",
  "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "type": "shipping-details"
}

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.

Headers

x-gr4vy-merchant-account-id

string

The ID of the merchant account to use for this request.

Path Parameters

buyer_id

string<uuid>

required

The ID of the buyer to add shipping details to.

Body

application/json

first_name

string | null

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

Required string length: 1 - 255

Example:

"John"

last_name

string | null

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

Required string length: 1 - 255

Example:

"Doe"

email_address

string | null

The email address for the buyer.

Required string length: 1 - 320

Example:

"[email protected]"

phone_number

string | null

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

Example:

"+1234567890"

address

Address · object

The billing address for the buyer.

Show child attributes

address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

Response

Successful Response

first_name

string | null

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

Required string length: 1 - 255

Example:

"John"

last_name

string | null

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

Required string length: 1 - 255

Example:

"Doe"

email_address

string | null

The email address for the buyer.

Required string length: 1 - 320

Example:

"[email protected]"

phone_number

string | null

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

Example:

"+1234567890"

address

Address · object

The billing address for the buyer.

Show child attributes

address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

string<uuid> | null

The ID for the shipping details.

Example:

"bf8c36ad-02d9-4904-b0f9-a230b149e341"

buyer_id

string<uuid> | null

The ID for the buyer.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

type

string

default:shipping-details

Always shipping-details.

Allowed value: "shipping-details"

List a buyer's shipping details

Update a buyer's shipping details

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Connections

Errors

Other

Add buyer shipping details

Authorizations

Headers

Path Parameters

Body

Response