How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Custom APIs API

Custom APIs allow you to extend the capabilities of Commerce. With Custom APIs, you can efficiently manage large data sets while benefiting from both simple and complex multidimensional filtering options. Combining Custom APIs with [Composer](/docs/composer/index) enables you to deploy custom behaviors and integrations, allowing you to implement capabilities unique to your business without having to build and host that functionality from scratch.A Custom API is composed of one or more [Custom Fields](/docs/api/commerce-extensions/custom-fields) and allows you to create [Entries](/docs/api/commerce-extensions/custom-api-entries). In database terms, a Custom API can be thought of as a table, with fields representing the columns of the table, and entries serving as the database records.## Custom APIs vs Non-Core FlowsCustom APIs are the next generation of Non-Core Flows. Here is a comparison of current features of Non-Core Flows and Custom APIs. This will be updated as we release more capabilities.| Feature | Non-Core Flows | Commerce Extensions ||---------------------------------------------------------------------------------------------------------------------------|----------------|----------------------------------------------------------------|| Build new APIs | ✅ | ✅ || Access Level | Implicit | [Customizable](/docs/api/permissions/custom-api-role-policies) || [Filtering](/docs/api/commerce-extensions/list-custom-api-entries#filtering) | ⛔️ | ✅ || [Sorting](/docs/api/commerce-extensions/list-custom-api-entries#sorting) | ⛔️ | ✅ || [Events](/docs/api/commerce-extensions/custom-api-entries#events) | ⛔️ | ✅ || [Conditional Updates](/guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource#conditional-updates) | ⛔️ | ✅ |The [Custom Fields Overview](/docs/api/commerce-extensions/custom-fields) lists the comparison of different types and validation available in Custom APIs vs Non-Core Flows.

Elastic Path Custom APIs 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 Custom APIs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 26.0608.7722088.

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

6 operations 3 paths 8 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 6

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

Custom APIs 6

Custom APIs allow you to extend the capabilities of Commerce. With Custom APIs, you can efficiently manage large data sets while benefiting from both simple and complex multidimen…

POST
/v2/settings/extensions/custom-apis
Create a Custom API
CreateACustomAPI body → 201400409500
GET
/v2/settings/extensions/custom-apis
List Custom APIs
ListCustomAPIs 4 params → 200400500
GET
/v2/settings/extensions/custom-apis/{custom-api-id}
Get a Custom API
GetACustomApi 1 param → 200400404500
PUT
/v2/settings/extensions/custom-apis/{custom-api-id}
Update a Custom API
UpdateACustomApi 1 param body → 200400404409500
DELETE
/v2/settings/extensions/custom-apis/{custom-api-id}
Delete a Custom API
DeleteACustomApi 1 param → 204400404500
GET
/v2/settings/extensions/specifications/openapi
Get OpenAPI Specification
GetOpenAPISpecification → 200400500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CustomAPI (11 properties), PaginationLinks (5 properties), PaginationMeta (2 properties), Timestamps (2 properties). Each schema is shown below with its type and property counts.

LinkURI
stringnull
PaginationLinks
object
5 properties
CustomAPI
object
11 properties
PaginationMeta
object
2 properties
Errors
object
1 property 1 required
Meta
object
1 property
CustomAPIRelationships
object
1 property
Timestamps
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-custom-apis-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 Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API
Where this information came from

This is an independent, third-party profile of Elastic Path Custom APIs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.