list-location-custom-attribute-definitions-response.md

List Location Custom Attribute Definitions Response

Represents a ListLocationCustomAttributeDefinitions response. Either custom_attribute_definitions, an empty object, or errors is present in the response. If additional results are available, the cursor field is also present along with custom_attribute_definitions.

Structure

ListLocationCustomAttributeDefinitionsResponse

Fields

Name	Type	Tags	Description
customAttributeDefinitions	CustomAttributeDefinition[] | undefined	Optional	The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object ({}).
cursor	string | undefined	Optional	The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see Pagination.
errors	Error[] | undefined	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "cursor": "ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH",
  "custom_attribute_definitions": [
    {
      "created_at": "2022-12-02T19:50:21.832Z",
      "description": "Location's phone number",
      "key": "phone-number",
      "name": "phone number",
      "schema": {
        "key1": "val1",
        "key2": "val2"
      },
      "updated_at": "2022-12-02T19:50:21.832Z",
      "version": 1,
      "visibility": "VISIBILITY_READ_ONLY"
    },
    {
      "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-03T10:17:52.341Z",
      "version": 4,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  ],
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}