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 Relationships API

The Custom Relationships API from Elastic Path — 2 operation(s) for custom relationships.

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

This API exposes 5 operations across 2 paths, and defines 9 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 9 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 Relationships 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 Relationships 5
POST
/pcm/custom-relationships
Create a custom relationship
createCustomRelationship body → 201422500
GET
/pcm/custom-relationships
Get all custom relationships
getCustomRelationships 3 params → 200400500
PUT
/pcm/custom-relationships/{customRelationshipSlug}
Update a custom relationship
updateCustomRelationship 1 param body → 200403404422500
GET
/pcm/custom-relationships/{customRelationshipSlug}
Get a custom relationship
getCustomRelationship 1 param → 200400404500
DELETE
/pcm/custom-relationships/{customRelationshipSlug}
Delete a custom relationship
deleteCustomRelationship 1 param → 204400403404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are req_attributes_custom_relationship (7 properties), custom_relationship (4 properties), multi_links_cr (4 properties), multi_custom_relationships (3 properties). Each schema is shown below with its type and property counts.

multi_links_cr
object
Links are used to allow you to move between requests.
4 properties
custom_relationship
object
4 properties 4 required
error
object
1 property 1 required
update_custom_relationship
object
1 property 1 required
req_attributes_custom_relationship
object
7 properties 2 required
multi_meta
object
1 property
create_custom_relationship
object
1 property 1 required
single_custom_relationship
object
1 property 1 required
multi_custom_relationships
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-custom-relationships-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