Update a buyer's shipping details

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.Buyers.ShippingDetails.UpdateAsync(
    buyerId: "fe26475d-ec3e-4884-9553-f7356683f7f9",
    shippingDetailsId: "bf8c36ad-02d9-4904-b0f9-a230b149e341",
    shippingDetailsUpdate: new ShippingDetailsUpdate() {}
);

// handle response

package main

import(
	"context"
	gr4vygo "github.com/gr4vy/gr4vy-go"
	"os"
	"github.com/gr4vy/gr4vy-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    privateKey := "...."
	withToken := gr4vy.WithToken(privateKey, []JWTScope{ReadAll, WriteAll}, 60)

	s := gr4vy.New(
		gr4vy.WithID("mattilda"),
		gr4vy.WithServer(gr4vy.ServerSandbox),
		gr4vy.WithSecuritySource(withToken),
		gr4vy.WithMerchantAccountID("default"),
	)

    res, err := s.Buyers.ShippingDetails.Update(ctx, "fe26475d-ec3e-4884-9553-f7356683f7f9", "bf8c36ad-02d9-4904-b0f9-a230b149e341", components.ShippingDetailsUpdate{})
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import java.lang.Exception;
import com.gr4vy.sdk.BearerSecuritySource;
import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.Gr4vy.AvailableServers;
import org.openapis.openapi.models.components.ShippingDetailsUpdate;
import org.openapis.openapi.models.errors.*;
import org.openapis.openapi.models.operations.UpdateBuyerShippingDetailsResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .id("mattilda")
                .server(AvailableServers.SANDBOX)
                .merchantAccountId("default")
                .securitySource(new BearerSecuritySource.Builder(privateKey).build())
            .build();

        UpdateBuyerShippingDetailsResponse res = sdk.buyers().shippingDetails().update()
                .buyerId("fe26475d-ec3e-4884-9553-f7356683f7f9")
                .shippingDetailsId("bf8c36ad-02d9-4904-b0f9-a230b149e341")
                .shippingDetailsUpdate(ShippingDetailsUpdate.builder()
                    .build())
                .call();

        if (res.shippingDetails().isPresent()) {
            // handle response
        }
    }
}

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;
use Gr4vy\Auth;

 
$privateKey = "..."; 

$sdk = Gr4vy\SDK::builder()
    -\u003esetId('mattilda')
    -\u003esetServer('sandbox')
    -\u003esetSecuritySource(Auth::withToken($privateKey))
    -\u003esetMerchantAccountId('default')
    -\u003ebuild();

$shippingDetailsUpdate = new Gr4vy\ShippingDetailsUpdate();

$response = $sdk->buyers->shippingDetails->update(
    buyerId: 'fe26475d-ec3e-4884-9553-f7356683f7f9',
    shippingDetailsId: 'bf8c36ad-02d9-4904-b0f9-a230b149e341',
    shippingDetailsUpdate: $shippingDetailsUpdate

);

if ($response->shippingDetails !== null) {
    // handle response
}

from gr4vy import Gr4vy, auth
import os


with Gr4vy(
    id="mattilda",
    server="production",
    merchant_account_id="default",
    bearer_auth=auth.with_token(open("./private_key.pem").read())
) as g_client:

    res = g_client.buyers.shipping_details.update(buyer_id="fe26475d-ec3e-4884-9553-f7356683f7f9", shipping_details_id="bf8c36ad-02d9-4904-b0f9-a230b149e341")

    # Handle response
    print(res)

import { Gr4vy } from "@gr4vy/sdk";

