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, 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

Request Fields

Type: accounts.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

Lookup Accounts

Look up an account by the external id.

Workflow

1. Start with lookups
2. GET the link with rel: accountlookupform
3. Fill out the form
4. POST the form using the link with rel: accountlookupaction

Request Fields

Type: accounts.account-lookup

Name	Description	Type
external-id	The external-id.	string

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
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 Account Metadata

Retrieve the account metadata only visible to seller admins.

Workflow

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

Response Fields

Type: elasticpath.accounts.account-metadata

Name	Description	Type
external-id	The external ID for an account corresponds to an ID on an external service that the seller might use to enable integrations. this is internal to the seller organization and has no meaning for a buyer organization.	string

Read Account Attributes

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

Workflow

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

Response Fields

Type: elasticpath.accounts.account-attributes

Name	Description	Type
guid	A globally unique identifier for 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
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 as a buyer admin.

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

Request Fields

Type: elasticpath.accounts.account

Name	Description	Type
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 With Metadata

Add a new account as a seller admin.

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

Request Fields

Type: elasticpath.accounts.account-with-metadata

Name	Description	Type
external-id	An ID on an external service that the seller might use to enable integrations, such as an Enterprise Resource Planning service. This information is accessible only to the seller organization.	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

Update An Account

Update the account details for an account.

Workflow

1. Start with account
2. Edit the account object with new details
3. Update account using a PUT request

Update Account Metadata

Update the account metadata for an account. Only available to seller admins

Workflow

1. Start with account-metadata
2. Edit the account-metadata object with new details
3. Update account-metadata 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 status of the buyer account. The options are, enabled or 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