Update a Merchant Realm Mapping

PUT 
/v2/merchant-realm-mappings/:mapping_id

Update a Merchant Realm Mapping

Request

Path Parameters

mapping_id stringrequired

The id of the Application Key.

application/json

Body

required

data MerchantRealmMappingrequired

prefix stringrequired

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

type stringrequired

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

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

400

Bad request. The request failed validation.

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

missing-name

Required field missing

{
  "errors": [
    {
      "detail": "The field 'prefix' is required.",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

404

Not found. The requested entity does not exist.

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

not-found

Requested entity not found

{
  "errors": [
    {
      "detail": "merchant realm mapping not found",
      "status": "404",
      "title": "Not Found"
    }
  ]
}

409

Conflict

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

conflict-error

Prefix already in use

{
  "errors": [
    {
      "detail": "the prefix is already in use",
      "status": "409",
      "title": "Conflict"
    }
  ]
}

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

Loading...