com.squareup.square.api

Interface OrderCustomAttributesApi

All Known Implementing Classes:

DefaultOrderCustomAttributesApi

public interface OrderCustomAttributesApi

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
BulkDeleteOrderCustomAttributesResponse	bulkDeleteOrderCustomAttributes(BulkDeleteOrderCustomAttributesRequest body) Deletes order [custom attributes]($m/CustomAttribute) as a bulk operation.
CompletableFuture<BulkDeleteOrderCustomAttributesResponse>	bulkDeleteOrderCustomAttributesAsync(BulkDeleteOrderCustomAttributesRequest body) Deletes order [custom attributes]($m/CustomAttribute) as a bulk operation.
BulkUpsertOrderCustomAttributesResponse	bulkUpsertOrderCustomAttributes(BulkUpsertOrderCustomAttributesRequest body) Creates or updates order [custom attributes]($m/CustomAttribute) as a bulk operation.
CompletableFuture<BulkUpsertOrderCustomAttributesResponse>	bulkUpsertOrderCustomAttributesAsync(BulkUpsertOrderCustomAttributesRequest body) Creates or updates order [custom attributes]($m/CustomAttribute) as a bulk operation.
CreateOrderCustomAttributeDefinitionResponse	createOrderCustomAttributeDefinition(CreateOrderCustomAttributeDefinitionRequest body) Creates an order-related custom attribute definition.
CompletableFuture<CreateOrderCustomAttributeDefinitionResponse>	createOrderCustomAttributeDefinitionAsync(CreateOrderCustomAttributeDefinitionRequest body) Creates an order-related custom attribute definition.
DeleteOrderCustomAttributeResponse	deleteOrderCustomAttribute(String orderId, String customAttributeKey) Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
CompletableFuture<DeleteOrderCustomAttributeResponse>	deleteOrderCustomAttributeAsync(String orderId, String customAttributeKey) Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
DeleteOrderCustomAttributeDefinitionResponse	deleteOrderCustomAttributeDefinition(String key) Deletes an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<DeleteOrderCustomAttributeDefinitionResponse>	deleteOrderCustomAttributeDefinitionAsync(String key) Deletes an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
ListOrderCustomAttributeDefinitionsResponse	listOrderCustomAttributeDefinitions(String visibilityFilter, String cursor, Integer limit) Lists the order-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
CompletableFuture<ListOrderCustomAttributeDefinitionsResponse>	listOrderCustomAttributeDefinitionsAsync(String visibilityFilter, String cursor, Integer limit) Lists the order-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
ListOrderCustomAttributesResponse	listOrderCustomAttributes(String orderId, String visibilityFilter, String cursor, Integer limit, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with an order.
CompletableFuture<ListOrderCustomAttributesResponse>	listOrderCustomAttributesAsync(String orderId, String visibilityFilter, String cursor, Integer limit, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with an order.
RetrieveOrderCustomAttributeResponse	retrieveOrderCustomAttribute(String orderId, String customAttributeKey, Integer version, Boolean withDefinition) Retrieves a [custom attribute]($m/CustomAttribute) associated with an order.
CompletableFuture<RetrieveOrderCustomAttributeResponse>	retrieveOrderCustomAttributeAsync(String orderId, String customAttributeKey, Integer version, Boolean withDefinition) Retrieves a [custom attribute]($m/CustomAttribute) associated with an order.
RetrieveOrderCustomAttributeDefinitionResponse	retrieveOrderCustomAttributeDefinition(String key, Integer version) Retrieves an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<RetrieveOrderCustomAttributeDefinitionResponse>	retrieveOrderCustomAttributeDefinitionAsync(String key, Integer version) Retrieves an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
UpdateOrderCustomAttributeDefinitionResponse	updateOrderCustomAttributeDefinition(String key, UpdateOrderCustomAttributeDefinitionRequest body) Updates an order-related custom attribute definition for a Square seller account.
CompletableFuture<UpdateOrderCustomAttributeDefinitionResponse>	updateOrderCustomAttributeDefinitionAsync(String key, UpdateOrderCustomAttributeDefinitionRequest body) Updates an order-related custom attribute definition for a Square seller account.
UpsertOrderCustomAttributeResponse	upsertOrderCustomAttribute(String orderId, String customAttributeKey, UpsertOrderCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for an order.
CompletableFuture<UpsertOrderCustomAttributeResponse>	upsertOrderCustomAttributeAsync(String orderId, String customAttributeKey, UpsertOrderCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for an order.

Method Detail

listOrderCustomAttributeDefinitions

ListOrderCustomAttributeDefinitionsResponse listOrderCustomAttributeDefinitions(String visibilityFilter,
                                                                                String cursor,
                                                                                Integer limit)
                                                                         throws ApiException,
                                                                                IOException

Lists the order-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

visibilityFilter - Optional parameter: Requests that all of the custom attributes be returned, or only those that are read-only or read-write.

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/working-with-apis/pagination).

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/working-with-apis/pagination).

Returns:

Returns the ListOrderCustomAttributeDefinitionsResponse 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.

listOrderCustomAttributeDefinitionsAsync

CompletableFuture<ListOrderCustomAttributeDefinitionsResponse> listOrderCustomAttributeDefinitionsAsync(String visibilityFilter,
                                                                                                        String cursor,
                                                                                                        Integer limit)

Lists the order-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

visibilityFilter - Optional parameter: Requests that all of the custom attributes be returned, or only those that are read-only or read-write.

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/working-with-apis/pagination).

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/working-with-apis/pagination).

