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. Read link following rel: searches
3. Read link following rel: associatesearchform
4. Fill out the form
5. Create form to link rel: associatesearchaction

Read List Of Associates

Retrieve the full paginated list of associates.

Workflow

1. Start with root
2. Read link following rel: associates
3. Render response

Read An Associate

Retrieve the details for an associate.

Workflow

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

Response Fields

Name	Description	Type
name	Associate’s name	String

Read an Associate’s Primary Email

Read or retrieve an associate’s primary-email address

Workflow

1. Start with associate
2. Read link following rel: primaryemail
3. Render response

Response Fields

Name	Description	Type
email	The email address	String

Add a New Associate

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

Workflow

1. Start with root
2. Read link following rel: associates
3. Read link following rel: associateform
4. Fill out the form
5. Create form to link rel: addassociateaction

Add Associate To Organization

Add an associate to an organization. You may want to add an associate to an organization before assigning them to a division and giving them a role to perform actions on behalf of that division. However, it is not mandatory. When you add an associate to an organization they are also added to the system list.

Workflow

1. Start with organization
2. Read link following rel: associates
3. Read link following rel: associateform
4. Fill out the form
5. Create form to link rel: addassociateaction

Add Associate To Division

Add an associate to a division and give them a role. When you add an associate to a division they are also added to both the organization’s associates and to the system list.

Workflow

1. Start with division
2. Read link following rel: associates
3. Read link following rel: associateform
4. Fill out the form
5. Create form to link rel: addassociateaction