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 Custom API Entries API

A **Custom API Entry** is a specific instance of a resource, such as a single wishlist in a Custom API for wishlists.Custom API Entries can be accessed in two different ways, via the **extension** endpoint, or the **settings** endpoint:* Extension Endpoint: `/v2/extensions/{custom-api-slug}` - This is the primary endpoint created for use. Most clients should use this endpoint as it adheres to the semantics of the configuration. Retrieve the [OpenAPI Specifications](/docs/api/commerce-extensions/get-open-api-specification) to learn how to interact with this endpoint.* Settings Endpoint: `/v2/settings/extensions/custom-apis/{custom-api-id}/entries/` - This endpoint should only be used in cases where you want to interact with your Custom APIs in a generic way in an admin capacity.Currently, the distinction between these endpoints is minimal. The extension endpoint uses a slug in the URL path, and the settings endpoint uses an ID. For most use cases involving the new Custom API, we recommend using the extension endpoint.Conceptually, the settings endpoint is analogous to reflection in most programming languages. You use it when you want to operate in a generic way. For example, we used the settings endpoint to build Commerce Manager. Another example is if you need to import and export various types of data from CSV files. Instead of writing multiple scripts for different extension endpoints, you can write one script that operates on the settings endpoint.## EventsYou can integrate Commerce Extensions with your external systems by observing the appropriate events. For more information, see [Integrations](/docs/api/integrations/integrations-introduction).Given you have a Custom API with `api_type` of `wishlist_ext` and you want to perform additional processing when an action is taken, like when a wishlist is created:```bashcurl -X POST https://useast.api.elasticpath.com/v2/extensions/wishlists \ -H "Authorization: Bearer XXXX" \ -H "Content-Type: application/json" \ -d $ { "data": { "type": "wishlist_ext", "name": "My Wishlist", "items_count": 0, "keep_purchased": false } }```When you [create an integration](/docs/api/integrations/create-integration) with `wishlist_ext.created` in `observes` field.Then the configured `webhook` or `aws_sqs` will receive the appropriate message.You can configure integrations to observe the following events for your Custom API Entries:* Created* Updated* Deleted

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

This API exposes 5 operations across 2 paths, and defines 7 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.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 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 Custom API Entries API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

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

Custom API Entries 5

A Custom API Entry is a specific instance of a resource, such as a single wishlist in a Custom API for wishlists. Custom API Entries can be accessed in two different ways, via the…

POST
/v2/settings/extensions/custom-apis/{custom-api-id}/entries
Create a Custom API Entry
CreateACustomAPIEntry 1 param body → 201400403409413500503
GET
/v2/settings/extensions/custom-apis/{custom-api-id}/entries
List Custom API Entries
ListCustomAPIEntries 7 params → 200400403422500
GET
/v2/settings/extensions/custom-apis/{custom-api-id}/entries/{custom-api-entry-id}
Get a Custom API Entry
GetACustomEntry 2 params → 200400403404500
PUT
/v2/settings/extensions/custom-apis/{custom-api-id}/entries/{custom-api-entry-id}
Update a Custom API Entry
UpdateACustomEntry 3 params body → 200201400403404409412413
DELETE
/v2/settings/extensions/custom-apis/{custom-api-id}/entries/{custom-api-entry-id}
Delete a Custom API Entry
DeleteACustomEntry 3 params → 204400403404412500503

Schemas 7

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

Timestamps
object
2 properties
Meta
object
1 property
Errors
object
1 property 1 required
LinkURI
stringnull
CustomAPIEntry
object
4 properties
PaginationMeta
object
2 properties
PaginationLinks
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-custom-api-entries-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