Get the Merchant Realm Mapping for the current store

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

This API is used to obtain an Authentication Realm if there is none yet for the current store.

Responses

200

OK

application/json

Schema

Schema

data objectrequired

id uuid

The unique identifier for this merchant realm mapping.

prefix string

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

type string

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

realm_id string

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

store_id string

System-generated store ID.

Example (from schema)

{
  "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"
  }
}

401

Unauthorized

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

default

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://useast.api.elasticpath.com/v2/merchant-realm-mappings' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!