com.squareup.square.api

Interface LocationsApi

All Known Implementing Classes:

DefaultLocationsApi

public interface LocationsApi

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
CreateLocationResponse	createLocation(CreateLocationRequest body) Creates a [location](https://developer.squareup.com/docs/locations-api).
CompletableFuture<CreateLocationResponse>	createLocationAsync(CreateLocationRequest body) Creates a [location](https://developer.squareup.com/docs/locations-api).
ListLocationsResponse	listLocations() Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.
CompletableFuture<ListLocationsResponse>	listLocationsAsync() Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.
RetrieveLocationResponse	retrieveLocation(String locationId) Retrieves details of a single location.
CompletableFuture<RetrieveLocationResponse>	retrieveLocationAsync(String locationId) Retrieves details of a single location.
UpdateLocationResponse	updateLocation(String locationId, UpdateLocationRequest body) Updates a [location](https://developer.squareup.com/docs/locations-api).
CompletableFuture<UpdateLocationResponse>	updateLocationAsync(String locationId, UpdateLocationRequest body) Updates a [location](https://developer.squareup.com/docs/locations-api).

Method Detail

listLocations

ListLocationsResponse listLocations()
                             throws ApiException,
                                    IOException

Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.

Returns:

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

listLocationsAsync

CompletableFuture<ListLocationsResponse> listLocationsAsync()

Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.

Returns:

Returns the ListLocationsResponse response from the API call

createLocation

CreateLocationResponse createLocation(CreateLocationRequest body)
                               throws ApiException,
                                      IOException

Creates a [location](https://developer.squareup.com/docs/locations-api). Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Developers can use locations to separate sales activity through applications that integrate with Square from sales activity elsewhere in a seller's account. Locations created programmatically with the Locations API last forever and are visible to the seller for their own management. Therefore, ensure that each location has a sensible and unique name.

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

createLocationAsync

CompletableFuture<CreateLocationResponse> createLocationAsync(CreateLocationRequest body)

Creates a [location](https://developer.squareup.com/docs/locations-api). Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Developers can use locations to separate sales activity through applications that integrate with Square from sales activity elsewhere in a seller's account. Locations created programmatically with the Locations API last forever and are visible to the seller for their own management. Therefore, ensure that each location has a sensible and unique name.

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

retrieveLocation

RetrieveLocationResponse retrieveLocation(String locationId)
                                   throws ApiException,
                                          IOException

Retrieves details of a single location. Specify "main" as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).

Parameters:

locationId - Required parameter: The ID of the location to retrieve. Specify the string "main" to return the main location.

Returns:

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

retrieveLocationAsync

CompletableFuture<RetrieveLocationResponse> retrieveLocationAsync(String locationId)

Retrieves details of a single location. Specify "main" as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).

Parameters:

locationId - Required parameter: The ID of the location to retrieve. Specify the string "main" to return the main location.

Returns:

Returns the RetrieveLocationResponse response from the API call

updateLocation

UpdateLocationResponse updateLocation(String locationId,
                                      UpdateLocationRequest body)
                               throws ApiException,
                                      IOException

Updates a [location](https://developer.squareup.com/docs/locations-api).

Parameters:

locationId - Required parameter: The ID of the location 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 UpdateLocationResponse 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.

updateLocationAsync

CompletableFuture<UpdateLocationResponse> updateLocationAsync(String locationId,
                                                              UpdateLocationRequest body)

Updates a [location](https://developer.squareup.com/docs/locations-api).

Parameters:

locationId - Required parameter: The ID of the location 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 UpdateLocationResponse response from the API call