create-location-custom-attribute-definition-response.md

Create Location Custom Attribute Definition Response

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

Structure

CreateLocationCustomAttributeDefinitionResponse

Fields

Name	Type	Tags	Description
customAttributeDefinition	CustomAttributeDefinition | undefined	Optional	Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute.
errors	Error[] | undefined	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "custom_attribute_definition": {
    "created_at": "2022-12-02T19:06:36.559Z",
    "description": "Bestselling item at location",
    "key": "bestseller",
    "name": "Bestseller",
    "schema": {
      "key1": "val1",
      "key2": "val2"
    },
    "updated_at": "2022-12-02T19:06:36.559Z",
    "version": 1,
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}