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

Request Fields

Type: associates.keyword-search

Name	Description	Type
keywords	Search keywords.	string
page	The page of the search result to go to.	integer
page-size	Defines the number of search results to list per page. This field is optional. If the field is not specified, Cortex API’s default page-size value is used, which can differ depending on your implementation.	integer

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	The name of the associate.	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

Read Associate Attributes

The associate attributes resource provides access to the read-only details of the associate.

Workflow

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

Response Fields

Type: elasticpath.associates.associate-attributes

Name	Description	Type
guid	A globally unique identifier for the associate.	string
oidc-issuer	The OpenID Connect Issuer Identifier currently assigned to the user. A null value for this parameter indicates that the user has not logged in yet.	string
oidc-subject	The OpenID Connect Subject Identifier. A null value for this parameter means that the user has not logged in yet.	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

Request Fields

Type: elasticpath.associates.new-associate

Name	Description	Type
associate-id	Associate’s email.	string

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

Request Fields

Type: elasticpath.associates.add-to-account-form

Name	Description	Type
associate-id	An email for an associate.	string
roles	The roles of an associate in the account.	array

Read Add Associates To Accounts Form

Get the form for adding associates to accounts that contains example values for the fields on the form. This workflow also supports the retrieval of a template, which is a Comma Separated Values (CSV) file, containing the example values. To get the CSV template, send a request to the form with the header Accept: text/csv. The response contains the header Content-Disposition: attachment; filename="associates.csv".

Workflow

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

Response Fields

Type: elasticpath.associates.add-associates-form

Name	Description	Type
associates	The associates to add to accounts.	array
account-name	The name of the account to add the associate.	string
associate-id	The id of the associate to add.	string
roles	The roles of the associate in the account.	string

Add Associates To Accounts

Add associates to accounts and assign them roles. This workflow also supports the use of a Comma Separated Values (CSV) file to add associates to accounts. Send a request to the form with the header Content-Type: multipart/form-data and form data that has associates as the key and the CSV file as the value. Set the form data with the Content-Type text/csv.

Workflow

1. Start with accounts-search-results
2. GET the link with rel: addassociatesform
3. Fill out the form
4. POST the form using the link with rel: addassociatesaction

Request Fields

Type: elasticpath.associates.add-associates-form

Name	Description	Type
associates	The associates to add to accounts.	array
account-name	The name of the account to add the associate.	string
associate-id	The id of the associate to add.	string
roles	The roles of the associate in the account.	string

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