Skip to content

The Customer entity at YouCan.

Attribute NameTypeDescription
idstringIdentifier (UUID)
first_namestring, nullCustomer first name
last_namestring, nullCustomer last name
full_namestring, nullCustomer full name (first + last)
emailstringCustomer email address
avatarstring, nullURL of the customer avatar image
phonestring, nullCustomer phone number
countrystring, nullCustomer country
regionstring, nullCustomer region
citystring, nullCustomer city
notesstring, nullInternal notes about the customer
locationstring, nullComputed location label (city + country)
created_atstringCreation date (ISO 8601, store timezone)
updated_atstringLast update date (ISO 8601, store timezone)
deleted_atstring, nullDeletion date (ISO 8601), null if not deleted
links.editstringURL to edit the customer in the seller area
addressarrayCustomer addresses (default include)
ordersarrayCustomer orders (available include)

Address

Array of Address objects associated with the customer.

Orders

Array of Order objects placed by the customer. Use ?include=orders to include.