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

Setting up and managing integrations.

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

This API exposes 9 operations across 6 paths, and defines 17 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.

9 operations 6 paths 17 schemas 1 DELETE6 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 Integrations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 9

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

Integrations 9

Setting up and managing integrations.

GET
/integrations
List integrations
ListIntegrations → 200500
POST
/integrations
Create an integration
CreateIntegration body → 200422500
GET
/integrations/{integration_uuid}
Get an integration
GetIntegration 1 param → 200404500
PUT
/integrations/{integration_uuid}
Update an integration
UpdateIntegration 1 param body → 200404422500
DELETE
/integrations/{integration_uuid}
Delete an integration
DeleteIntegration 1 param → 200500
GET
/integrations/logs
List logs for all integrations for the store
ListStoreLogs → 200500
GET
/integrations/{integration_uuid}/logs
List logs for integration
ListIntegrationLogs 1 param → 200404500
GET
/integrations/{integration_uuid}/jobs
List jobs for integration
ListIntegrationJobs 1 param → 200404500
GET
/integrations/{integration_uuid}/jobs/{job_uuid}/logs
List logs for the job
ListJobLogs 2 params → 200404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Integration (8 properties), IntegrationLog (8 properties), IntegrationCreate (7 properties), IntegrationUpdate (7 properties). Each schema is shown below with its type and property counts.

WebhookConfigurationObject
object
2 properties 1 required
AWSSQSConfigurationObject
object
4 properties 4 required
IntegrationUpdate
object
7 properties 1 required
Timestamps
object
The date and time a transaction is created.
2 properties
IntegrationCreate
object
7 properties 5 required
Meta
object
1 property
LogsPaginationLinks
object
Links are used to allow you to move between pages.
3 properties
ErrorResponse
object
1 property 1 required
IntegrationLog
object
As integrations can fail over time, Commerce provides the ability to browse all logs for your integrations.
8 properties
Links
object
1 property
Integration
object
8 properties
ErrorBody
object
3 properties 1 required
Results
object
The results for this response for the entire collection.
1 property
LinkURI
string
STOMPConfigurationObject
object
4 properties 1 required
IntegrationJob
object
2 properties
PaginationLinks
object
Links are used to allow you to move between pages.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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