GET
/
shipping
/
retrieve
/
{id}
Retrieve
curl --request GET \
  --url https://api.buybase.ai/shipping/retrieve/{id} \
  --header 'authorization: <authorization>'
{
  "success": true,
  "shipping": {
    "id": "ship_12345",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@example.com",
    "phone": "+1234567890",
    "address_1": "456 Park Ave",
    "address_2": "Suite 789",
    "city": "New York",
    "country_code": "US",
    "province_code": "NY",
    "postal_code": "10022",
    "profile_id": "prof_67890",
    "created_at": "2023-09-15T14:22:31Z",
    "updated_at": "2023-09-16T10:15:22Z"
  },
  "code": "SHIPPING_RETRIEVED"
}

Headers

authorization
string
required
Your API key for authorization.

Path Parameters

id
string
required
The ID of the shipping address to retrieve.

Response

success
boolean
Indicates whether the operation was successful.
shipping
object
The shipping address object.
code
string
A code indicating the result of the operation. Possible values:
  • SHIPPING_RETRIEVED: Shipping address retrieved successfully
  • SHIPPING_NOT_FOUND: Shipping address not found
error
string
Error message if the request fails.
{
  "success": true,
  "shipping": {
    "id": "ship_12345",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@example.com",
    "phone": "+1234567890",
    "address_1": "456 Park Ave",
    "address_2": "Suite 789",
    "city": "New York",
    "country_code": "US",
    "province_code": "NY",
    "postal_code": "10022",
    "profile_id": "prof_67890",
    "created_at": "2023-09-15T14:22:31Z",
    "updated_at": "2023-09-16T10:15:22Z"
  },
  "code": "SHIPPING_RETRIEVED"
}