Divisions
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 divisions
resource family provides Seller Admins the ability to create, view, and edit division structures in order to model organizations’ hierarchy.
Read List Of Divisions
Retrieve the list of root divisions
Workflow
- Start with organization
- Read link following rel:
divisions
- Render response
Read A Division
Retrieve the details of a division.
Workflow
- Start with division
- 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 division | String |
Read Associates For A Division
View the list of associates belonging to a division.
Workflow
- Start with division
- Read link following rel:
associates
- Render response
Read List Of Subdivisions
Retrieve the list of sub divisions.
Workflow
- Start with division
- Read link following rel:
subdivisions
- Render response
Read A Subdivision
Retrieve the details for a subdivision.
Workflow
- Start with subdivisions
- 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 division | String |
Add New Division
Add a new division.
Workflow
- Start with subdivisions
- Read link following rel:
adddivisionform
- Fill out the form
- Create form to link rel:
adddivisionaction
Update A Division
Update the division details for a division.
Workflow
- Start with division
- Edit the division object with new detail(s)
- Update division