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

You can upload image files or URLs by using `multipart/form-data` as the content type header. For example, `"Content-Type: multipart/form-data" \`. Commerce supports the following file types.| File Extension | Description || --- | --- || .gif | Graphics Interchange Format (GIF) || .jpg/jpeg | Joint Photographic Experts Group (JPEG) format || .png | Portable graphics format || .webp | Web picture format || .mp4 | Moving Picture Experts Group (MPEG) format || .mov | QuickTime Movie format || .pdf | Portable Document Format || .usdz | Universal Scene Description Format || .glb | Global File format || .jp2 | Compressed bitmap image saved in Joint Photographic Experts Group (JPEG) format || .jxr | Extended range for Joint Photographic Experts Group (JPEG) format || .aac | Advanced Audio Coding (AAC) format || .vrml | Virtual Reality Modelling Language (VRML) format || .doc(x) | Microsoft Word Open XML format || .ppt(x) | Microsoft PowerPoint Open XML format || .xls(x) | Microsoft Excel Open XML format |By default, the maximum file size is 8MB. If you need to support larger file sizes, contact your Elastic Path representative. Alternatively, store files somewhere else and reference them.

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

This API exposes 4 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.

4 operations 2 paths 9 schemas 1 DELETE2 GET1 POST

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 Files 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 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Files 4

You can upload image files or URLs by using multipart/form-data as the content type header. For example, "Content-Type: multipart/form-data" \. Commerce supports the following fil…

GET
/v2/files
Get all Files
getAllFiles 3 params → 200500
POST
/v2/files
Create a File
createAFile body → 201400422500
GET
/v2/files/{fileID}
Get a File
getAFile 1 param → 200404500
DELETE
/v2/files/{fileID}
Delete a File
deleteAFile 1 param → 204403404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are File (9 properties), Error (5 properties), ResultsLinks (3 properties), ResultsMeta (2 properties). Each schema is shown below with its type and property counts.

UUID
string
FileLink
object
The publicly available URL for this file.
1 property
Error
object
5 properties 2 required
ResultsLinks
object
Links are used to allow you to move between requests.
3 properties
ResultsMeta
object
2 properties
ErrorResponse
object
1 property 1 required
Links
object
Links are used to allow you to move between requests.
1 property
File
object
9 properties
FileMeta
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-files-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