com.squareup.square.api

Interface MerchantCustomAttributesApi

All Known Implementing Classes:

DefaultMerchantCustomAttributesApi

public interface MerchantCustomAttributesApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
BulkDeleteMerchantCustomAttributesResponse	bulkDeleteMerchantCustomAttributes(BulkDeleteMerchantCustomAttributesRequest body) Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation.
CompletableFuture<BulkDeleteMerchantCustomAttributesResponse>	bulkDeleteMerchantCustomAttributesAsync(BulkDeleteMerchantCustomAttributesRequest body) Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation.
BulkUpsertMerchantCustomAttributesResponse	bulkUpsertMerchantCustomAttributes(BulkUpsertMerchantCustomAttributesRequest body) Creates or updates [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation.
CompletableFuture<BulkUpsertMerchantCustomAttributesResponse>	bulkUpsertMerchantCustomAttributesAsync(BulkUpsertMerchantCustomAttributesRequest body) Creates or updates [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation.
CreateMerchantCustomAttributeDefinitionResponse	createMerchantCustomAttributeDefinition(CreateMerchantCustomAttributeDefinitionRequest body) Creates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
CompletableFuture<CreateMerchantCustomAttributeDefinitionResponse>	createMerchantCustomAttributeDefinitionAsync(CreateMerchantCustomAttributeDefinitionRequest body) Creates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
DeleteMerchantCustomAttributeResponse	deleteMerchantCustomAttribute(String merchantId, String key) Deletes a [custom attribute]($m/CustomAttribute) associated with a merchant.
CompletableFuture<DeleteMerchantCustomAttributeResponse>	deleteMerchantCustomAttributeAsync(String merchantId, String key) Deletes a [custom attribute]($m/CustomAttribute) associated with a merchant.
DeleteMerchantCustomAttributeDefinitionResponse	deleteMerchantCustomAttributeDefinition(String key) Deletes a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<DeleteMerchantCustomAttributeDefinitionResponse>	deleteMerchantCustomAttributeDefinitionAsync(String key) Deletes a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
ListMerchantCustomAttributeDefinitionsResponse	listMerchantCustomAttributeDefinitions(String visibilityFilter, Integer limit, String cursor) Lists the merchant-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
CompletableFuture<ListMerchantCustomAttributeDefinitionsResponse>	listMerchantCustomAttributeDefinitionsAsync(String visibilityFilter, Integer limit, String cursor) Lists the merchant-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
ListMerchantCustomAttributesResponse	listMerchantCustomAttributes(String merchantId, String visibilityFilter, Integer limit, String cursor, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with a merchant.
CompletableFuture<ListMerchantCustomAttributesResponse>	listMerchantCustomAttributesAsync(String merchantId, String visibilityFilter, Integer limit, String cursor, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with a merchant.
RetrieveMerchantCustomAttributeResponse	retrieveMerchantCustomAttribute(String merchantId, String key, Boolean withDefinition, Integer version) Retrieves a [custom attribute]($m/CustomAttribute) associated with a merchant.
CompletableFuture<RetrieveMerchantCustomAttributeResponse>	retrieveMerchantCustomAttributeAsync(String merchantId, String key, Boolean withDefinition, Integer version) Retrieves a [custom attribute]($m/CustomAttribute) associated with a merchant.
RetrieveMerchantCustomAttributeDefinitionResponse	retrieveMerchantCustomAttributeDefinition(String key, Integer version) Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<RetrieveMerchantCustomAttributeDefinitionResponse>	retrieveMerchantCustomAttributeDefinitionAsync(String key, Integer version) Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
UpdateMerchantCustomAttributeDefinitionResponse	updateMerchantCustomAttributeDefinition(String key, UpdateMerchantCustomAttributeDefinitionRequest body) Updates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
CompletableFuture<UpdateMerchantCustomAttributeDefinitionResponse>	updateMerchantCustomAttributeDefinitionAsync(String key, UpdateMerchantCustomAttributeDefinitionRequest body) Updates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
UpsertMerchantCustomAttributeResponse	upsertMerchantCustomAttribute(String merchantId, String key, UpsertMerchantCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for a merchant.
CompletableFuture<UpsertMerchantCustomAttributeResponse>	upsertMerchantCustomAttributeAsync(String merchantId, String key, UpsertMerchantCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for a merchant.

Method Detail

listMerchantCustomAttributeDefinitions

ListMerchantCustomAttributeDefinitionsResponse listMerchantCustomAttributeDefinitions(String visibilityFilter,
                                                                                      Integer limit,
                                                                                      String cursor)
                                                                               throws ApiException,
                                                                                      IOException

Lists the merchant-related [custom attribute definitions]($m/CustomAttributeDefinition) 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`.

Parameters:

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListMerchantCustomAttributeDefinitionsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listMerchantCustomAttributeDefinitionsAsync

CompletableFuture<ListMerchantCustomAttributeDefinitionsResponse> listMerchantCustomAttributeDefinitionsAsync(String visibilityFilter,
                                                                                                              Integer limit,
                                                                                                              String cursor)

Lists the merchant-related [custom attribute definitions]($m/CustomAttributeDefinition) 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`.

Parameters:

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListMerchantCustomAttributeDefinitionsResponse response from the API call

createMerchantCustomAttributeDefinition

CreateMerchantCustomAttributeDefinitionResponse createMerchantCustomAttributeDefinition(CreateMerchantCustomAttributeDefinitionRequest body)
                                                                                 throws ApiException,
                                                                                        IOException

Creates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertMerchantCustomAttribute]($e/MerchantCustomAttributes/UpsertMerchantCustomAttribute) or [BulkUpsertMerchantCustomAttributes]($e/MerchantCustomAttributes/BulkUpsertMerchantCustomAttributes) to set the custom attribute for a merchant.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateMerchantCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createMerchantCustomAttributeDefinitionAsync

CompletableFuture<CreateMerchantCustomAttributeDefinitionResponse> createMerchantCustomAttributeDefinitionAsync(CreateMerchantCustomAttributeDefinitionRequest body)

Creates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertMerchantCustomAttribute]($e/MerchantCustomAttributes/UpsertMerchantCustomAttribute) or [BulkUpsertMerchantCustomAttributes]($e/MerchantCustomAttributes/BulkUpsertMerchantCustomAttributes) to set the custom attribute for a merchant.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateMerchantCustomAttributeDefinitionResponse response from the API call

deleteMerchantCustomAttributeDefinition

DeleteMerchantCustomAttributeDefinitionResponse deleteMerchantCustomAttributeDefinition(String key)
                                                                                 throws ApiException,
                                                                                        IOException

Deletes a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from the merchant. Only the definition owner can delete a custom attribute definition.

Parameters:

key - Required parameter: The key of the custom attribute definition to delete.

Returns:

Returns the DeleteMerchantCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteMerchantCustomAttributeDefinitionAsync

CompletableFuture<DeleteMerchantCustomAttributeDefinitionResponse> deleteMerchantCustomAttributeDefinitionAsync(String key)

Deletes a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from the merchant. Only the definition owner can delete a custom attribute definition.

Parameters:

key - Required parameter: The key of the custom attribute definition to delete.

Returns:

Returns the DeleteMerchantCustomAttributeDefinitionResponse response from the API call

retrieveMerchantCustomAttributeDefinition

RetrieveMerchantCustomAttributeDefinitionResponse retrieveMerchantCustomAttributeDefinition(String key,
                                                                                            Integer version)
                                                                                     throws ApiException,
                                                                                            IOException

Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) 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`.

Parameters:

key - Required parameter: 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 - Optional parameter: 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.

Returns:

Returns the RetrieveMerchantCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveMerchantCustomAttributeDefinitionAsync

CompletableFuture<RetrieveMerchantCustomAttributeDefinitionResponse> retrieveMerchantCustomAttributeDefinitionAsync(String key,
                                                                                                                    Integer version)

Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) 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`.

Parameters:

key - Required parameter: 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 - Optional parameter: 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.

Returns:

Returns the RetrieveMerchantCustomAttributeDefinitionResponse response from the API call

updateMerchantCustomAttributeDefinition

UpdateMerchantCustomAttributeDefinitionResponse updateMerchantCustomAttributeDefinition(String key,
                                                                                        UpdateMerchantCustomAttributeDefinitionRequest body)
                                                                                 throws ApiException,
                                                                                        IOException

Updates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) 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.

Parameters:

key - Required parameter: The key of the custom attribute definition to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateMerchantCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateMerchantCustomAttributeDefinitionAsync

CompletableFuture<UpdateMerchantCustomAttributeDefinitionResponse> updateMerchantCustomAttributeDefinitionAsync(String key,
                                                                                                                UpdateMerchantCustomAttributeDefinitionRequest body)

Updates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) 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.

Parameters:

key - Required parameter: The key of the custom attribute definition to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateMerchantCustomAttributeDefinitionResponse response from the API call

bulkDeleteMerchantCustomAttributes

BulkDeleteMerchantCustomAttributesResponse bulkDeleteMerchantCustomAttributes(BulkDeleteMerchantCustomAttributesRequest body)
                                                                       throws ApiException,
                                                                              IOException

Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkDeleteMerchantCustomAttributesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkDeleteMerchantCustomAttributesAsync

CompletableFuture<BulkDeleteMerchantCustomAttributesResponse> bulkDeleteMerchantCustomAttributesAsync(BulkDeleteMerchantCustomAttributesRequest body)

Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkDeleteMerchantCustomAttributesResponse response from the API call

bulkUpsertMerchantCustomAttributes

BulkUpsertMerchantCustomAttributesResponse bulkUpsertMerchantCustomAttributes(BulkUpsertMerchantCustomAttributesRequest body)
                                                                       throws ApiException,
                                                                              IOException

Creates or updates [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation. Use this endpoint to set the value of one or more custom attributes for a merchant. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/CreateMerchantCustomAttributeDefinition) endpoint. This `BulkUpsertMerchantCustomAttributes` 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 merchant 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`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpsertMerchantCustomAttributesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkUpsertMerchantCustomAttributesAsync

CompletableFuture<BulkUpsertMerchantCustomAttributesResponse> bulkUpsertMerchantCustomAttributesAsync(BulkUpsertMerchantCustomAttributesRequest body)

Creates or updates [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation. Use this endpoint to set the value of one or more custom attributes for a merchant. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/CreateMerchantCustomAttributeDefinition) endpoint. This `BulkUpsertMerchantCustomAttributes` 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 merchant 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`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpsertMerchantCustomAttributesResponse response from the API call

listMerchantCustomAttributes

ListMerchantCustomAttributesResponse listMerchantCustomAttributes(String merchantId,
                                                                  String visibilityFilter,
                                                                  Integer limit,
                                                                  String cursor,
                                                                  Boolean withDefinitions)
                                                           throws ApiException,
                                                                  IOException

Lists the [custom attributes]($m/CustomAttribute) associated with a merchant. 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`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

withDefinitions - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) 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`.

Returns:

Returns the ListMerchantCustomAttributesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listMerchantCustomAttributesAsync

CompletableFuture<ListMerchantCustomAttributesResponse> listMerchantCustomAttributesAsync(String merchantId,
                                                                                          String visibilityFilter,
                                                                                          Integer limit,
                                                                                          String cursor,
                                                                                          Boolean withDefinitions)

Lists the [custom attributes]($m/CustomAttribute) associated with a merchant. 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`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

withDefinitions - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) 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`.

Returns:

Returns the ListMerchantCustomAttributesResponse response from the API call

deleteMerchantCustomAttribute

DeleteMerchantCustomAttributeResponse deleteMerchantCustomAttribute(String merchantId,
                                                                    String key)
                                                             throws ApiException,
                                                                    IOException

Deletes a [custom attribute]($m/CustomAttribute) associated with a merchant. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

key - Required parameter: 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.

Returns:

Returns the DeleteMerchantCustomAttributeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteMerchantCustomAttributeAsync

CompletableFuture<DeleteMerchantCustomAttributeResponse> deleteMerchantCustomAttributeAsync(String merchantId,
                                                                                            String key)

Deletes a [custom attribute]($m/CustomAttribute) associated with a merchant. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

key - Required parameter: 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.

Returns:

Returns the DeleteMerchantCustomAttributeResponse response from the API call

retrieveMerchantCustomAttribute

RetrieveMerchantCustomAttributeResponse retrieveMerchantCustomAttribute(String merchantId,
                                                                        String key,
                                                                        Boolean withDefinition,
                                                                        Integer version)
                                                                 throws ApiException,
                                                                        IOException

Retrieves a [custom attribute]($m/CustomAttribute) associated with a merchant. 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`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

key - Required parameter: 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 - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) 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`.

version - Optional parameter: 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.

Returns:

Returns the RetrieveMerchantCustomAttributeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveMerchantCustomAttributeAsync

CompletableFuture<RetrieveMerchantCustomAttributeResponse> retrieveMerchantCustomAttributeAsync(String merchantId,
                                                                                                String key,
                                                                                                Boolean withDefinition,
                                                                                                Integer version)

Retrieves a [custom attribute]($m/CustomAttribute) associated with a merchant. 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`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

key - Required parameter: 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 - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) 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`.

version - Optional parameter: 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.

Returns:

Returns the RetrieveMerchantCustomAttributeResponse response from the API call

upsertMerchantCustomAttribute

UpsertMerchantCustomAttributeResponse upsertMerchantCustomAttribute(String merchantId,
                                                                    String key,
                                                                    UpsertMerchantCustomAttributeRequest body)
                                                             throws ApiException,
                                                                    IOException

Creates or updates a [custom attribute]($m/CustomAttribute) for a merchant. Use this endpoint to set the value of a custom attribute for a specified merchant. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/CreateMerchantCustomAttributeDefinition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

key - Required parameter: 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 - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpsertMerchantCustomAttributeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

upsertMerchantCustomAttributeAsync

CompletableFuture<UpsertMerchantCustomAttributeResponse> upsertMerchantCustomAttributeAsync(String merchantId,
                                                                                            String key,
                                                                                            UpsertMerchantCustomAttributeRequest body)

Creates or updates a [custom attribute]($m/CustomAttribute) for a merchant. Use this endpoint to set the value of a custom attribute for a specified merchant. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/CreateMerchantCustomAttributeDefinition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

merchantId - Required parameter: The ID of the target [merchant](entity:Merchant).

key - Required parameter: 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 - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpsertMerchantCustomAttributeResponse response from the API call