The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
square_version |
string |
Square Connect API versions Default: '2021-06-16' |
access_token |
string |
The OAuth 2.0 Access Token to use for API requests. |
custom_url |
string |
Sets the base URL requests are made to. Defaults to https://connect.squareup.comDefault: 'https://connect.squareup.com' |
environment |
string |
The API environment. Default: production |
timeout |
float |
The value to use for connection timeout. Default: 60 |
max_retries |
int |
The number of times to retry an endpoint call if it fails. Default: 0 |
backoff_factor |
float |
A backoff factor to apply between attempts after the second try. Default: 2 |
retry_statuses |
Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
retry_methods |
Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT'] |
additional_headers |
dict |
Additional headers to add to each API request |
The API client can be initialized as follows:
from square.client import Client
client = Client(
square_version='2021-06-16',
access_token='AccessToken',
environment = 'production',
custom_url = 'https://connect.squareup.com',)API calls return an ApiResponse object that includes the following fields:
| Field | Description |
|---|---|
status_code |
Status code of the HTTP response |
reason_phrase |
Reason phrase of the HTTP response |
headers |
Headers of the HTTP response as a dictionary |
text |
The body of the HTTP response as a string |
request |
HTTP request info |
errors |
Errors, if they exist |
body |
The deserialized body of the HTTP response |
cursor |
Cursor, if it exists |
from square.client import Client
client = Client(
square_version='2021-06-16',
access_token='AccessToken',)
locations_api = client.locations
result = locations_api.list_locations()
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)The gateway for the SDK. This class acts as a factory for the Apis and also holds the configuration of the SDK.
| Name | Description |
|---|---|
| mobile_authorization | Gets MobileAuthorizationApi |
| o_auth | Gets OAuthApi |
| v1_employees | Gets V1EmployeesApi |
| v1_transactions | Gets V1TransactionsApi |
| apple_pay | Gets ApplePayApi |
| bank_accounts | Gets BankAccountsApi |
| bookings | Gets BookingsApi |
| cards | Gets CardsApi |
| cash_drawers | Gets CashDrawersApi |
| catalog | Gets CatalogApi |
| customers | Gets CustomersApi |
| customer_groups | Gets CustomerGroupsApi |
| customer_segments | Gets CustomerSegmentsApi |
| devices | Gets DevicesApi |
| disputes | Gets DisputesApi |
| employees | Gets EmployeesApi |
| gift_cards | Gets GiftCardsApi |
| gift_card_activities | Gets GiftCardActivitiesApi |
| inventory | Gets InventoryApi |
| invoices | Gets InvoicesApi |
| labor | Gets LaborApi |
| locations | Gets LocationsApi |
| checkout | Gets CheckoutApi |
| transactions | Gets TransactionsApi |
| loyalty | Gets LoyaltyApi |
| merchants | Gets MerchantsApi |
| orders | Gets OrdersApi |
| payments | Gets PaymentsApi |
| refunds | Gets RefundsApi |
| sites | Gets SitesApi |
| snippets | Gets SnippetsApi |
| subscriptions | Gets SubscriptionsApi |
| team | Gets TeamApi |
| terminal | Gets TerminalApi |