Account Management API Documentation

Resource Reference Guide

B2B Resource Reference Guide

B2B Cortex resources model the fundamental aspects of B2B ecommerce with each resource encapsulating a single part of the B2B ecommerce process. For example, Cortex has resources for: associates, organizations, divisions and more that are listed below.

Resources are linked together with other related resources into workflows that can be used to perform an action. For example, the workflow to create a new associate for a buyer organization involves retrieving the organization, and then following the associates link to the associateform. “associateform” is used to create the new associate for that specific organization. By following these workflows, you can perform actions such as add an organization, add a division, perform a search and so on.


associates

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. Read link following rel: searches.
  3. Read link following rel: associatesearchform.
  4. Fill out the form.
  5. Create form to link rel: associatesearchaction.

Read List Of Associates

Retrieve the full paginated list of associates.

Workflow

  1. Start with root
  2. Read link following rel: associates.
  3. Render response.

Response Fields

Read An Associate

Retrieve the details for an associate.

Workflow

  1. Start with associates-search-results
  2. Read link following rel: element.
  3. Render response.

Response Fields

Type: elasticpath.associates.associate
NameDescriptionType
"name":

Associate's name.

string

Read Associate Primary Email

Read the associate's primary-email.

Workflow

  1. Start with associate
  2. Read link following rel: primaryemail.
  3. Render response.

Response Fields

Type: emails.email
NameDescriptionType
"email":

The email address.

string

Add New Associate

Add an associate to the system. You may want to add an associate to the system before assigning them to a division or an organization. However, it is not mandatory.

Workflow

  1. Start with root
  2. Read link following rel: associates.
  3. Read link following rel: associateform.
  4. Fill out the form.
  5. Create form to link rel: addassociateaction.

Add Associate To Organization

Add an associate to an organization. You may want to add an associate to an organization before assigning them to a division and giving them a role to perform actions on behalf of that division. However, it is not mandatory. When you add an associate to an organization they are also added to the system list.

Workflow

  1. Start with organization
  2. Read link following rel: associates.
  3. Read link following rel: associateform.
  4. Fill out the form.
  5. Create form to link rel: addassociateaction.

Add Associate To Division

Add an associate to a division and give them a role. When you add an associate to a division they are also added to both the organization's associates and to the system list.

Workflow

  1. Start with division
  2. Read link following rel: associates.
  3. Read link following rel: associateform.
  4. Fill out the form.
  5. Create form to link rel: addassociateaction.

authorizationcontexts

The authorizationcontexts resource family provides associates the means to be able to view and access the stores and divisions they can login for. Authorization context is the context which the associate would login from, for example the store. Authorization profile is the profile which the associate logs in on behalf of, for example the division.

Read List Of Authorization Contexts

Retrieve the list of authorization contexts an associate has access to. Authorization contexts are the stores an associate has access to.

Workflow

  1. Start with root
  2. Read link following rel: authorizationcontexts.
  3. Render response.

Response Fields

Read An Authorization Context

Retrieve the details for an authorization context. An authorization context represents a store.

Workflow

  1. Start with authorization-contexts
  2. Read link following rel: element.
  3. Render response.

Response Fields

Type: elasticpath.authorizationcontexts.authorization-context
NameDescriptionType
"name":

Name of the authorization context.

string

Read An Authorization Profile

Retrieve the details for an authorization profile. An authorization profile represents the division an associate can login on behalf of.

Workflow

  1. Start with authorization-context
  2. Read link following rel: element.
  3. Render response.

Response Fields

Type: elasticpath.authorizationcontexts.authorization-profile
NameDescriptionType
"name":

Name of the authorization profile. This name is used by the user to select an authorization profile.

string

Create Access Token

Retrieve the token used to authorize an associate who is part of a buying organization.

Workflow

  1. Start with authorization-profile
  2. Read link following rel: accesstokenform.
  3. Fill out the form.
  4. Create form to link rel: createaccesstokenaction.

divisions

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

  1. Start with organization
  2. Read link following rel: divisions.
  3. Render response.

Response Fields

Read A Division

Retrieve the details for a division.

Workflow

  1. Start with divisions
  2. Read link following rel: element.
  3. Render response.

Response Fields

Type: elasticpath.divisions.division
NameDescriptionType
"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

  1. Start with division
  2. Read link following rel: associates.
  3. Render response.

Response Fields

Read List Of Subdivisions

Retrieve the list of sub divisions.

Workflow

  1. Start with division
  2. Read link following rel: subdivisions.
  3. Render response.

Response Fields

Read A Subdivision

Retrieve the details for a subdivision.

Workflow

  1. Start with subdivisions
  2. Read link following rel: element.
  3. Render response.

Response Fields

Type: elasticpath.divisions.division
NameDescriptionType
"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

  1. Start with subdivisions
  2. Read link following rel: adddivisionform.
  3. Fill out the form.
  4. Create form to link rel: adddivisionaction.

Update A Division

Update the division details for a division.

Workflow

  1. Start with division
  2. Edit the division object with new detail(s).
  3. Update division.

organizations

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

  1. Start with root
  2. Read link following rel: searches.
  3. Read link following rel: organizationsearchform.
  4. Fill out the form.
  5. Create form to link rel: organizationsearchaction.

Read Organizations

Retrieve the full paginated list of organizations.

Workflow

  1. Start with root
  2. Read link following rel: organizations.
  3. Render response.

Response Fields

Create New Organization

Create a new organization.

Workflow

  1. Start with organizations
  2. Read link following rel: organizationform.
  3. Fill out the form.
  4. Create form to link rel: createorganizationaction.

Read Organization

Retrieve the details for an organization.

Workflow

  1. Start with organizations-search-results
  2. Read link following rel: element.
  3. Render response.

Response Fields

Type: elasticpath.organizations.organization
NameDescriptionType
"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 Organization

Update the details for an organization.

Workflow

  1. Start with organization
  2. Edit the organization object with new detail(s).
  3. Update organization.

Read Associates For An Organization

View the list of associates belonging to an organization.

Workflow

  1. Start with organization
  2. Read link following rel: associates.
  3. Render response.

Response Fields

Read Organization Status

Retrieve the organization's status.

Workflow

  1. Start with organization
  2. Read link following rel: statusinfo.
  3. Read link following rel: status.
  4. Render response.

Response Fields

Type: elasticpath.organizations.organization-status
NameDescriptionType
"status":

The buyer organization's account status: enabled/disabled

string

Select Organization Status

Select an organization status.

Workflow

  1. Start with organization
  2. Read link following rel: statusinfo.
  3. Read link following rel: selector.
  4. Read link following rel: choice.
  5. Create choice to link rel: selectaction.

profiles

The profiles resource provides access to the currently logged in user and their details.

Read My Profile

Retrieve the details of the currently logged in user.

Workflow

  1. Start with root
  2. Read link following rel: myprofile.
  3. Render response.

Response Fields

Type: profiles.profile
NameDescriptionType
"name":

User's name.

string