Customer
The Customer object
Unique identifier for the object.
The ID of the merchant this Customer belongs to, that is your own merchant.
Has the value "live" if the object exists in live mode, or "sand" if it exists in test mode.
Possible values: [sand, live]
The date and time the Customer was created, in UTC.
The customer’s email address.
The customer’s first name.
The customer’s last name.
The customer’s phone number.
The ID of the customer in your own system, such as the user ID of your website. It is unique per environment, so two Customers of the same environment can't share it.
The language the Customer is written to in, as an ISO 639-1 two-letter code.
The ID of the Company this Customer is associated with.
company objectnullable
The Company this Customer is associated with, returned in full when one exists.
Unique identifier for the object.
The ID of the merchant this Company belongs to, that is your own merchant.
Has the value "live" if the object exists in live mode, or "sand" if it exists in test mode.
Possible values: [sand, live]
A unique 6-character code that can be used to join or reference this Company.
Possible values: >= 6 characters and <= 6 characters
Company name.
The percentage applied to catalogue prices for this Company. Positive values raise them, negative values lower them.
prepaidPolicy object
The prepaid policy applied to the Customers of this Company.
Indicates whether the prepaid policy is currently active.
The maximum amount, in cents, that the Customer is allowed to spend in a single Date under this policy.
The packaging used by the Customers of this Company that do not set one of their own. Null when the Company follows the ecommerce site default.
Possible values: [Reusable, Disposable]
addresses object[]nullable
An array of delivery addresses associated with this Company. Each address can have specific delivery fees and store information.
Unique identifier for the address.
A friendly label or name for this address (e.g., "Main Office", "Warehouse").
The street name of the address.
The street number of the address.
The city of the address.
The province or state of the address.
The postal or ZIP code of the address.
The country code of the address (e.g., "IT" for Italy).
The delivery fee amount for this address, in cents.
The unique identifier of the store associated with this address.
packaging objectnullable
The packaging set on the Customer itself, for merchants that operate a reusable container scheme. Absent when the Customer inherits both the type and the deposit.
Whether the Customer is on reusable or disposable packaging. Null when the Customer inherits the type from its Company, or from the ecommerce site default.
Possible values: [Reusable, Disposable]
Whether the deposit on the reusable packaging has been paid.
wallet object
Summary information about the Customer's wallet, including total amounts and last update timestamp.
The total amount available in the customer's wallet, in cents.
The total amount of voucher funds available in the customer's wallet, in cents.
The total amount of cash funds available in the customer's wallet, in cents.
The UTC timestamp of when the wallet totals were last updated.
spendData objectnullable
Aggregated spending history of the Customer.
The total amount the Customer has spent, in cents.
The total amount refunded to the Customer, in cents.
The number of Payments the Customer has completed.
The average amount of the Customer's Payments, in cents.
The date and time of the Customer's first Payment, in UTC. The property name carries a typo that is part of the wire format.
The date and time of the Customer's most recent Payment, in UTC.
consents object[]
The current choice of the Customer for each purpose and channel it expressed one for. A consent never expressed is absent.
What the consent is for. Marketing is receiving promotional messages; Profiling is the analysis of the purchase history to tailor offers.
Possible values: [Marketing, Profiling]
The channel of a marketing consent. Absent for profiling, which has no channel.
Possible values: [Email, Sms, Whatsapp]
Whether the consent is given. False means the Customer revoked it, which for email is also the opposition to promotional email sent to past buyers.
When the Customer made this choice, in UTC.
The version of the consent text the Customer was shown.
metadata objectnullable
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. It can contain up to 10 key-value items with a maximum length of 40 for the key and of 400 chars for the value.
{
"id": "string",
"merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenant": "sand",
"created": "2024-07-29T15:51:28.071Z",
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"referenceId": "string",
"language": "string",
"companyId": "string",
"company": {
"id": "string",
"merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenant": "sand",
"joinCode": "string",
"name": "string",
"priceAdjustmentPercentage": 0,
"prepaidPolicy": {
"isActive": true,
"amount": 0
},
"packagingType": "Reusable",
"addresses": [
{
"id": "string",
"label": "string",
"streetName": "string",
"streetNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string",
"country": "string",
"deliveryFeeAmount": 0,
"storeId": "string"
}
]
},
"packaging": {
"type": "Reusable",
"isDepositPaid": true
},
"wallet": {
"totalAmount": 0,
"totalVoucherAmount": 0,
"totalCashAmount": 0,
"lastUpdatedOnUtc": "2024-07-29T15:51:28.071Z"
},
"spendData": {
"totalSpentAmount": 0,
"totalRefundedAmount": 0,
"noOfPayments": 0,
"averagePaymentAmount": 0,
"firstPaymentOnOtc": "2024-07-29T15:51:28.071Z",
"lastPaymentOnUtc": "2024-07-29T15:51:28.071Z"
},
"consents": [
{
"purpose": "Marketing",
"channel": "Email",
"granted": true,
"collectedAt": "2024-07-29T15:51:28.071Z",
"version": "string"
}
],
"metadata": {}
}