Location Custom Attributes

ILocationCustomAttributesApi locationCustomAttributesApi = client.LocationCustomAttributesApi;

Class Name

LocationCustomAttributesApi

Methods

List Location Custom Attribute Definitions
Create Location Custom Attribute Definition
Delete Location Custom Attribute Definition
Retrieve Location Custom Attribute Definition
Update Location Custom Attribute Definition
Bulk Delete Location Custom Attributes
Bulk Upsert Location Custom Attributes
List Location Custom Attributes
Delete Location Custom Attribute
Retrieve Location Custom Attribute
Upsert Location Custom Attribute

List Location Custom Attribute Definitions

Lists the location-related custom attribute definitions that belong to a Square seller account. When all response pages are retrieved, the results include all custom attribute definitions that are visible to the requesting application, including those that are created by other applications and set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

ListLocationCustomAttributeDefinitionsAsync(
    string visibilityFilter = null,
    int? limit = null,
    string cursor = null)

Parameters

Parameter	Type	Tags	Description
`visibilityFilter`	`string`	Query, Optional	Filters the `CustomAttributeDefinition` results by their `visibility` values.
`limit`	`int?`	Query, Optional	The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see Pagination.
`cursor`	`string`	Query, Optional	The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

Response Type

Task<Models.ListLocationCustomAttributeDefinitionsResponse>

Example Usage

