Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Accounts API

An Account represents the entity that participates in a Commerce transaction. Accounts can have Carts, Orders, Subscriptions, and Addresses.

Elastic Path Accounts API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Accounts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

8 operations 3 paths 15 schemas 2 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Accounts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 8

Across 3 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Accounts 8

An Account represents the entity that participates in a Commerce transaction. Accounts can have Carts, Orders, Subscriptions, and Addresses.

POST
/v2/accounts
Create an Account
post-v2-accounts body → 201400404409422500
GET
/v2/accounts
Get All Accounts
get-v2-accounts 4 params → 200400401500
GET
/v2/accounts/{accountID}
Get an Account
get-v2-accounts-accountID 1 param → 200404500
PUT
/v2/accounts/{accountID}
Update an Account
put-v2-accounts-accountID 1 param body → 200400404409500
DELETE
/v2/accounts/{accountID}
Delete an Account
delete-v2-accounts-accountID 1 param → 204404500
GET
/v2/accounts/{accountID}/relationships/account-tags
Get an Account's Tags Relationship
GetAnAccountTagsRelationship 1 param → 200404500
POST
/v2/accounts/{accountID}/relationships/account-tags
Add Account Tags
AddAccountTagsOnAccount 1 param body → 200400404409500
DELETE
/v2/accounts/{accountID}/relationships/account-tags
Remove Account Tags
RemoveAccountTagsOnAccount 1 param body → 200400404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Account (5 properties), MetaListPage (4 properties), Error (3 properties), AccountTagsRelationshipResponse (2 properties). Each schema is shown below with its type and property counts.

ReadOnlyParentId
object
1 property
Error
object
3 properties 2 required
MetaListPage
object
4 properties
ErrorResponse
object
1 property 1 required
MetaTimestamps
object
1 property
RemoveAccountTagsOnAccount
object
1 property
WritableParentId
object
1 property
AccountResponse
AddAccountTagsOnAccount
object
1 property
UUID
string
The unique identifier.
MetaList
object
2 properties
AccountTagsRelationshipIdentifier
object
2 properties
MetaListResults
object
1 property
Account
object
5 properties 2 required
AccountTagsRelationshipResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-accounts-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API
Elastic Path Authentication Realms API