Square

Square LocationCustomAttributes API

The LocationCustomAttributes API from Square — 6 operation(s) for locationcustomattributes.

Documentation GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/locations/custom-attribute-definitions List location custom field definitions · Square List Location Custom Attribute Definitions #

Ask an LLM

“What custom fields exist for my store locations?”

“Can I filter location custom attribute definitions by visibility?”

Tell an agent

List all location custom attribute definitions.

Show location custom field definitions with visibility {visibility_filter}.

POST /v2/locations/custom-attribute-definitions Define a new custom field for locations · Square Create Location Custom Attribute Definition #

Ask an LLM

“How do I add a custom field, like a store manager, to my locations?”

“Can I define my own attribute that applies to every location?”

Tell an agent

Create location custom attribute definition {custom_attribute_definition}.

Define a new custom field for my locations: {custom_attribute_definition}.

DELETE /v2/locations/custom-attribute-definitions/{key} Delete a location custom field definition · Square Delete Location Custom Attribute Definition #

Ask an LLM

“How do I remove a custom field definition from all my locations?”

“Does deleting a location custom attribute definition also delete its values?”

Tell an agent destructive · confirm first

Delete location custom attribute definition {key}.

Remove the location custom field {key} from my account.

GET /v2/locations/custom-attribute-definitions/{key} Get a location custom field definition · Square Retrieve Location Custom Attribute Definition #

Ask an LLM

“What does one location custom attribute definition look like?”

“Can I read a specific version of a location custom field definition?”

Tell an agent

Get the location custom attribute definition {key}.

Show version {version} of location custom field definition {key}.

PUT /v2/locations/custom-attribute-definitions/{key} Update a location custom field definition · Square Update Location Custom Attribute Definition #

Ask an LLM

“How do I rename a custom field defined for locations?”

“Can I change the visibility or description of a location custom attribute definition?”

Tell an agent

Update location custom attribute definition {key} with {custom_attribute_definition}.

Change the definition of location custom field {key}.

POST /v2/locations/custom-attributes/bulk-delete Delete custom field values on many locations · Square Bulk Delete Location Custom Attributes #

Ask an LLM

“Can I clear custom field values from several locations at once?”

“Is there a bulk delete for location custom attributes?”

Tell an agent destructive · confirm first

Bulk delete these location custom attributes: {values}.

Remove custom field values from multiple locations: {values}.

POST /v2/locations/custom-attributes/bulk-upsert Set custom field values on many locations · Square Bulk Upsert Location Custom Attributes #

Ask an LLM

“How do I set a custom field value on all my stores in one call?”

“Can I bulk create or update location custom attributes?”

Tell an agent

Bulk upsert location custom attributes {values}.

Set these custom field values across several locations: {values}.

GET /v2/locations/{location_id}/custom-attributes List a location's custom field values · Square List Location Custom Attributes #

Ask an LLM

“What custom field values are stored on one store location?”

“Can I get a location's custom attributes along with their definitions?”

Tell an agent

List custom attributes on location {location_id}.

Show custom field values for location {location_id} with definitions: {with_definitions}.

DELETE /v2/locations/{location_id}/custom-attributes/{key} Delete a custom field value from a location · Square Delete Location Custom Attribute #

Ask an LLM

“How do I clear one custom field value from a single location?”

“Can I remove a location's custom attribute without deleting its definition?”

Tell an agent destructive · confirm first

Delete custom attribute {key} from location {location_id}.

Clear the {key} field on store {location_id}.

GET /v2/locations/{location_id}/custom-attributes/{key} Get one custom field value on a location · Square Retrieve Location Custom Attribute #

Ask an LLM

“How do I read a single custom field value for one location?”

“Can I fetch one location custom attribute with its definition included?”

Tell an agent

Get custom attribute {key} on location {location_id}.

Read the {key} field value of store {location_id}.

POST /v2/locations/{location_id}/custom-attributes/{key} Set a custom field value on a location · Square Upsert Location Custom Attribute #

Ask an LLM

“How do I save a custom field value on one store location?”

“Can I update an existing custom attribute on a single location?”

Tell an agent

Set custom attribute {key} on location {location_id} to {custom_attribute}.

Upsert the {key} field on store {location_id}.

Square LocationCustomAttributes API

Operations 11

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification