Associates

note

Account Management API is now deprecated and we recommend that you use Account Management functionality built into Elastic Path Commerce 8.2 and later.

The associates resource family is responsible for creating, viewing, and editing the list of associates.

Search Associates

Retrieve all associates matching the keywords in the search criteria, submitted using the associatesearchform.

Workflow

1. Start with root
2. GET the link with rel: searches
3. GET the link with rel: associatesearchform
4. Fill out the form.
5. POST the form using the link with rel: associatesearchaction

Read List Of Associates

Retrieve the full paginated list of associates.

Workflow

1. Start with root
2. GET the link with rel: associates
3. Render the response.

Read An Associate

Retrieve the details for an associate.

Workflow

1. Start with associates-search-results
2. GET the link with rel: element
3. Render the response.

Response Fields

Type: elasticpath.associates.associate

Name	Description	Type
name	Associate’s name.	string

Read Associate Primary Email

Read the associate’s primary-email.

Workflow

1. Start with associate
2. GET the link with rel: primaryemail
3. Render the response.

Response Fields

Type: emails.email

Name	Description	Type
email	The email address.	string

Add New Associate

Add an associate to the system. You may want to add an associate to the system before assigning them to an account. However, it is not mandatory.

Workflow

1. Start with root
2. GET the link with rel: associates
3. GET the link with rel: associateform
4. Fill out the form.
5. POST the form using the link with rel: addassociateaction

Add Associate To Account

Add an associate to an account and give them a role.

Workflow

1. Start with account
2. GET the link with rel: associateroleassignments
3. GET the link with rel: associateform
4. Fill out the form.
5. POST the form using the link with rel: addassociateaction

Read Associates For An Account

Retrieve list of associates for an account.

Workflow

1. Start with account
2. GET the link with rel: associateroleassignments
3. Render the response.

Read An Associate Roles For Account

Retrieve an associate and their role info on an account.

Workflow

1. Start with associates-for-account
2. GET the link with rel: element
3. Render the response.

Read List Of Associate Roles

Retrieve the list of roles an associate has on an account.

Workflow

1. Start with associate-roles-for-account
2. GET the link with rel: roleinfo
3. GET the link with rel: roles
4. Render the response.

Select A Role For Associate

Select a role for an associate on an account.

Workflow

1. Start with associate-roles-for-account
2. GET the link with rel: roleinfo
3. GET the link with rel: selector
4. GET the link with rel: choice
5. Render the response.

Delete Associate From Account

Remove an associate and all their roles from an account.

Workflow

1. Start with associates-for-account
2. DELETE associates-for-account