GET
Retrieve addresses by conditions

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Address>[] array
Sample response
[{"addressFields":[{"id":"integer","value":"string","addressField":"<XLite\\Model\\AddressField>","address":"<XLite\\Model\\Address>"}],"is_billing":true,"is_shipping":false,"isWork":true,"profile":{"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"},"address_id":56,"address_type":"example","state":{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"},"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"}}]

GET
Retrieve address by id

id
integer Required
Id value of the Address object
default Success <XLite\Model\Address>
Sample response
{"addressFields":[{"id":"integer","value":"string","addressField":"<XLite\\Model\\AddressField>","address":"<XLite\\Model\\Address>"}],"is_billing":true,"is_shipping":false,"isWork":true,"profile":{"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"},"address_id":56,"address_type":"example","state":{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"},"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"}}
addressFields
[] array
Address fields collection
is_billing
boolean
Flag: is it a billing address
is_shipping
boolean
Flag: is it a shipping address
isWork
boolean
Flag: is it a work address
profile
address_id
integer
Unique id
address_type
string
Address type: residential/commercial
state
country

PUT
Update address by id

id
integer Required
Id value of the Address object
<XLite\Model\Address>
addressFields
[] array
Address fields collection
is_billing
boolean
Flag: is it a billing address
is_shipping
boolean
Flag: is it a shipping address
isWork
boolean
Flag: is it a work address
profile
address_id
integer
Unique id
address_type
string
Address type: residential/commercial
state
country
default Success <XLite\Model\Address>
Sample response
{"addressFields":[{"id":"integer","value":"string","addressField":"<XLite\\Model\\AddressField>","address":"<XLite\\Model\\Address>"}],"is_billing":true,"is_shipping":false,"isWork":true,"profile":{"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"},"address_id":56,"address_type":"example","state":{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"},"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"}}
addressFields
[] array
Address fields collection
is_billing
boolean
Flag: is it a billing address
is_shipping
boolean
Flag: is it a shipping address
isWork
boolean
Flag: is it a work address
profile
address_id
integer
Unique id
address_type
string
Address type: residential/commercial
state
country

DELETE
Delete address by id

id
integer Required
Id value of the Address object
default Success <XLite\Model\Address>
Sample response
{"addressFields":[{"id":"integer","value":"string","addressField":"<XLite\\Model\\AddressField>","address":"<XLite\\Model\\Address>"}],"is_billing":true,"is_shipping":false,"isWork":true,"profile":{"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"},"address_id":56,"address_type":"example","state":{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"},"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"}}
addressFields
[] array
Address fields collection
is_billing
boolean
Flag: is it a billing address
is_shipping
boolean
Flag: is it a shipping address
isWork
boolean
Flag: is it a work address
profile
address_id
integer
Unique id
address_type
string
Address type: residential/commercial
state
country

POST
Add new address

<XLite\Model\Address>
addressFields
[] array
Address fields collection
is_billing
boolean
Flag: is it a billing address
is_shipping
boolean
Flag: is it a shipping address
isWork
boolean
Flag: is it a work address
profile
address_id
integer
Unique id
address_type
string
Address type: residential/commercial
state
country
default Success <XLite\Model\Address>
Sample response
{"addressFields":[{"id":"integer","value":"string","addressField":"<XLite\\Model\\AddressField>","address":"<XLite\\Model\\Address>"}],"is_billing":true,"is_shipping":false,"isWork":true,"profile":{"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"},"address_id":56,"address_type":"example","state":{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"},"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"}}
addressFields
[] array
Address fields collection
is_billing
boolean
Flag: is it a billing address
is_shipping
boolean
Flag: is it a shipping address
isWork
boolean
Flag: is it a work address
profile
address_id
integer
Unique id
address_type
string
Address type: residential/commercial
state
country