Square API
You are viewing an old version of the API
Location Custom Attributes
Square API
Create and manage location-related custom attribute definitions and custom attributes.
Use the Location Custom Attributes API to create and manage custom attributes for locations. Custom attributes can be used to store properties or metadata that simplify integration, synchronization, and personalization workflows. After a custom attribute definition is created in a Square seller account, the custom attribute value can be set for locations.
Guides: Location Custom Attributes Webhooks
-
List location custom attribute definitions
GET /v2/locations/custom-attribute-definitions - Lists the location-related custom attribute definitions that belong to a Square seller account.
BETA -
Create location custom attribute definition
POST /v2/locations/custom-attribute-definitions - Creates a location-related custom attribute definition for a Square seller account.
BETA -
Delete location custom attribute definition
DELETE /v2/locations/custom-attribute-definitions/{key} - Deletes a location-related custom attribute definition from a Square seller account.
BETA -
Retrieve location custom attribute definition
GET /v2/locations/custom-attribute-definitions/{key} - Retrieves a location-related custom attribute definition from a Square seller account.
BETA -
Update location custom attribute definition
PUT /v2/locations/custom-attribute-definitions/{key} - Updates a location-related custom attribute definition for a Square seller account.
BETA -
Bulk delete location custom attributes
POST /v2/locations/custom-attributes/bulk-delete - Deletes custom attributes for locations as a bulk operation.
BETA -
Bulk upsert location custom attributes
POST /v2/locations/custom-attributes/bulk-upsert - Creates or updates custom attributes for locations as a bulk operation.
BETA -
List location custom attributes
GET /v2/locations/{location_id}/custom-attributes - Lists the custom attributes associated with a location.
BETA -
Delete location custom attribute
DELETE /v2/locations/{location_id}/custom-attributes/{key} - Deletes a custom attribute associated with a location.
BETA -
Retrieve location custom attribute
GET /v2/locations/{location_id}/custom-attributes/{key} - Retrieves a custom attribute associated with a location.
BETA -
Upsert location custom attribute
POST /v2/locations/{location_id}/custom-attributes/{key} - Creates or updates a custom attribute for a location.
BETA