Returns:

Returns the ListOrderCustomAttributeDefinitionsResponse response from the API call

createOrderCustomAttributeDefinition

CreateOrderCustomAttributeDefinitionResponse createOrderCustomAttributeDefinition(CreateOrderCustomAttributeDefinitionRequest body)
                                                                           throws ApiException,
                                                                                  IOException

Creates an order-related custom attribute definition. Use this endpoint to define a custom attribute that can be associated with orders. After creating a custom attribute definition, you can set the custom attribute for orders in the Square seller account.

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 CreateOrderCustomAttributeDefinitionResponse 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.

createOrderCustomAttributeDefinitionAsync

CompletableFuture<CreateOrderCustomAttributeDefinitionResponse> createOrderCustomAttributeDefinitionAsync(CreateOrderCustomAttributeDefinitionRequest body)

Creates an order-related custom attribute definition. Use this endpoint to define a custom attribute that can be associated with orders. After creating a custom attribute definition, you can set the custom attribute for orders in the Square seller account.

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 CreateOrderCustomAttributeDefinitionResponse response from the API call

deleteOrderCustomAttributeDefinition

DeleteOrderCustomAttributeDefinitionResponse deleteOrderCustomAttributeDefinition(String key)
                                                                           throws ApiException,
                                                                                  IOException

Deletes an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. 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 DeleteOrderCustomAttributeDefinitionResponse 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.

deleteOrderCustomAttributeDefinitionAsync

CompletableFuture<DeleteOrderCustomAttributeDefinitionResponse> deleteOrderCustomAttributeDefinitionAsync(String key)

Deletes an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. 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 DeleteOrderCustomAttributeDefinitionResponse response from the API call

retrieveOrderCustomAttributeDefinition

RetrieveOrderCustomAttributeDefinitionResponse retrieveOrderCustomAttributeDefinition(String key,
                                                                                      Integer version)
                                                                               throws ApiException,
                                                                                      IOException

Retrieves an order-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

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

version - Optional parameter: To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include this optional field and specify the current version of the custom attribute.

Returns:

Returns the RetrieveOrderCustomAttributeDefinitionResponse 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.

retrieveOrderCustomAttributeDefinitionAsync

CompletableFuture<RetrieveOrderCustomAttributeDefinitionResponse> retrieveOrderCustomAttributeDefinitionAsync(String key,
                                                                                                              Integer version)

Retrieves an order-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

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

version - Optional parameter: To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include this optional field and specify the current version of the custom attribute.

Returns:

Returns the RetrieveOrderCustomAttributeDefinitionResponse response from the API call

