Customer

A Customer represents an end customer within your Liftoff account.

Properties

NameTypeDescription
IdintThe ID of the customer.
AccountIdintThe ID of the account that the customer belongs to. (Note: This account ID will always correspond to the account code you use in your authentication credentials.)
Account (via $expand)AccountThe account that the customer belongs to.
EmailstringThe email of the customer. The customer's email also serves as the customer's username for login purposes.
PasswordstringThe password for the customer. Note: This is a write-only value supported only by the Add customer and Update customer methods. Passwords are stored using one-way encryption and cannot be decrypted. Therefore, passwords are never included in any responses.
NamestringThe full name of the customer.
CreateDatedatetimeoffsetThe date the customer was created.
LastModifiedDatedatetimeoffsetThe date the customer was most recently modified.
LastLoginDatedatetimeoffsetThe date the customer most recently logged in.
IsActivebooleanFlag that indicates whether the customer is active.
IsGuestbooleanFlag that indicates whether the customer is a guest.
CurrencyCodestringThe 3-character currency code (e.g., USD) assigned to the customer.
CustomerIdstringInternal identifier for the customer (e.g., to map the customer to a record in an ERP system).
TaxExemptbooleanFlag that indicates whether the customer is tax exempt.
OpenAccountbooleanFlag that indicates whether the customer may submit orders without payment up front.
EnableCreditCardsbooleanFlag that indicates whether the customer may pay via credit card.
EnableBudgetsbooleanFlag that indicates whether the customer may pay via gift card or budget.
EnableDiscountsbooleanFlag that indicates whether the customer may apply discount codes to orders.
ForcePasswordResetbooleanFlag that indicates whether the customer is required to reset their password at their next login attempt.
AllowBillingAddressManagementbooleanFlag that indicates whether the customer may add, edit, and delete billing addresses.
AllowShippingAddressManagementbooleanFlag that indicates whether the customer may add, edit, and delete shipping addresses.
BillingAddresses (via $expand)CustomerBillingAddress arrayThe collection of billing addresses for the customer.
ShippingAddresses (via $expand)CustomerShippingAddress arrayThe collection of shipping addresses for the customer.