Organizations
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 organizations resource family provides Seller Admins the ability to create, view, and edit organizations.
Search Organizations
Retrieve all organizations matching the keywords in the search criteria, submitted using the organizationsearchform.
Workflow
- Start with root
- Read link following rel:
searches - Read link following rel:
organizationsearchform - Fill out the form
- Create form to link rel:
organizationsearchaction
Read List of Organizations
Retrieve the full paginated list of organizations.
Workflow
- Start with root
- Read link following rel:
organizations - Render response
Create New Organization
Creates a new organization.
Workflow
- Start with organizations
- Read link following rel:
organizationform - Fill out the form
- Create form to link rel:
createorganizationaction
Read an Organization
Retrieve the details for an organization.
Workflow
- Start with organizations-search-results
- Read link following rel:
element - Render response
Response Fields
| Name | Description | Type |
|---|---|---|
external-id | The external id corresponds to an id on an external service | String |
name | Name of the organization | String |
legal-name | Legal Name of the organization | String |
registration-id | Registration id of the organization | String |
Update an Organization
Updates the details for an organization.
Workflow
- Start with organization
- Edit the organization object with new detail(s)
- Update organization
Read Associates For An Organization
View the list of associates belonging to an organization.
Workflow
- Start with organization
- Read link following rel:
associates - Render response
Read Organization Status
Retrieve the organization’s status.
Workflow
- Start with organization
- Read link following rel:
statusinfo - Read link following rel:
status - Render response
Response Fields
| Name | Description | Type |
|---|---|---|
status | The buyer organization’s account status: enabled/disabled | String |
Select Organization Status
Select an organization status
Workflow
- Start with organization
- Read link following rel:
statusinfo - Read link following rel:
selector - Read link following rel:
choice - Create choice to link rel:
selectaction