Accounts

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.

With the accounts resource family, the seller administrators can create, view, and edit account structures to model organization hierarchy.

Search Accounts

Retrieve all accounts that match the keywords in the search criteria, submitted using the accountsearchform.

Workflow

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

Read An Account

Retrieve the details for an account.

Workflow

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

Response Fields

Type: elasticpath.accounts.account

Name	Description	Type
external-id	The external ID corresponds to an ID on an external service.	string
name	The name of the account.	string
legal-name	The legal name of the account.	string
registration-id	The registration id of the account.	string

Read Associates for an Account

Retrieve the list of associates assigned to the account.

Workflow

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

Read List of Subaccounts

Retrieve the list of sub accounts.

Workflow

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

Read A Subaccount

Retrieve the details for a sub-account.

Workflow

1. Start with subaccounts
2. GET the link with rel: element
3. Render the response.

Response Fields

Type: elasticpath.accounts.account

Name	Description	Type
external-id	The external ID corresponds to an ID on an external service.	string
name	The name of the account.	string
legal-name	The legal name of the account.	string
registration-id	The registration id of the account.	string

Add New Account

Add a new account.

Workflow

1. Start with subaccounts
2. GET the link with rel: accountform
3. Fill out the form.
4. POST the form using the link with rel: addaccountaction

Update An Account

Update the account details for an account.

Workflow

1. Start with account
2. Edit the account object with new detail(s).
3. Update account using a PUT request.

Read Account Status

Retrieve the account’s status.

Workflow

1. Start with account
2. GET the link with rel: statusinfo
3. GET the link with rel: status
4. Render the response.

Response Fields

Type: elasticpath.accounts.account-status

Name	Description	Type
status	The buyer account’s account status: enabled/disabled	string

Select Account Status

Select an account status.

Workflow

1. Start with account
2. GET the link with rel: statusinfo
3. GET the link with rel: selector
4. GET the link with rel: choice
5. POST the choice using the link with rel: selectaction