Get Merchant Realm Mappings

Get the Merchant Realm Mapping for the current store

GET/v2/merchant-realm-mappings

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get Merchant Realm Mappings action (under Merchant Realm Mappings).
Fill in the fields below, then reference the result from later steps as {{getMerchantRealmMappings.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://useast.api.elasticpath.comhttps://euwest.api.elasticpath.com__custom__Default "https://useast.api.elasticpath.com"

baseUrlCustomstring

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 200 with an object. Read it in later steps with {{getMerchantRealmMappings.response.data.<field>}}.

dataobject

idstring (uuid)

The unique identifier for this merchant realm mapping.

prefixstring

The store prefix that is assigned to this merchant realm mapping. This can be `null` if a store prefix has not been assigned.

typestring

Represents the type of object being returned. Always `merchant-realm-mappings`.

realm_idstring

The ID of the authentication realm used to sign in as administrator.

store_idstring

System-generated store ID.

json

{
  "data": {
    "id": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0",
    "prefix": "myCompany",
    "type": "string",
    "realm_id": "e730bf37-ed95-4ca9-b4c4-2c5ee08b21d7",
    "store_id": "88888888-4444-4333-8333-111111111111"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?