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 Merchant Realm Mappings API

The Merchant Realm Mappings API from Elastic Path — 2 operation(s) for merchant realm mappings.

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

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

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

Paths & Operations 3

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

Merchant Realm Mappings 3
GET
/v2/merchant-realm-mappings
Get the Merchant Realm Mapping for the current store
getMerchantRealmMappings → 200401default
GET
/v2/merchant-realm-mappings/{mapping_id}
Get a Merchant Realm Mapping
getMerchantRealmMapping 1 param → 200404default
PUT
/v2/merchant-realm-mappings/{mapping_id}
Update a Merchant Realm Mapping
updateMerchantRealmMapping 1 param body → 200400404409default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are MerchantRealmMappingResponse (5 properties), Error (3 properties), MerchantRealmMapping (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

MerchantRealmMapping
object
2 properties
MerchantRealmMappingResponse
object
5 properties
Error
object
3 properties 2 required
ErrorResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-merchant-realm-mappings-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