updateOrderCustomAttributeDefinition

UpdateOrderCustomAttributeDefinitionResponse updateOrderCustomAttributeDefinition(String key,
                                                                                  UpdateOrderCustomAttributeDefinitionRequest body)
                                                                           throws ApiException,
                                                                                  IOException

Updates an order-related custom attribute definition for a Square seller account. Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

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 UpdateOrderCustomAttributeDefinitionResponse 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.

updateOrderCustomAttributeDefinitionAsync

CompletableFuture<UpdateOrderCustomAttributeDefinitionResponse> updateOrderCustomAttributeDefinitionAsync(String key,
                                                                                                          UpdateOrderCustomAttributeDefinitionRequest body)

Updates an order-related custom attribute definition for a Square seller account. Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

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 UpdateOrderCustomAttributeDefinitionResponse response from the API call

bulkDeleteOrderCustomAttributes

BulkDeleteOrderCustomAttributesResponse bulkDeleteOrderCustomAttributes(BulkDeleteOrderCustomAttributesRequest body)
                                                                 throws ApiException,
                                                                        IOException

Deletes order [custom attributes]($m/CustomAttribute) as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition) endpoint.) This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete requests and returns a map of individual delete responses. Each delete request has a unique ID and provides an order ID and custom attribute. Each delete response is returned with the ID of the corresponding request. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 BulkDeleteOrderCustomAttributesResponse 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.

bulkDeleteOrderCustomAttributesAsync

CompletableFuture<BulkDeleteOrderCustomAttributesResponse> bulkDeleteOrderCustomAttributesAsync(BulkDeleteOrderCustomAttributesRequest body)

Deletes order [custom attributes]($m/CustomAttribute) as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition) endpoint.) This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete requests and returns a map of individual delete responses. Each delete request has a unique ID and provides an order ID and custom attribute. Each delete response is returned with the ID of the corresponding request. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 BulkDeleteOrderCustomAttributesResponse response from the API call

bulkUpsertOrderCustomAttributes

BulkUpsertOrderCustomAttributesResponse bulkUpsertOrderCustomAttributes(BulkUpsertOrderCustomAttributesRequest body)
                                                                 throws ApiException,
                                                                        IOException

Creates or updates order [custom attributes]($m/CustomAttribute) as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition) endpoint.) This `BulkUpsertOrderCustomAttributes` 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 an order 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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 BulkUpsertOrderCustomAttributesResponse 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.

bulkUpsertOrderCustomAttributesAsync

CompletableFuture<BulkUpsertOrderCustomAttributesResponse> bulkUpsertOrderCustomAttributesAsync(BulkUpsertOrderCustomAttributesRequest body)

Creates or updates order [custom attributes]($m/CustomAttribute) as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition) endpoint.) This `BulkUpsertOrderCustomAttributes` 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 an order 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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 BulkUpsertOrderCustomAttributesResponse response from the API call

listOrderCustomAttributes

ListOrderCustomAttributesResponse listOrderCustomAttributes(String orderId,
                                                            String visibilityFilter,
                                                            String cursor,
                                                            Integer limit,
                                                            Boolean withDefinitions)
                                                     throws ApiException,
                                                            IOException

Lists the [custom attributes]($m/CustomAttribute) associated with an order. 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:

orderId - Required parameter: The ID of the target [order](entity:Order).

visibilityFilter - Optional parameter: Requests that all of the custom attributes be returned, or only those that are read-only or read-write.

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/working-with-apis/pagination).

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/working-with-apis/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 ListOrderCustomAttributesResponse 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.

listOrderCustomAttributesAsync

CompletableFuture<ListOrderCustomAttributesResponse> listOrderCustomAttributesAsync(String orderId,
                                                                                    String visibilityFilter,
                                                                                    String cursor,
                                                                                    Integer limit,
                                                                                    Boolean withDefinitions)

Lists the [custom attributes]($m/CustomAttribute) associated with an order. 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:

orderId - Required parameter: The ID of the target [order](entity:Order).