try
{
    ListLocationCustomAttributeDefinitionsResponse result = await locationCustomAttributesApi.ListLocationCustomAttributeDefinitionsAsync();
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Create Location Custom Attribute Definition

Creates a location-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with locations. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute. After the definition is created, you can call UpsertLocationCustomAttribute or BulkUpsertLocationCustomAttributes to set the custom attribute for locations.

CreateLocationCustomAttributeDefinitionAsync(
    Models.CreateLocationCustomAttributeDefinitionRequest body)

Parameters

Parameter	Type	Tags	Description
`body`	`CreateLocationCustomAttributeDefinitionRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Task<Models.CreateLocationCustomAttributeDefinitionResponse>

Example Usage

CreateLocationCustomAttributeDefinitionRequest body = new CreateLocationCustomAttributeDefinitionRequest.Builder(
    new CustomAttributeDefinition.Builder()
    .Key("bestseller")
    .Name("Bestseller")
    .Description("Bestselling item at location")
    .Visibility("VISIBILITY_READ_WRITE_VALUES")
    .Build()
)
.Build();

try
{
    CreateLocationCustomAttributeDefinitionResponse result = await locationCustomAttributesApi.CreateLocationCustomAttributeDefinitionAsync(body);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Delete Location Custom Attribute Definition

Deletes a location-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all locations. Only the definition owner can delete a custom attribute definition.

DeleteLocationCustomAttributeDefinitionAsync(
    string key)

Parameters

Parameter	Type	Tags	Description
`key`	`string`	Template, Required	The key of the custom attribute definition to delete.

Response Type

Task<Models.DeleteLocationCustomAttributeDefinitionResponse>

Example Usage

string key = "key0";
try
{
    DeleteLocationCustomAttributeDefinitionResponse result = await locationCustomAttributesApi.DeleteLocationCustomAttributeDefinitionAsync(key);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Retrieve Location Custom Attribute Definition

Retrieves a location-related custom attribute definition from a Square seller account. To retrieve a custom attribute definition created by another application, the visibility setting must be VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

RetrieveLocationCustomAttributeDefinitionAsync(
    string key,
    int? version = null)

Parameters

Parameter	Type	Tags	Description
`key`	`string`	Template, Required	The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key.
`version`	`int?`	Query, Optional	The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

Response Type

Task<Models.RetrieveLocationCustomAttributeDefinitionResponse>

Example Usage

string key = "key0";
try
{
    RetrieveLocationCustomAttributeDefinitionResponse result = await locationCustomAttributesApi.RetrieveLocationCustomAttributeDefinitionAsync(key);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Update Location Custom Attribute Definition

Updates a location-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description, visibility, or the schema for a Selection data type. Only the definition owner can update a custom attribute definition.

UpdateLocationCustomAttributeDefinitionAsync(
    string key,
    Models.UpdateLocationCustomAttributeDefinitionRequest body)

Parameters

Parameter	Type	Tags	Description
`key`	`string`	Template, Required	The key of the custom attribute definition to update.
`body`	`UpdateLocationCustomAttributeDefinitionRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Task<Models.UpdateLocationCustomAttributeDefinitionResponse>

Example Usage

string key = "key0";
UpdateLocationCustomAttributeDefinitionRequest body = new UpdateLocationCustomAttributeDefinitionRequest.Builder(
    new CustomAttributeDefinition.Builder()
    .Description("Update the description as desired.")
    .Visibility("VISIBILITY_READ_ONLY")
    .Build()
)
.Build();

try
{
    UpdateLocationCustomAttributeDefinitionResponse result = await locationCustomAttributesApi.UpdateLocationCustomAttributeDefinitionAsync(
        key,
        body
    );
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Bulk Delete Location Custom Attributes

Deletes custom attributes for locations as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

BulkDeleteLocationCustomAttributesAsync(
    Models.BulkDeleteLocationCustomAttributesRequest body)

Parameters

Parameter	Type	Tags	Description
`body`	`BulkDeleteLocationCustomAttributesRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Task<Models.BulkDeleteLocationCustomAttributesResponse>

Example Usage

BulkDeleteLocationCustomAttributesRequest body = new BulkDeleteLocationCustomAttributesRequest.Builder(
    new Dictionary<string, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest>
    {
        ["id1"] = new BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest.Builder()
        .Build(),
        ["id2"] = new BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest.Builder()
        .Build(),
        ["id3"] = new BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest.Builder()
        .Build(),
    }
)
.Build();

try
{
    BulkDeleteLocationCustomAttributesResponse result = await locationCustomAttributesApi.BulkDeleteLocationCustomAttributesAsync(body);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Bulk Upsert Location Custom Attributes

Creates or updates custom attributes for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more locations. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the CreateLocationCustomAttributeDefinition endpoint. This BulkUpsertLocationCustomAttributes endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a location ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

BulkUpsertLocationCustomAttributesAsync(
    Models.BulkUpsertLocationCustomAttributesRequest body)

Parameters

Parameter	Type	Tags	Description
`body`	`BulkUpsertLocationCustomAttributesRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Task<Models.BulkUpsertLocationCustomAttributesResponse>

Example Usage

BulkUpsertLocationCustomAttributesRequest body = new BulkUpsertLocationCustomAttributesRequest.Builder(
    new Dictionary<string, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest>
    {
        ["key0"] = new BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.Builder(
            "location_id4",
            new CustomAttribute.Builder()
            .Build()
        )
        .Build(),
        ["key1"] = new BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.Builder(
            "location_id4",
            new CustomAttribute.Builder()
            .Build()
        )
        .Build(),
    }
)
.Build();

try
{
    BulkUpsertLocationCustomAttributesResponse result = await locationCustomAttributesApi.BulkUpsertLocationCustomAttributesAsync(body);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

List Location Custom Attributes

Lists the custom attributes associated with a location. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call. When all response pages are retrieved, the results include all custom attributes that are visible to the requesting application, including those that are owned by other applications and set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

ListLocationCustomAttributesAsync(
    string locationId,
    string visibilityFilter = null,
    int? limit = null,
    string cursor = null,
    bool? withDefinitions = false)

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the target location.
`visibilityFilter`	`string`	Query, Optional	Filters the `CustomAttributeDefinition` results by their `visibility` values.
`limit`	`int?`	Query, Optional	The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see Pagination.
`cursor`	`string`	Query, Optional	The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.
`withDefinitions`	`bool?`	Query, Optional	Indicates whether to return the custom attribute definition in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`. Default: `false`

Response Type

Task<Models.ListLocationCustomAttributesResponse>

Example Usage

string locationId = "location_id4";
bool? withDefinitions = false;
try
{
    ListLocationCustomAttributesResponse result = await locationCustomAttributesApi.ListLocationCustomAttributesAsync(
        locationId,
        null,
        null,
        null,
        withDefinitions
    );
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Delete Location Custom Attribute

Deletes a custom attribute associated with a location. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

DeleteLocationCustomAttributeAsync(
    string locationId,
    string key)

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the target location.
`key`	`string`	Template, Required	The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

Response Type

Task<Models.DeleteLocationCustomAttributeResponse>

Example Usage

string locationId = "location_id4";
string key = "key0";
try
{
    DeleteLocationCustomAttributeResponse result = await locationCustomAttributesApi.DeleteLocationCustomAttributeAsync(
        locationId,
        key
    );
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Retrieve Location Custom Attribute

Retrieves a custom attribute associated with a location. You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call. To retrieve a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

RetrieveLocationCustomAttributeAsync(
    string locationId,
    string key,
    bool? withDefinition = false,
    int? version = null)

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the target location.
`key`	`string`	Template, Required	The key of the custom attribute to retrieve. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
`withDefinition`	`bool?`	Query, Optional	Indicates whether to return the custom attribute definition in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`. Default: `false`
`version`	`int?`	Query, Optional	The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

Response Type

Task<Models.RetrieveLocationCustomAttributeResponse>

Example Usage

string locationId = "location_id4";
string key = "key0";
bool? withDefinition = false;
try
{
    RetrieveLocationCustomAttributeResponse result = await locationCustomAttributesApi.RetrieveLocationCustomAttributeAsync(
        locationId,
        key,
        withDefinition
    );
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Upsert Location Custom Attribute

Creates or updates a custom attribute for a location. Use this endpoint to set the value of a custom attribute for a specified location. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the CreateLocationCustomAttributeDefinition endpoint. To create or update a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

UpsertLocationCustomAttributeAsync(
    string locationId,
    string key,
    Models.UpsertLocationCustomAttributeRequest body)

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the target location.
`key`	`string`	Template, Required	The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
`body`	`UpsertLocationCustomAttributeRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Task<Models.UpsertLocationCustomAttributeResponse>

Example Usage

string locationId = "location_id4";
string key = "key0";
UpsertLocationCustomAttributeRequest body = new UpsertLocationCustomAttributeRequest.Builder(
    new CustomAttribute.Builder()
    .Build()
)
.Build();

try
{
    UpsertLocationCustomAttributeResponse result = await locationCustomAttributesApi.UpsertLocationCustomAttributeAsync(
        locationId,
        key,
        body
    );
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Files

location-custom-attributes.md

Latest commit

History

location-custom-attributes.md

File metadata and controls

Location Custom Attributes

Class Name

Methods

List Location Custom Attribute Definitions

Parameters

Response Type

Example Usage

Create Location Custom Attribute Definition

Parameters

Response Type

Example Usage

Delete Location Custom Attribute Definition

Parameters

Response Type

Example Usage

Retrieve Location Custom Attribute Definition

Parameters

Response Type

Example Usage

Update Location Custom Attribute Definition

Parameters

Response Type

Example Usage

Bulk Delete Location Custom Attributes

Parameters

Response Type

Example Usage

Bulk Upsert Location Custom Attributes

Parameters

Response Type

Example Usage

List Location Custom Attributes

Parameters

Response Type

Example Usage

Delete Location Custom Attribute

Parameters

Response Type

Example Usage

Retrieve Location Custom Attribute

Parameters

Response Type

Example Usage

Upsert Location Custom Attribute

Parameters

Response Type

Example Usage