Customer data object specification for the Cratejoy Merchant API

Properties

Property Filter Edit Type Description
id INT Unique identifier
country STRING Two letter country code for the customer as determined by the primary address
email STRING The customer's email address
first_name STRING First name as parsed from name
last_name STRING Last name as parsed from name
location STRING The customer's location (e.g. State + Country)
name STRING The customer's full name. Will update based on edits to first_name or last_name
num_orders INT How many orders this customer has placed
num_subscriptions INT How many subscriptions the customer has ordered
subscription_status STRING User friendly name of this customers subscription status. Includes Active, Past Due, Expired, Cancelled, and Mixed (if the customer has multiple subscriptions with different statuses)
total_revenue INT The dollar amount this customer has paid
type STRING The type of the element. In this case, customer
note STRING Only supports prepend (via PUT) and delete.
url STRING Direct link to GET the full details of the customer

Relation Properties

PropertyResourceDescriptionFilter?
addressesAddressA collection of addresses for this customerYes
_mdCustomerMetadataUser defined data about the customerYes

Additional Related Properties

see Working with Object Relationships

PropertyResourceDescriptionFilter?
logsCustomerLogA collection of customer log entries.Yes
cartsCartA collection of carts associated with the customer.Yes
notesYes
ordersOrderA collection of orders associated with the customer.Yes
shipmentsShipmentA collection of shipments associated with the customer.Yes
subscriptionsSubscriptionA collection of subscriptions associated with the customerYes

The above properties on the customer are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a url to fetch the related resources OR contain the resources themselves