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

Products are the items or services that you might want to sell in your store. In Product Experience Manager, products can also have associated rich media assets, such as product images or a file containing additional product details.You can do this using [Files API](/docs/api/pxm/files).Once you have created your files, you associate files with your products using the [Create Product Main Image Relationships API](/docs/api/pxm/products/create-product-main-image-relationships).

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

This API exposes 4 operations across 1 path, and defines 4 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.

4 operations 1 paths 4 schemas 1 DELETE1 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 Product Image Relationships API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 4

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

Product Image Relationships 4

Products are the items or services that you might want to sell in your store. In Product Experience Manager, products can also have associated rich media assets, such as product i…

POST
/pcm/products/{productID}/relationships/main_image
Create main image relationships
createProductMainImageRelationships 1 param body → 204400403404409422500
GET
/pcm/products/{productID}/relationships/main_image
Get Main Image Relationships
getProductMainImageRelationships 1 param → 200400403404409422500
PUT
/pcm/products/{productID}/relationships/main_image
Replace Main Image Relationships
updateProductMainImageRelationships 1 param body → 204400403404409422500
DELETE
/pcm/products/{productID}/relationships/main_image
Delete Main Image Relationships
deleteProductMainImageRelationships 1 param → 204400403404409422500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are main_image_response (1 property), replace_main_image_request (1 property), main_image_request (1 property), error (1 property). Each schema is shown below with its type and property counts.

error
object
1 property 1 required
main_image_request
object
1 property
replace_main_image_request
object
1 property
main_image_response
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-product-image-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