visibilityFilter - Optional parameter: Requests that all of the custom attributes be returned, or only those that are read-only or read-write.

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/working-with-apis/pagination).

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/working-with-apis/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 ListOrderCustomAttributesResponse response from the API call

deleteOrderCustomAttribute

DeleteOrderCustomAttributeResponse deleteOrderCustomAttribute(String orderId,
                                                              String customAttributeKey)
                                                       throws ApiException,
                                                              IOException

Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

orderId - Required parameter: The ID of the target [order](entity:Order).

customAttributeKey - Required parameter: The key of the custom attribute to delete. This key must match the key of an existing custom attribute definition.

Returns:

Returns the DeleteOrderCustomAttributeResponse 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.

deleteOrderCustomAttributeAsync

CompletableFuture<DeleteOrderCustomAttributeResponse> deleteOrderCustomAttributeAsync(String orderId,
                                                                                      String customAttributeKey)

Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

orderId - Required parameter: The ID of the target [order](entity:Order).

customAttributeKey - Required parameter: The key of the custom attribute to delete. This key must match the key of an existing custom attribute definition.

Returns:

Returns the DeleteOrderCustomAttributeResponse response from the API call

retrieveOrderCustomAttribute

RetrieveOrderCustomAttributeResponse retrieveOrderCustomAttribute(String orderId,
                                                                  String customAttributeKey,
                                                                  Integer version,
                                                                  Boolean withDefinition)
                                                           throws ApiException,
                                                                  IOException

Retrieves a [custom attribute]($m/CustomAttribute) associated with an order. 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`. Note that seller-defined custom attributes also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

orderId - Required parameter: The ID of the target [order](entity:Order).

customAttributeKey - Required parameter: The key of the custom attribute to retrieve. This key must match the key of an existing custom attribute definition.

version - Optional parameter: To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include this optional field and specify the current version of the custom attribute.

withDefinition - 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 RetrieveOrderCustomAttributeResponse 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.

retrieveOrderCustomAttributeAsync

CompletableFuture<RetrieveOrderCustomAttributeResponse> retrieveOrderCustomAttributeAsync(String orderId,
                                                                                          String customAttributeKey,
                                                                                          Integer version,
                                                                                          Boolean withDefinition)

Retrieves a [custom attribute]($m/CustomAttribute) associated with an order. 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`. Note that seller-defined custom attributes also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

orderId - Required parameter: The ID of the target [order](entity:Order).

customAttributeKey - Required parameter: The key of the custom attribute to retrieve. This key must match the key of an existing custom attribute definition.

version - Optional parameter: To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include this optional field and specify the current version of the custom attribute.

withDefinition - 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 RetrieveOrderCustomAttributeResponse response from the API call

upsertOrderCustomAttribute

UpsertOrderCustomAttributeResponse upsertOrderCustomAttribute(String orderId,
                                                              String customAttributeKey,
                                                              UpsertOrderCustomAttributeRequest body)
                                                       throws ApiException,
                                                              IOException

Creates or updates a [custom attribute]($m/CustomAttribute) for an order. Use this endpoint to set the value of a custom attribute for a specific order. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition) endpoint.) To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

orderId - Required parameter: The ID of the target [order](entity:Order).

customAttributeKey - Required parameter: The key of the custom attribute to create or update. This key must match the key of an existing custom attribute definition.

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

Returns:

Returns the UpsertOrderCustomAttributeResponse 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.

upsertOrderCustomAttributeAsync

CompletableFuture<UpsertOrderCustomAttributeResponse> upsertOrderCustomAttributeAsync(String orderId,
                                                                                      String customAttributeKey,
                                                                                      UpsertOrderCustomAttributeRequest body)

Creates or updates a [custom attribute]($m/CustomAttribute) for an order. Use this endpoint to set the value of a custom attribute for a specific order. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition) endpoint.) To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

orderId - Required parameter: The ID of the target [order](entity:Order).

customAttributeKey - Required parameter: The key of the custom attribute to create or update. This key must match the key of an existing custom attribute definition.

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

Returns:

Returns the UpsertOrderCustomAttributeResponse response from the API call