Skip to main content
PUT
/
buyers
/
{buyer_id}
/
shipping-details
/
{shipping_details_id}
C#
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.UpdateAsync(
    buyerId: "fe26475d-ec3e-4884-9553-f7356683f7f9",
    shippingDetailsId: "bf8c36ad-02d9-4904-b0f9-a230b149e341",
    shippingDetailsUpdate: new ShippingDetailsUpdate() {}
);

// handle response
package main

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

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

s := gr4vygo.New(
gr4vygo.WithMerchantAccountID("default"),
gr4vygo.WithSecurity(os.Getenv("GR4VY_BEARER_AUTH")),
)

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 com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.components.ShippingDetailsUpdate;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.UpdateBuyerShippingDetailsResponse;
import java.lang.Exception;

public class Application {

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

Gr4vy sdk = Gr4vy.builder()
.merchantAccountId("default")
.bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
.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()) {
System.out.println(res.shippingDetails().get());
}
}
}
declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
->setId('example')
->setServer('sandbox')
->setSecuritySource(Auth::withToken($privateKey))
->setMerchantAccountId('default')
->build();

$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
import os


with Gr4vy(
id="example",
server="sandbox",
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, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
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();
curl --request PUT \
--url https://api.sandbox.{id}.gr4vy.app/buyers/{buyer_id}/shipping-details/{shipping_details_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
}
'
{
  "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": "Generic error",
"details": []
}
{
"type": "error",
"code": "unauthorized",
"status": 401,
"message": "No valid API authentication found",
"details": []
}
{
"type": "error",
"code": "forbidden",
"status": 403,
"message": "Generic error",
"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": "Generic error",
"details": [],
"resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"type": "error",
"code": "too_early",
"status": 425,
"message": "Generic error",
"details": []
}
{
"type": "error",
"code": "too_many_requests",
"status": 429,
"message": "Generic error",
"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

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.

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.

id
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"