GET
Retrieve profiles by conditions

_cnd[anonymous]
boolean 
Shows only anonymous (true) or registered (false) user profiles
_cnd[orderId]
integer 
Filters profiles by order id
_cnd[referer]
string 
Filters profiles by referer
_cnd[membership]
integer 
Filters profiles by membership id
_cnd[roles]
integer 
Filters profiles by role(s)
_cnd[permissions]
string 
Filters profiles by available permission code(s)
_cnd[language]
string 
Filters profiles by language
_cnd[pattern]
string 
Filters profiles by name or email substring
_cnd[phone]
string 
Filters profiles by phone number
_cnd[login]
string 
Filters profiles by email (OR clause)
_cnd[andLogin]
string 
Filters profiles by email (AND clause)
_cnd[state]
string 
Filters profiles by state id (for countries with states)
_cnd[customState]
string 
Filters profiles by custom state name
_cnd[address]
string 
Filters profiles by address id
_cnd[userType]
string 
Filters profiles by user type
_cnd[onlyReal]
boolean 
Exclude profile copies (snapshots for certain order)
_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Profile>[] array
Sample response
[{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"}]

GET
Retrieve profile by id

id
integer Required
Id value of the Profile object
default Success <XLite\Model\Profile>
Sample response
{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"}
socialLoginProvider
string
Auth provider (amazon)
socialLoginId
string
Auth provider-unique user id (for ex. facebook user id)
gaClientId
string
Google analytics cid
conciergeUserId
string
mail_chimp_lists
[] array
MailChimp lists
mail_chimp_interests
[] array
MailChimp lists
mail_chimp_segments
[] array
MailChimp segments
conversations
[] array
Coupons
profile_id
integer
Profile unique ID
login
string
Login (e-mail)
password
string
Password
password_hint
string
Password hint
password_hint_answer
string
Password hint answer
passwordResetKey
string
Password reset key (for 'Forgot password')
passwordResetKeyDate
integer
Timestamp of reset key creation date
access_level
integer
Access level
cms_profile_id
integer
CMS profile Id
cms_name
string
CMS name
added
integer
Timestamp of profile creation date
first_login
integer
Timestamp of first login event
last_login
integer
Timestamp of last login event
status
string
Profile status
statusComment
string
Status comment (reason)
referer
string
Referer
order
event
[] array
Relation to an event
language
string
Language code
last_shipping_id
integer
Last selected shipping id
last_payment_id
integer
Last selected payment id
membership
Membership: many-to-one relation with memberships table
pending_membership
Pending membership: many-to-one relation with memberships table
addresses
[] array
Address book: one-to-many relation with address book entity
roles
[] array
Roles
anonymous
boolean
Flag of anonymous profile (used for checkout process only)
forceChangePassword
boolean
Flag if the user needs to change the password. The customers only
dateOfLoginAttempt
integer
Date of last login attempt
countOfLoginAttempts
integer
Count of login attempt
searchFakeField
string
Fake field for search
xcPendingExport
boolean
Flag to exporting entities
lastCheckoutEmail
string
Checkout email

PUT
Update profile by id

id
integer Required
Id value of the Profile object
<XLite\Model\Profile>
socialLoginProvider
string
Auth provider (amazon)
socialLoginId
string
Auth provider-unique user id (for ex. facebook user id)
gaClientId
string
Google analytics cid
conciergeUserId
string
mail_chimp_lists
[] array
MailChimp lists
mail_chimp_interests
[] array
MailChimp lists
mail_chimp_segments
[] array
MailChimp segments
conversations
[] array
Coupons
profile_id
integer
Profile unique ID
login
string
Login (e-mail)
password
string
Password
password_hint
string
Password hint
password_hint_answer
string
Password hint answer
passwordResetKey
string
Password reset key (for 'Forgot password')
passwordResetKeyDate
integer
Timestamp of reset key creation date
access_level
integer
Access level
cms_profile_id
integer
CMS profile Id
cms_name
string
CMS name
added
integer
Timestamp of profile creation date
first_login
integer
Timestamp of first login event
last_login
integer
Timestamp of last login event
status
string
Profile status
statusComment
string
Status comment (reason)
referer
string
Referer
order
event
[] array
Relation to an event
language
string
Language code
last_shipping_id
integer
Last selected shipping id
last_payment_id
integer
Last selected payment id
membership
Membership: many-to-one relation with memberships table
pending_membership
Pending membership: many-to-one relation with memberships table
addresses
[] array
Address book: one-to-many relation with address book entity
roles
[] array
Roles
anonymous
boolean
Flag of anonymous profile (used for checkout process only)
forceChangePassword
boolean
Flag if the user needs to change the password. The customers only
dateOfLoginAttempt
integer
Date of last login attempt
countOfLoginAttempts
integer
Count of login attempt
searchFakeField
string
Fake field for search
xcPendingExport
boolean
Flag to exporting entities
lastCheckoutEmail
string
Checkout email
default Success <XLite\Model\Profile>
Sample response
{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"}
socialLoginProvider
string
Auth provider (amazon)
socialLoginId
string
Auth provider-unique user id (for ex. facebook user id)
gaClientId
string
Google analytics cid
conciergeUserId
string
mail_chimp_lists
[] array
MailChimp lists
mail_chimp_interests
[] array
MailChimp lists
mail_chimp_segments
[] array
MailChimp segments
conversations
[] array
Coupons
profile_id
integer
Profile unique ID
login
string
Login (e-mail)
password
string
Password
password_hint
string
Password hint
password_hint_answer
string
Password hint answer
passwordResetKey
string
Password reset key (for 'Forgot password')
passwordResetKeyDate
integer
Timestamp of reset key creation date
access_level
integer
Access level
cms_profile_id
integer
CMS profile Id
cms_name
string
CMS name
added
integer
Timestamp of profile creation date
first_login
integer
Timestamp of first login event
last_login
integer
Timestamp of last login event
status
string
Profile status
statusComment
string
Status comment (reason)
referer
string
Referer
order
event
[] array
Relation to an event
language
string
Language code
last_shipping_id
integer
Last selected shipping id
last_payment_id
integer
Last selected payment id
membership
Membership: many-to-one relation with memberships table
pending_membership
Pending membership: many-to-one relation with memberships table
addresses
[] array
Address book: one-to-many relation with address book entity
roles
[] array
Roles
anonymous
boolean
Flag of anonymous profile (used for checkout process only)
forceChangePassword
boolean
Flag if the user needs to change the password. The customers only
dateOfLoginAttempt
integer
Date of last login attempt
countOfLoginAttempts
integer
Count of login attempt
searchFakeField
string
Fake field for search
xcPendingExport
boolean
Flag to exporting entities
lastCheckoutEmail
string
Checkout email

DELETE
Delete profile by id

id
integer Required
Id value of the Profile object
default Success <XLite\Model\Profile>
Sample response
{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"}
socialLoginProvider
string
Auth provider (amazon)
socialLoginId
string
Auth provider-unique user id (for ex. facebook user id)
gaClientId
string
Google analytics cid
conciergeUserId
string
mail_chimp_lists
[] array
MailChimp lists
mail_chimp_interests
[] array
MailChimp lists
mail_chimp_segments
[] array
MailChimp segments
conversations
[] array
Coupons
profile_id
integer
Profile unique ID
login
string
Login (e-mail)
password
string
Password
password_hint
string
Password hint
password_hint_answer
string
Password hint answer
passwordResetKey
string
Password reset key (for 'Forgot password')
passwordResetKeyDate
integer
Timestamp of reset key creation date
access_level
integer
Access level
cms_profile_id
integer
CMS profile Id
cms_name
string
CMS name
added
integer
Timestamp of profile creation date
first_login
integer
Timestamp of first login event
last_login
integer
Timestamp of last login event
status
string
Profile status
statusComment
string
Status comment (reason)
referer
string
Referer
order
event
[] array
Relation to an event
language
string
Language code
last_shipping_id
integer
Last selected shipping id
last_payment_id
integer
Last selected payment id
membership
Membership: many-to-one relation with memberships table
pending_membership
Pending membership: many-to-one relation with memberships table
addresses
[] array
Address book: one-to-many relation with address book entity
roles
[] array
Roles
anonymous
boolean
Flag of anonymous profile (used for checkout process only)
forceChangePassword
boolean
Flag if the user needs to change the password. The customers only
dateOfLoginAttempt
integer
Date of last login attempt
countOfLoginAttempts
integer
Count of login attempt
searchFakeField
string
Fake field for search
xcPendingExport
boolean
Flag to exporting entities
lastCheckoutEmail
string
Checkout email

POST
Add new profile

<XLite\Model\Profile>
socialLoginProvider
string
Auth provider (amazon)
socialLoginId
string
Auth provider-unique user id (for ex. facebook user id)
gaClientId
string
Google analytics cid
conciergeUserId
string
mail_chimp_lists
[] array
MailChimp lists
mail_chimp_interests
[] array
MailChimp lists
mail_chimp_segments
[] array
MailChimp segments
conversations
[] array
Coupons
profile_id
integer
Profile unique ID
login
string
Login (e-mail)
password
string
Password
password_hint
string
Password hint
password_hint_answer
string
Password hint answer
passwordResetKey
string
Password reset key (for 'Forgot password')
passwordResetKeyDate
integer
Timestamp of reset key creation date
access_level
integer
Access level
cms_profile_id
integer
CMS profile Id
cms_name
string
CMS name
added
integer
Timestamp of profile creation date
first_login
integer
Timestamp of first login event
last_login
integer
Timestamp of last login event
status
string
Profile status
statusComment
string
Status comment (reason)
referer
string
Referer
order
event
[] array
Relation to an event
language
string
Language code
last_shipping_id
integer
Last selected shipping id
last_payment_id
integer
Last selected payment id
membership
Membership: many-to-one relation with memberships table
pending_membership
Pending membership: many-to-one relation with memberships table
addresses
[] array
Address book: one-to-many relation with address book entity
roles
[] array
Roles
anonymous
boolean
Flag of anonymous profile (used for checkout process only)
forceChangePassword
boolean
Flag if the user needs to change the password. The customers only
dateOfLoginAttempt
integer
Date of last login attempt
countOfLoginAttempts
integer
Count of login attempt
searchFakeField
string
Fake field for search
xcPendingExport
boolean
Flag to exporting entities
lastCheckoutEmail
string
Checkout email
default Success <XLite\Model\Profile>
Sample response
{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"}
socialLoginProvider
string
Auth provider (amazon)
socialLoginId
string
Auth provider-unique user id (for ex. facebook user id)
gaClientId
string
Google analytics cid
conciergeUserId
string
mail_chimp_lists
[] array
MailChimp lists
mail_chimp_interests
[] array
MailChimp lists
mail_chimp_segments
[] array
MailChimp segments
conversations
[] array
Coupons
profile_id
integer
Profile unique ID
login
string
Login (e-mail)
password
string
Password
password_hint
string
Password hint
password_hint_answer
string
Password hint answer
passwordResetKey
string
Password reset key (for 'Forgot password')
passwordResetKeyDate
integer
Timestamp of reset key creation date
access_level
integer
Access level
cms_profile_id
integer
CMS profile Id
cms_name
string
CMS name
added
integer
Timestamp of profile creation date
first_login
integer
Timestamp of first login event
last_login
integer
Timestamp of last login event
status
string
Profile status
statusComment
string
Status comment (reason)
referer
string
Referer
order
event
[] array
Relation to an event
language
string
Language code
last_shipping_id
integer
Last selected shipping id
last_payment_id
integer
Last selected payment id
membership
Membership: many-to-one relation with memberships table
pending_membership
Pending membership: many-to-one relation with memberships table
addresses
[] array
Address book: one-to-many relation with address book entity
roles
[] array
Roles
anonymous
boolean
Flag of anonymous profile (used for checkout process only)
forceChangePassword
boolean
Flag if the user needs to change the password. The customers only
dateOfLoginAttempt
integer
Date of last login attempt
countOfLoginAttempts
integer
Count of login attempt
searchFakeField
string
Fake field for search
xcPendingExport
boolean
Flag to exporting entities
lastCheckoutEmail
string
Checkout email