GET
/
buyers
/
{buyer_id}
/
shipping-details
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/buyers/{buyer_id}/shipping-details \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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.read scope. The buyers.billing-details.read scope is needed to see personally identifiable information.

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.

Response

200
application/json
Returns all associated shipping details.

A list of shipping details.

​
items
object[]

A list of shipping details.

Shipping detail for a buyer.

Was this page helpful?

Suggest edits
Delete buyerNew buyer shipping detail