const gr4vy = new Gr4vy({
    server: "sandbox",
    id: "mattilda",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.buyers.shippingDetails.update({}, "fe26475d-ec3e-4884-9553-f7356683f7f9", "bf8c36ad-02d9-4904-b0f9-a230b149e341");

  console.log(result);
}

run();

{
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "john@example.com",
  "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"
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "The resource could not be found",
  "details": []
}

{
  "type": "error",
  "code": "method_not_allowed",
  "status": 405,
  "message": "Method Not Allowed",
  "details": []
}

{
  "type": "error",
  "code": "duplicate_record",
  "status": 409,
  "message": "Request failed validation",
  "details": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "type": "error",
  "code": "too_early",
  "status": 425,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "too_many_requests",
  "status": 429,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "server_error",
  "status": 500,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "bad_gateway",
  "status": 502,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "gateway_timeout",
  "status": 504,
  "message": "Request could not be processed",
  "details": []
}

PUT

buyers

{buyer_id}

shipping-details

{shipping_details_id}

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.Buyers.ShippingDetails.UpdateAsync(
    buyerId: "fe26475d-ec3e-4884-9553-f7356683f7f9",
    shippingDetailsId: "bf8c36ad-02d9-4904-b0f9-a230b149e341",
    shippingDetailsUpdate: new ShippingDetailsUpdate() {}
);

// handle response

package main

import(
	"context"
	gr4vygo "github.com/gr4vy/gr4vy-go"
	"os"
	"github.com/gr4vy/gr4vy-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    privateKey := "...."
	withToken := gr4vy.WithToken(privateKey, []JWTScope{ReadAll, WriteAll}, 60)

	s := gr4vy.New(
		gr4vy.WithID("mattilda"),
		gr4vy.WithServer(gr4vy.ServerSandbox),
		gr4vy.WithSecuritySource(withToken),
		gr4vy.WithMerchantAccountID("default"),
	)

    res, err := s.Buyers.ShippingDetails.Update(ctx, "fe26475d-ec3e-4884-9553-f7356683f7f9", "bf8c36ad-02d9-4904-b0f9-a230b149e341", components.ShippingDetailsUpdate{})
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import java.lang.Exception;
import com.gr4vy.sdk.BearerSecuritySource;
import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.Gr4vy.AvailableServers;
import org.openapis.openapi.models.components.ShippingDetailsUpdate;
import org.openapis.openapi.models.errors.*;
import org.openapis.openapi.models.operations.UpdateBuyerShippingDetailsResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .id("mattilda")
                .server(AvailableServers.SANDBOX)
                .merchantAccountId("default")
                .securitySource(new BearerSecuritySource.Builder(privateKey).build())
            .build();

        UpdateBuyerShippingDetailsResponse res = sdk.buyers().shippingDetails().update()
                .buyerId("fe26475d-ec3e-4884-9553-f7356683f7f9")
                .shippingDetailsId("bf8c36ad-02d9-4904-b0f9-a230b149e341")
                .shippingDetailsUpdate(ShippingDetailsUpdate.builder()
                    .build())
                .call();

        if (res.shippingDetails().isPresent()) {
            // handle response
        }
    }
}

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;
use Gr4vy\Auth;

 
$privateKey = "..."; 

$sdk = Gr4vy\SDK::builder()
    -\u003esetId('mattilda')
    -\u003esetServer('sandbox')
    -\u003esetSecuritySource(Auth::withToken($privateKey))
    -\u003esetMerchantAccountId('default')
    -\u003ebuild();

$shippingDetailsUpdate = new Gr4vy\ShippingDetailsUpdate();

$response = $sdk->buyers->shippingDetails->update(
    buyerId: 'fe26475d-ec3e-4884-9553-f7356683f7f9',
    shippingDetailsId: 'bf8c36ad-02d9-4904-b0f9-a230b149e341',
    shippingDetailsUpdate: $shippingDetailsUpdate

);

if ($response->shippingDetails !== null) {
    // handle response
}

from gr4vy import Gr4vy, auth
import os


with Gr4vy(
    id="mattilda",
    server="production",
    merchant_account_id="default",
    bearer_auth=auth.with_token(open("./private_key.pem").read())
) as g_client:

    res = g_client.buyers.shipping_details.update(buyer_id="fe26475d-ec3e-4884-9553-f7356683f7f9", shipping_details_id="bf8c36ad-02d9-4904-b0f9-a230b149e341")

    # Handle response
    print(res)

import { Gr4vy } from "@gr4vy/sdk";

const gr4vy = new Gr4vy({
    server: "sandbox",
    id: "mattilda",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.buyers.shippingDetails.update({}, "fe26475d-ec3e-4884-9553-f7356683f7f9", "bf8c36ad-02d9-4904-b0f9-a230b149e341");

  console.log(result);
}

run();

{
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "john@example.com",
  "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"
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "The resource could not be found",
  "details": []
}

{
  "type": "error",
  "code": "method_not_allowed",
  "status": 405,
  "message": "Method Not Allowed",
  "details": []
}

{
  "type": "error",
  "code": "duplicate_record",
  "status": 409,
  "message": "Request failed validation",
  "details": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "type": "error",
  "code": "too_early",
  "status": 425,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "too_many_requests",
  "status": 429,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "server_error",
  "status": 500,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "bad_gateway",
  "status": 502,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "gateway_timeout",
  "status": 504,
  "message": "Request could not be processed",
  "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 | null

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

Example:

"default"

Path Parameters

buyer_id

string<uuid>

required

The ID of the buyer to update shipping details for.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

shipping_details_id

string<uuid>

required

The ID of the shipping details to update.

Example:

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

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:

"john@example.com"

phone_number

string | null

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

Pattern: ^\+[1-9]\d{1,14}$

Example:

"+1234567890"

address

Address · object | null

The billing address for the buyer.

Show child attributes

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:

"john@example.com"

phone_number

string | null

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

Pattern: ^\+[1-9]\d{1,14}$

Example:

"+1234567890"

address

Address · object | null

The billing address for the buyer.

Show child attributes

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"

Example:

"shipping-details"

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Errors

Other

Update a buyer's shipping details

Authorizations

Headers

Path Parameters

Body

Response