Skip to main content

Get a Merchant Realm Mapping

GET Get the Merchant Realm Mapping for the current store

For a direct GET on a Merchant Realm Mapping, see Get a Merchant Realm Mapping by ID.

https://useast.api.elasticpath.com/v2/merchant-realm-mappings

Parameters

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request examples

Curl

curl -X GET https://useast.api.elasticpath.com/v2/merchant-realm-mappings \
-H "Authorization: Bearer XXXX"

JavaScript SDK

// Where `EPCC` is an authenticated client
await EPCC.MerchantRealmMappingsEndpoint.All();

Response example

200 OK

{
"data": {
"id": "925c8617-41b3-44fa-ac4b-2f6edd1bd3c5",
"prefix": "mystore",
"realm_id": "e730bf37-ed95-4ca9-b4c4-2c5ee08b21d7",
"store_id": "88888888-4444-4333-8333-111111111111",
"type": "merchant-realm-mappings"
}
}

GET Get a Merchant Realm Mapping by ID

https://useast.api.elasticpath.com/v2/merchant-realm-mappings/:mapping-id

Parameters

Path parameters

NameRequiredTypeDescription
mapping-idRequiredstringThe ID for the requested merchant realm mapping.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request example

curl -X GET https://useast.api.elasticpath.com/v2/merchant-realm-mappings/925c8617-41b3-44fa-ac4b-2f6edd1bd3c5 \
-H "Authorization: Bearer XXXX"

Response example

200 OK

{
"data": {
"id": "925c8617-41b3-44fa-ac4b-2f6edd1bd3c5",
"prefix": "mystore",
"realm_id": "e730bf37-ed95-4ca9-b4c4-2c5ee08b21d7",
"store_id": "88888888-4444-4333-8333-111111111111",
"type": "merchant-realm-mappings"
}
}