Shipping details
List buyer shipping details
Retrieve all shipping details for a buyer.
GET
/buyers/{buyer_id}/shipping-details
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/buyers/{buyer_id}/shipping-details \
--header 'Authorization: <authorization>'
{
"items": [
{
"address": {
"city": "London",
"country": "GB",
"house_number_or_name": "10",
"line1": "10 Oxford Street",
"line2": "New Oxford Court",
"organization": "Gr4vy",
"postal_code": "789123",
"state": "Greater London",
"state_code": "GB-LND"
},
"buyer_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"email_address": "john@example.com",
"first_name": "John",
"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"last_name": "Lunn",
"phone_number": "+1234567890",
"type": "shipping-details"
}
]
}
This endpoint requires the buyers.read
scope. The buyers.billing-details.read
scope is needed to see personally identifiable information.
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
buyer_idrequired
string
The unique ID for a buyer.
Response
200 - application/json
items
object[]
A list of shipping details.
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/buyers/{buyer_id}/shipping-details \
--header 'Authorization: <authorization>'
{
"items": [
{
"address": {
"city": "London",
"country": "GB",
"house_number_or_name": "10",
"line1": "10 Oxford Street",
"line2": "New Oxford Court",
"organization": "Gr4vy",
"postal_code": "789123",
"state": "Greater London",
"state_code": "GB-LND"
},
"buyer_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"email_address": "john@example.com",
"first_name": "John",
"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"last_name": "Lunn",
"phone_number": "+1234567890",
"type": "shipping-details"
}
]
}