retrieve-location-custom-attribute-response.md

Retrieve Location Custom Attribute Response

Represents a RetrieveLocationCustomAttribute response. Either custom_attribute_definition or errors is present in the response.

Structure

RetrieveLocationCustomAttributeResponse

Fields

Name	Type	Tags	Description
customAttribute	CustomAttribute | undefined	Optional	A custom attribute value. Each custom attribute value has a corresponding CustomAttributeDefinition object.
errors	Error[] | undefined	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "custom_attribute": {
    "key": "key2",
    "value": {
      "key1": "val1",
      "key2": "val2"
    },
    "version": 102,
    "visibility": "VISIBILITY_READ_ONLY",
    "definition": {
      "key": "key0",
      "schema": {
        "key1": "val1",
        "key2": "val2"
      },
      "name": "name0",
      "description": "description0",
      "visibility": "VISIBILITY_HIDDEN"
    }
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}