Manage customer contacts and address book entries for a website: create, read, update, delete, and query contacts; maintain addresses for shipping and fulfillment.
List contacts
Returns a paginated list of contacts for the website. Requires OAuth website scope WEBSITE_CONTACTS_READ, WEBSITE_CONTACTS, WEBSITE_PROFILES_READ, or WEBSITE_PROFILES.
query Parameters
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
List contacts ⺠Responses
A paginated list of contacts.
paginated list of contacts retrieved
Create contact
Creates a new contact. Requires OAuth website scope WEBSITE_CONTACTS or WEBSITE_PROFILES (read/write).
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Create contact ⺠Request Body
firstNameContact's first name
lastNameContact's last name
localeContact's locale
Primary email supplied when creating a contact.
Create contact ⺠Responses
The created contact.
A contact.
Query contacts
Returns a paginated list of contacts matching filters and sort options in the request body. Requires OAuth website scope WEBSITE_CONTACTS_READ, WEBSITE_CONTACTS, WEBSITE_PROFILES_READ, or WEBSITE_PROFILES.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Query contacts ⺠Request Body
Contact's marketing settings with joined on date
cursorThe cursor for the next page of results. Use the value of pagination.nextPageCursor from the previous response.
Object for filtering by a min and max integer
Object for filtering by a min and max integer
Object for filtering by before and after dates
Object for filtering by before and after dates
Object for filtering by before and after dates
Object for filtering by before and after dates
Object for filtering by a min and max integer
Object for filtering by a min and max integer
pageSizeThe number of contacts to return per request.
searchStringSearch string for Name and Email address
sortDirectionDirection to sort results, ASCENDING or DESCENDING
sortFieldField to sort results by
Query contacts ⺠Responses
A paginated list of contacts matching the query.
paginated list of contacts retrieved
Get contact
Returns the contact for the given contact ID. Requires OAuth website scope WEBSITE_CONTACTS_READ, WEBSITE_CONTACTS, WEBSITE_PROFILES_READ, or WEBSITE_PROFILES.
path Parameters
contactIdThe contact's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Get contact ⺠Responses
The requested contact.
A contact.
Delete contact
Deletes the contact for the given contact ID. Requires OAuth website scope WEBSITE_CONTACTS or WEBSITE_PROFILES (read/write).
path Parameters
contactIdThe contact's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Delete contact ⺠Responses
No content.
Update contact
Updates a contact using JSON merge patch. Requires OAuth website scope WEBSITE_CONTACTS or WEBSITE_PROFILES (read/write).
path Parameters
contactIdThe contact's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Update contact ⺠Request Body
firstNameThe contact's first name.
lastNameThe contact's last name.
localeThe contact's locale.
Primary email fields for an update request.
Update contact ⺠Responses
The updated contact.
A contact.
Get address book
Returns all address book entries for the contact. When there is at least one entry, exactly one is the default shipping address (defaultShippingAddressId and each entry's defaultShipping reflect this). Requires OAuth website scope WEBSITE_CONTACTS_READ, WEBSITE_CONTACTS, WEBSITE_PROFILES_READ, or WEBSITE_PROFILES.
path Parameters
contactIdThe contact's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Get address book ⺠Responses
The contact's address book.
Address settings for a contact. When there is at least one address book entry, exactly one entry is always the default shipping address.
Create address book entry
Creates a new address book entry for the contact. If this is the contact's only address book entry after creation, it becomes the default shipping address even when defaultShipping is false. Requires OAuth website scope WEBSITE_CONTACTS or WEBSITE_PROFILES (read/write).
path Parameters
contactIdThe contact's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Create address book entry ⺠Request Body
Address properties for a contact.
defaultShippingWhether this entry should be the default shipping address. If this is the only address book entry for the contact after creation, it becomes the default even when set to false.
Create address book entry ⺠Responses
The created address book entry.
An address book entry for a contact.
Get address book entry
Returns a single address book entry for the contact. Requires OAuth website scope WEBSITE_CONTACTS_READ, WEBSITE_CONTACTS, WEBSITE_PROFILES_READ, or WEBSITE_PROFILES.
path Parameters
contactIdThe contact's ID.
addressBookEntryIdThe address book entry's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Get address book entry ⺠Responses
The requested address book entry.
An address book entry for a contact.
Replace address book entry
Replaces an address book entry for the contact with a full JSON body. When updating the entry that is currently the default, setting "defaultShipping" from true to false has no effect. Requires OAuth website scope WEBSITE_CONTACTS or WEBSITE_PROFILES (read/write).
path Parameters
contactIdThe contact's ID.
addressBookEntryIdThe address book entry's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Replace address book entry ⺠Request Body
Address properties for a contact.
defaultShippingWhether this entry should be the default shipping address. When updating the entry that is currently the default, changing this value from true to false has no effect.
Replace address book entry ⺠Responses
The updated address book entry.
An address book entry for a contact.
Delete address book entry
Deletes the address book entry for the contact. If the deleted entry was the default shipping address, another entry is assigned as the default. Requires OAuth website scope WEBSITE_CONTACTS or WEBSITE_PROFILES (read/write).
path Parameters
contactIdThe contact's ID.
addressBookEntryIdThe address book entry's ID.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Delete address book entry ⺠Responses
No content.