LocationsApi.md

SquareConnect::LocationsApi

All URIs are relative to https://connect.squareup.com

Method	HTTP request	Description
list_locations	GET /v2/locations	ListLocations

list_locations

ListLocationsResponse list_locations

ListLocations

Provides the details for all of a business's locations. Most other Connect API endpoints have a required location_id path parameter. The id field of the Location objects returned by this endpoint correspond to that location_id parameter.

Example

# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = SquareConnect::LocationsApi.new

begin
  #ListLocations
  result = api_instance.list_locations
  p result
rescue SquareConnect::ApiError => e
  puts "Exception when calling LocationsApi->list_locations: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ListLocationsResponse

Authorization

oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json