This Square Connect SDK will enter a security maintenance phase in Q3 2020 and will be RETIRED (EOL) in Q1 2021. In the security maintenance phase, this SDK will continue to receive support and security patches but will no longer receive bug fixes or product updates. Once it is retired, support and security patches will no longer be available. A new SDK, more bespoke to the language, will be available once this SDK enters its security maintenance phase. The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https ://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis).
Security Maintenance | New SDK Release | Retired (EOL) |
---|---|---|
Q3, 2020 | Q3, 2020 | Q1, 2021 |
If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new slack community for Square Developers
Node.js 6.0 or later
For Node.js
To install the SDK:
npm install square-connect --save
Please follow the installation instruction and execute the following JS code:
var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";
var api = new SquareConnect.LocationsApi();
api.listLocations().then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data, 0, 1));
}, function(error) {
console.error(error);
});
var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;
// Set sandbox url
defaultClient.basePath = 'https://connect.squareupsandbox.com';
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
// Set sandbox access token
oauth2.accessToken = "YOUR SANDBOX ACCESS TOKEN";
// Pass client to API
var api = new SquareConnect.LocationsApi();
All URIs are relative to https://connect.squareup.com
Class | Method | HTTP request | Description |
---|---|---|---|
SquareConnect.ApplePayApi | registerDomain | POST /v2/apple-pay/domains | RegisterDomain |
SquareConnect.BankAccountsApi | getBankAccount | GET /v2/bank-accounts/{bank_account_id} | GetBankAccount |
SquareConnect.BankAccountsApi | getBankAccountByV1Id | GET /v2/bank-accounts/by-v1-id/{v1_bank_account_id} | GetBankAccountByV1Id |
SquareConnect.BankAccountsApi | listBankAccounts | GET /v2/bank-accounts | ListBankAccounts |
SquareConnect.CashDrawersApi | listCashDrawerShiftEvents | GET /v2/cash-drawers/shifts/{shift_id}/events | ListCashDrawerShiftEvents |
SquareConnect.CashDrawersApi | listCashDrawerShifts | GET /v2/cash-drawers/shifts | ListCashDrawerShifts |
SquareConnect.CashDrawersApi | retrieveCashDrawerShift | GET /v2/cash-drawers/shifts/{shift_id} | RetrieveCashDrawerShift |
SquareConnect.CatalogApi | batchDeleteCatalogObjects | POST /v2/catalog/batch-delete | BatchDeleteCatalogObjects |
SquareConnect.CatalogApi | batchRetrieveCatalogObjects | POST /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects |
SquareConnect.CatalogApi | batchUpsertCatalogObjects | POST /v2/catalog/batch-upsert | BatchUpsertCatalogObjects |
SquareConnect.CatalogApi | catalogInfo | GET /v2/catalog/info | CatalogInfo |
SquareConnect.CatalogApi | deleteCatalogObject | DELETE /v2/catalog/object/{object_id} | DeleteCatalogObject |
SquareConnect.CatalogApi | listCatalog | GET /v2/catalog/list | ListCatalog |
SquareConnect.CatalogApi | retrieveCatalogObject | GET /v2/catalog/object/{object_id} | RetrieveCatalogObject |
SquareConnect.CatalogApi | searchCatalogObjects | POST /v2/catalog/search | SearchCatalogObjects |
SquareConnect.CatalogApi | updateItemModifierLists | POST /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists |
SquareConnect.CatalogApi | updateItemTaxes | POST /v2/catalog/update-item-taxes | UpdateItemTaxes |
SquareConnect.CatalogApi | upsertCatalogObject | POST /v2/catalog/object | UpsertCatalogObject |
SquareConnect.CheckoutApi | createCheckout | POST /v2/locations/{location_id}/checkouts | CreateCheckout |
SquareConnect.CustomerGroupsApi | createCustomerGroup | POST /v2/customers/groups | CreateCustomerGroup |
SquareConnect.CustomerGroupsApi | deleteCustomerGroup | DELETE /v2/customers/groups/{group_id} | DeleteCustomerGroup |
SquareConnect.CustomerGroupsApi | listCustomerGroups | GET /v2/customers/groups | ListCustomerGroups |
SquareConnect.CustomerGroupsApi | retrieveCustomerGroup | GET /v2/customers/groups/{group_id} | RetrieveCustomerGroup |
SquareConnect.CustomerGroupsApi | updateCustomerGroup | PUT /v2/customers/groups/{group_id} | UpdateCustomerGroup |
SquareConnect.CustomerSegmentsApi | listCustomerSegments | GET /v2/customers/segments | ListCustomerSegments |
SquareConnect.CustomerSegmentsApi | retrieveCustomerSegment | GET /v2/customers/segments/{segment_id} | RetrieveCustomerSegment |
SquareConnect.CustomersApi | addGroupToCustomer | PUT /v2/customers/{customer_id}/groups/{group_id} | AddGroupToCustomer |
SquareConnect.CustomersApi | createCustomer | POST /v2/customers | CreateCustomer |
SquareConnect.CustomersApi | createCustomerCard | POST /v2/customers/{customer_id}/cards | CreateCustomerCard |
SquareConnect.CustomersApi | deleteCustomer | DELETE /v2/customers/{customer_id} | DeleteCustomer |
SquareConnect.CustomersApi | deleteCustomerCard | DELETE /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard |
SquareConnect.CustomersApi | listCustomers | GET /v2/customers | ListCustomers |
SquareConnect.CustomersApi | removeGroupFromCustomer | DELETE /v2/customers/{customer_id}/groups/{group_id} | RemoveGroupFromCustomer |
SquareConnect.CustomersApi | retrieveCustomer | GET /v2/customers/{customer_id} | RetrieveCustomer |
SquareConnect.CustomersApi | searchCustomers | POST /v2/customers/search | SearchCustomers |
SquareConnect.CustomersApi | updateCustomer | PUT /v2/customers/{customer_id} | UpdateCustomer |
SquareConnect.DevicesApi | createDeviceCode | POST /v2/devices/codes | CreateDeviceCode |
SquareConnect.DevicesApi | getDeviceCode | GET /v2/devices/codes/{id} | GetDeviceCode |
SquareConnect.DevicesApi | listDeviceCodes | GET /v2/devices/codes | ListDeviceCodes |
SquareConnect.DisputesApi | acceptDispute | POST /v2/disputes/{dispute_id}/accept | AcceptDispute |
SquareConnect.DisputesApi | createDisputeEvidenceText | POST /v2/disputes/{dispute_id}/evidence_text | CreateDisputeEvidenceText |
SquareConnect.DisputesApi | listDisputeEvidence | GET /v2/disputes/{dispute_id}/evidence | ListDisputeEvidence |
SquareConnect.DisputesApi | listDisputes | GET /v2/disputes | ListDisputes |
SquareConnect.DisputesApi | removeDisputeEvidence | DELETE /v2/disputes/{dispute_id}/evidence/{evidence_id} | RemoveDisputeEvidence |
SquareConnect.DisputesApi | retrieveDispute | GET /v2/disputes/{dispute_id} | RetrieveDispute |
SquareConnect.DisputesApi | retrieveDisputeEvidence | GET /v2/disputes/{dispute_id}/evidence/{evidence_id} | RetrieveDisputeEvidence |
SquareConnect.DisputesApi | submitEvidence | POST /v2/disputes/{dispute_id}/submit-evidence | SubmitEvidence |
SquareConnect.EmployeesApi | listEmployees | GET /v2/employees | ListEmployees |
SquareConnect.EmployeesApi | retrieveEmployee | GET /v2/employees/{id} | RetrieveEmployee |
SquareConnect.InventoryApi | batchChangeInventory | POST /v2/inventory/batch-change | BatchChangeInventory |
SquareConnect.InventoryApi | batchRetrieveInventoryChanges | POST /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges |
SquareConnect.InventoryApi | batchRetrieveInventoryCounts | POST /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts |
SquareConnect.InventoryApi | retrieveInventoryAdjustment | GET /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment |
SquareConnect.InventoryApi | retrieveInventoryChanges | GET /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges |
SquareConnect.InventoryApi | retrieveInventoryCount | GET /v2/inventory/{catalog_object_id} | RetrieveInventoryCount |
SquareConnect.InventoryApi | retrieveInventoryPhysicalCount | GET /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount |
SquareConnect.LaborApi | createBreakType | POST /v2/labor/break-types | CreateBreakType |
SquareConnect.LaborApi | createShift | POST /v2/labor/shifts | CreateShift |
SquareConnect.LaborApi | deleteBreakType | DELETE /v2/labor/break-types/{id} | DeleteBreakType |
SquareConnect.LaborApi | deleteShift | DELETE /v2/labor/shifts/{id} | DeleteShift |
SquareConnect.LaborApi | getBreakType | GET /v2/labor/break-types/{id} | GetBreakType |
SquareConnect.LaborApi | getEmployeeWage | GET /v2/labor/employee-wages/{id} | GetEmployeeWage |
SquareConnect.LaborApi | getShift | GET /v2/labor/shifts/{id} | GetShift |
SquareConnect.LaborApi | listBreakTypes | GET /v2/labor/break-types | ListBreakTypes |
SquareConnect.LaborApi | listEmployeeWages | GET /v2/labor/employee-wages | ListEmployeeWages |
SquareConnect.LaborApi | listWorkweekConfigs | GET /v2/labor/workweek-configs | ListWorkweekConfigs |
SquareConnect.LaborApi | searchShifts | POST /v2/labor/shifts/search | SearchShifts |
SquareConnect.LaborApi | updateBreakType | PUT /v2/labor/break-types/{id} | UpdateBreakType |
SquareConnect.LaborApi | updateShift | PUT /v2/labor/shifts/{id} | UpdateShift |
SquareConnect.LaborApi | updateWorkweekConfig | PUT /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig |
SquareConnect.LocationsApi | createLocation | POST /v2/locations | CreateLocation |
SquareConnect.LocationsApi | listLocations | GET /v2/locations | ListLocations |
SquareConnect.LocationsApi | retrieveLocation | GET /v2/locations/{location_id} | RetrieveLocation |
SquareConnect.LocationsApi | updateLocation | PUT /v2/locations/{location_id} | UpdateLocation |
SquareConnect.LoyaltyApi | accumulateLoyaltyPoints | POST /v2/loyalty/accounts/{account_id}/accumulate | AccumulateLoyaltyPoints |
SquareConnect.LoyaltyApi | adjustLoyaltyPoints | POST /v2/loyalty/accounts/{account_id}/adjust | AdjustLoyaltyPoints |
SquareConnect.LoyaltyApi | calculateLoyaltyPoints | POST /v2/loyalty/programs/{program_id}/calculate | CalculateLoyaltyPoints |
SquareConnect.LoyaltyApi | createLoyaltyAccount | POST /v2/loyalty/accounts | CreateLoyaltyAccount |
SquareConnect.LoyaltyApi | createLoyaltyReward | POST /v2/loyalty/rewards | CreateLoyaltyReward |
SquareConnect.LoyaltyApi | deleteLoyaltyReward | DELETE /v2/loyalty/rewards/{reward_id} | DeleteLoyaltyReward |
SquareConnect.LoyaltyApi | listLoyaltyPrograms | GET /v2/loyalty/programs | ListLoyaltyPrograms |
SquareConnect.LoyaltyApi | redeemLoyaltyReward | POST /v2/loyalty/rewards/{reward_id}/redeem | RedeemLoyaltyReward |
SquareConnect.LoyaltyApi | retrieveLoyaltyAccount | GET /v2/loyalty/accounts/{account_id} | RetrieveLoyaltyAccount |
SquareConnect.LoyaltyApi | retrieveLoyaltyReward | GET /v2/loyalty/rewards/{reward_id} | RetrieveLoyaltyReward |
SquareConnect.LoyaltyApi | searchLoyaltyAccounts | POST /v2/loyalty/accounts/search | SearchLoyaltyAccounts |
SquareConnect.LoyaltyApi | searchLoyaltyEvents | POST /v2/loyalty/events/search | SearchLoyaltyEvents |
SquareConnect.LoyaltyApi | searchLoyaltyRewards | POST /v2/loyalty/rewards/search | SearchLoyaltyRewards |
SquareConnect.MerchantsApi | listMerchants | GET /v2/merchants | ListMerchants |
SquareConnect.MerchantsApi | retrieveMerchant | GET /v2/merchants/{merchant_id} | RetrieveMerchant |
SquareConnect.MobileAuthorizationApi | createMobileAuthorizationCode | POST /mobile/authorization-code | CreateMobileAuthorizationCode |
SquareConnect.OAuthApi | obtainToken | POST /oauth2/token | ObtainToken |
SquareConnect.OAuthApi | renewToken | POST /oauth2/clients/{client_id}/access-token/renew | RenewToken |
SquareConnect.OAuthApi | revokeToken | POST /oauth2/revoke | RevokeToken |
SquareConnect.OrdersApi | batchRetrieveOrders | POST /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders |
SquareConnect.OrdersApi | calculateOrder | POST /v2/orders/calculate | CalculateOrder |
SquareConnect.OrdersApi | createOrder | POST /v2/locations/{location_id}/orders | CreateOrder |
SquareConnect.OrdersApi | payOrder | POST /v2/orders/{order_id}/pay | PayOrder |
SquareConnect.OrdersApi | searchOrders | POST /v2/orders/search | SearchOrders |
SquareConnect.OrdersApi | updateOrder | PUT /v2/locations/{location_id}/orders/{order_id} | UpdateOrder |
SquareConnect.PaymentsApi | cancelPayment | POST /v2/payments/{payment_id}/cancel | CancelPayment |
SquareConnect.PaymentsApi | cancelPaymentByIdempotencyKey | POST /v2/payments/cancel | CancelPaymentByIdempotencyKey |
SquareConnect.PaymentsApi | completePayment | POST /v2/payments/{payment_id}/complete | CompletePayment |
SquareConnect.PaymentsApi | createPayment | POST /v2/payments | CreatePayment |
SquareConnect.PaymentsApi | getPayment | GET /v2/payments/{payment_id} | GetPayment |
SquareConnect.PaymentsApi | listPayments | GET /v2/payments | ListPayments |
SquareConnect.RefundsApi | getPaymentRefund | GET /v2/refunds/{refund_id} | GetPaymentRefund |
SquareConnect.RefundsApi | listPaymentRefunds | GET /v2/refunds | ListPaymentRefunds |
SquareConnect.RefundsApi | refundPayment | POST /v2/refunds | RefundPayment |
SquareConnect.ReportingApi | listAdditionalRecipientReceivableRefunds | GET /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds |
SquareConnect.ReportingApi | listAdditionalRecipientReceivables | GET /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables |
SquareConnect.TerminalApi | cancelTerminalCheckout | POST /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout |
SquareConnect.TerminalApi | createTerminalCheckout | POST /v2/terminals/checkouts | CreateTerminalCheckout |
SquareConnect.TerminalApi | getTerminalCheckout | GET /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout |
SquareConnect.TerminalApi | searchTerminalCheckouts | POST /v2/terminals/checkouts/search | SearchTerminalCheckouts |
SquareConnect.TransactionsApi | captureTransaction | POST /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction |
SquareConnect.TransactionsApi | charge | POST /v2/locations/{location_id}/transactions | Charge |
SquareConnect.TransactionsApi | createRefund | POST /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund |
SquareConnect.TransactionsApi | listRefunds | GET /v2/locations/{location_id}/refunds | ListRefunds |
SquareConnect.TransactionsApi | listTransactions | GET /v2/locations/{location_id}/transactions | ListTransactions |
SquareConnect.TransactionsApi | retrieveTransaction | GET /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction |
SquareConnect.TransactionsApi | voidTransaction | POST /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction |
SquareConnect.V1EmployeesApi | createEmployee | POST /v1/me/employees | CreateEmployee |
SquareConnect.V1EmployeesApi | createEmployeeRole | POST /v1/me/roles | CreateEmployeeRole |
SquareConnect.V1EmployeesApi | createTimecard | POST /v1/me/timecards | CreateTimecard |
SquareConnect.V1EmployeesApi | deleteTimecard | DELETE /v1/me/timecards/{timecard_id} | DeleteTimecard |
SquareConnect.V1EmployeesApi | listCashDrawerShifts | GET /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts |
SquareConnect.V1EmployeesApi | listEmployeeRoles | GET /v1/me/roles | ListEmployeeRoles |
SquareConnect.V1EmployeesApi | listEmployees | GET /v1/me/employees | ListEmployees |
SquareConnect.V1EmployeesApi | listTimecardEvents | GET /v1/me/timecards/{timecard_id}/events | ListTimecardEvents |
SquareConnect.V1EmployeesApi | listTimecards | GET /v1/me/timecards | ListTimecards |
SquareConnect.V1EmployeesApi | retrieveCashDrawerShift | GET /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift |
SquareConnect.V1EmployeesApi | retrieveEmployee | GET /v1/me/employees/{employee_id} | RetrieveEmployee |
SquareConnect.V1EmployeesApi | retrieveEmployeeRole | GET /v1/me/roles/{role_id} | RetrieveEmployeeRole |
SquareConnect.V1EmployeesApi | retrieveTimecard | GET /v1/me/timecards/{timecard_id} | RetrieveTimecard |
SquareConnect.V1EmployeesApi | updateEmployee | PUT /v1/me/employees/{employee_id} | UpdateEmployee |
SquareConnect.V1EmployeesApi | updateEmployeeRole | PUT /v1/me/roles/{role_id} | UpdateEmployeeRole |
SquareConnect.V1EmployeesApi | updateTimecard | PUT /v1/me/timecards/{timecard_id} | UpdateTimecard |
SquareConnect.V1ItemsApi | adjustInventory | POST /v1/{location_id}/inventory/{variation_id} | AdjustInventory |
SquareConnect.V1ItemsApi | applyFee | PUT /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee |
SquareConnect.V1ItemsApi | applyModifierList | PUT /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList |
SquareConnect.V1ItemsApi | createCategory | POST /v1/{location_id}/categories | CreateCategory |
SquareConnect.V1ItemsApi | createDiscount | POST /v1/{location_id}/discounts | CreateDiscount |
SquareConnect.V1ItemsApi | createFee | POST /v1/{location_id}/fees | CreateFee |
SquareConnect.V1ItemsApi | createItem | POST /v1/{location_id}/items | CreateItem |
SquareConnect.V1ItemsApi | createModifierList | POST /v1/{location_id}/modifier-lists | CreateModifierList |
SquareConnect.V1ItemsApi | createModifierOption | POST /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption |
SquareConnect.V1ItemsApi | createPage | POST /v1/{location_id}/pages | CreatePage |
SquareConnect.V1ItemsApi | createVariation | POST /v1/{location_id}/items/{item_id}/variations | CreateVariation |
SquareConnect.V1ItemsApi | deleteCategory | DELETE /v1/{location_id}/categories/{category_id} | DeleteCategory |
SquareConnect.V1ItemsApi | deleteDiscount | DELETE /v1/{location_id}/discounts/{discount_id} | DeleteDiscount |
SquareConnect.V1ItemsApi | deleteFee | DELETE /v1/{location_id}/fees/{fee_id} | DeleteFee |
SquareConnect.V1ItemsApi | deleteItem | DELETE /v1/{location_id}/items/{item_id} | DeleteItem |
SquareConnect.V1ItemsApi | deleteModifierList | DELETE /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList |
SquareConnect.V1ItemsApi | deleteModifierOption | DELETE /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption |
SquareConnect.V1ItemsApi | deletePage | DELETE /v1/{location_id}/pages/{page_id} | DeletePage |
SquareConnect.V1ItemsApi | deletePageCell | DELETE /v1/{location_id}/pages/{page_id}/cells | DeletePageCell |
SquareConnect.V1ItemsApi | deleteVariation | DELETE /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation |
SquareConnect.V1ItemsApi | listCategories | GET /v1/{location_id}/categories | ListCategories |
SquareConnect.V1ItemsApi | listDiscounts | GET /v1/{location_id}/discounts | ListDiscounts |
SquareConnect.V1ItemsApi | listFees | GET /v1/{location_id}/fees | ListFees |
SquareConnect.V1ItemsApi | listInventory | GET /v1/{location_id}/inventory | ListInventory |
SquareConnect.V1ItemsApi | listItems | GET /v1/{location_id}/items | ListItems |
SquareConnect.V1ItemsApi | listModifierLists | GET /v1/{location_id}/modifier-lists | ListModifierLists |
SquareConnect.V1ItemsApi | listPages | GET /v1/{location_id}/pages | ListPages |
SquareConnect.V1ItemsApi | removeFee | DELETE /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee |
SquareConnect.V1ItemsApi | removeModifierList | DELETE /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList |
SquareConnect.V1ItemsApi | retrieveItem | GET /v1/{location_id}/items/{item_id} | RetrieveItem |
SquareConnect.V1ItemsApi | retrieveModifierList | GET /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList |
SquareConnect.V1ItemsApi | updateCategory | PUT /v1/{location_id}/categories/{category_id} | UpdateCategory |
SquareConnect.V1ItemsApi | updateDiscount | PUT /v1/{location_id}/discounts/{discount_id} | UpdateDiscount |
SquareConnect.V1ItemsApi | updateFee | PUT /v1/{location_id}/fees/{fee_id} | UpdateFee |
SquareConnect.V1ItemsApi | updateItem | PUT /v1/{location_id}/items/{item_id} | UpdateItem |
SquareConnect.V1ItemsApi | updateModifierList | PUT /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList |
SquareConnect.V1ItemsApi | updateModifierOption | PUT /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption |
SquareConnect.V1ItemsApi | updatePage | PUT /v1/{location_id}/pages/{page_id} | UpdatePage |
SquareConnect.V1ItemsApi | updatePageCell | PUT /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell |
SquareConnect.V1ItemsApi | updateVariation | PUT /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation |
SquareConnect.V1LocationsApi | listLocations | GET /v1/me/locations | ListLocations |
SquareConnect.V1LocationsApi | retrieveBusiness | GET /v1/me | RetrieveBusiness |
SquareConnect.V1TransactionsApi | createRefund | POST /v1/{location_id}/refunds | CreateRefund |
SquareConnect.V1TransactionsApi | listBankAccounts | GET /v1/{location_id}/bank-accounts | ListBankAccounts |
SquareConnect.V1TransactionsApi | listOrders | GET /v1/{location_id}/orders | ListOrders |
SquareConnect.V1TransactionsApi | listPayments | GET /v1/{location_id}/payments | ListPayments |
SquareConnect.V1TransactionsApi | listRefunds | GET /v1/{location_id}/refunds | ListRefunds |
SquareConnect.V1TransactionsApi | listSettlements | GET /v1/{location_id}/settlements | ListSettlements |
SquareConnect.V1TransactionsApi | retrieveBankAccount | GET /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount |
SquareConnect.V1TransactionsApi | retrieveOrder | GET /v1/{location_id}/orders/{order_id} | RetrieveOrder |
SquareConnect.V1TransactionsApi | retrievePayment | GET /v1/{location_id}/payments/{payment_id} | RetrievePayment |
SquareConnect.V1TransactionsApi | retrieveSettlement | GET /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement |
SquareConnect.V1TransactionsApi | updateOrder | PUT /v1/{location_id}/orders/{order_id} | UpdateOrder |
- SquareConnect.AcceptDisputeRequest
- SquareConnect.AcceptDisputeResponse
- SquareConnect.AccumulateLoyaltyPointsRequest
- SquareConnect.AccumulateLoyaltyPointsResponse
- SquareConnect.AddGroupToCustomerRequest
- SquareConnect.AddGroupToCustomerResponse
- SquareConnect.AdditionalRecipient
- SquareConnect.AdditionalRecipientReceivable
- SquareConnect.AdditionalRecipientReceivableRefund
- SquareConnect.Address
- SquareConnect.AdjustLoyaltyPointsRequest
- SquareConnect.AdjustLoyaltyPointsResponse
- SquareConnect.BalancePaymentDetails
- SquareConnect.BankAccount
- SquareConnect.BankAccountStatus
- SquareConnect.BankAccountType
- SquareConnect.BatchChangeInventoryRequest
- SquareConnect.BatchChangeInventoryResponse
- SquareConnect.BatchDeleteCatalogObjectsRequest
- SquareConnect.BatchDeleteCatalogObjectsResponse
- SquareConnect.BatchRetrieveCatalogObjectsRequest
- SquareConnect.BatchRetrieveCatalogObjectsResponse
- SquareConnect.BatchRetrieveInventoryChangesRequest
- SquareConnect.BatchRetrieveInventoryChangesResponse
- SquareConnect.BatchRetrieveInventoryCountsRequest
- SquareConnect.BatchRetrieveInventoryCountsResponse
- SquareConnect.BatchRetrieveOrdersRequest
- SquareConnect.BatchRetrieveOrdersResponse
- SquareConnect.BatchUpsertCatalogObjectsRequest
- SquareConnect.BatchUpsertCatalogObjectsResponse
- SquareConnect.BreakType
- SquareConnect.BusinessHours
- SquareConnect.BusinessHoursPeriod
- SquareConnect.CalculateLoyaltyPointsRequest
- SquareConnect.CalculateLoyaltyPointsResponse
- SquareConnect.CalculateOrderRequest
- SquareConnect.CalculateOrderResponse
- SquareConnect.CancelPaymentByIdempotencyKeyRequest
- SquareConnect.CancelPaymentByIdempotencyKeyResponse
- SquareConnect.CancelPaymentRequest
- SquareConnect.CancelPaymentResponse
- SquareConnect.CancelTerminalCheckoutRequest
- SquareConnect.CancelTerminalCheckoutResponse
- SquareConnect.CaptureTransactionRequest
- SquareConnect.CaptureTransactionResponse
- SquareConnect.Card
- SquareConnect.CardBrand
- SquareConnect.CardPaymentDetails
- SquareConnect.CardPrepaidType
- SquareConnect.CardType
- SquareConnect.CashDrawerDevice
- SquareConnect.CashDrawerEventType
- SquareConnect.CashDrawerShift
- SquareConnect.CashDrawerShiftEvent
- SquareConnect.CashDrawerShiftState
- SquareConnect.CashDrawerShiftSummary
- SquareConnect.CatalogCategory
- SquareConnect.CatalogCustomAttributeDefinition
- SquareConnect.CatalogCustomAttributeDefinitionAppVisibility
- SquareConnect.CatalogCustomAttributeDefinitionNumberConfig
- SquareConnect.CatalogCustomAttributeDefinitionSelectionConfig
- SquareConnect.CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
- SquareConnect.CatalogCustomAttributeDefinitionSellerVisibility
- SquareConnect.CatalogCustomAttributeDefinitionStringConfig
- SquareConnect.CatalogCustomAttributeDefinitionType
- SquareConnect.CatalogCustomAttributeValue
- SquareConnect.CatalogDiscount
- SquareConnect.CatalogDiscountModifyTaxBasis
- SquareConnect.CatalogDiscountType
- SquareConnect.CatalogIdMapping
- SquareConnect.CatalogImage
- SquareConnect.CatalogInfoRequest
- SquareConnect.CatalogInfoResponse
- SquareConnect.CatalogInfoResponseLimits
- SquareConnect.CatalogItem
- SquareConnect.CatalogItemModifierListInfo
- SquareConnect.CatalogItemOption
- SquareConnect.CatalogItemOptionForItem
- SquareConnect.CatalogItemOptionValue
- SquareConnect.CatalogItemOptionValueForItemVariation
- SquareConnect.CatalogItemProductType
- SquareConnect.CatalogItemVariation
- SquareConnect.CatalogMeasurementUnit
- SquareConnect.CatalogModifier
- SquareConnect.CatalogModifierList
- SquareConnect.CatalogModifierListSelectionType
- SquareConnect.CatalogModifierOverride
- SquareConnect.CatalogObject
- SquareConnect.CatalogObjectBatch
- SquareConnect.CatalogObjectType
- SquareConnect.CatalogPricingRule
- SquareConnect.CatalogPricingType
- SquareConnect.CatalogProductSet
- SquareConnect.CatalogQuery
- SquareConnect.CatalogQueryCustomAttributeUsage
- SquareConnect.CatalogQueryExact
- SquareConnect.CatalogQueryFilteredItems
- SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilter
- SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilterFilterType
- SquareConnect.CatalogQueryFilteredItemsNullableAttribute
- SquareConnect.CatalogQueryFilteredItemsStockLevel
- SquareConnect.CatalogQueryItemVariationsForItemOptionValues
- SquareConnect.CatalogQueryItemsForItemOptions
- SquareConnect.CatalogQueryItemsForModifierList
- SquareConnect.CatalogQueryItemsForTax
- SquareConnect.CatalogQueryPrefix
- SquareConnect.CatalogQueryRange
- SquareConnect.CatalogQuerySortedAttribute
- SquareConnect.CatalogQueryText
- SquareConnect.CatalogQuickAmount
- SquareConnect.CatalogQuickAmountType
- SquareConnect.CatalogQuickAmountsSettings
- SquareConnect.CatalogQuickAmountsSettingsOption
- SquareConnect.CatalogTax
- SquareConnect.CatalogTimePeriod
- SquareConnect.CatalogV1Id
- SquareConnect.ChargeRequest
- SquareConnect.ChargeRequestAdditionalRecipient
- SquareConnect.ChargeResponse
- SquareConnect.Checkout
- SquareConnect.CompletePaymentRequest
- SquareConnect.CompletePaymentResponse
- SquareConnect.Coordinates
- SquareConnect.Country
- SquareConnect.CreateBreakTypeRequest
- SquareConnect.CreateBreakTypeResponse
- SquareConnect.CreateCatalogImageRequest
- SquareConnect.CreateCatalogImageResponse
- SquareConnect.CreateCheckoutRequest
- SquareConnect.CreateCheckoutResponse
- SquareConnect.CreateCustomerCardRequest
- SquareConnect.CreateCustomerCardResponse
- SquareConnect.CreateCustomerGroupRequest
- SquareConnect.CreateCustomerGroupResponse
- SquareConnect.CreateCustomerRequest
- SquareConnect.CreateCustomerResponse
- SquareConnect.CreateDeviceCodeRequest
- SquareConnect.CreateDeviceCodeResponse
- SquareConnect.CreateDisputeEvidenceFileRequest
- SquareConnect.CreateDisputeEvidenceFileResponse
- SquareConnect.CreateDisputeEvidenceTextRequest
- SquareConnect.CreateDisputeEvidenceTextResponse
- SquareConnect.CreateLocationRequest
- SquareConnect.CreateLocationResponse
- SquareConnect.CreateLoyaltyAccountRequest
- SquareConnect.CreateLoyaltyAccountResponse
- SquareConnect.CreateLoyaltyRewardRequest
- SquareConnect.CreateLoyaltyRewardResponse
- SquareConnect.CreateMobileAuthorizationCodeRequest
- SquareConnect.CreateMobileAuthorizationCodeResponse
- SquareConnect.CreateOrderRequest
- SquareConnect.CreateOrderResponse
- SquareConnect.CreatePaymentRequest
- SquareConnect.CreatePaymentResponse
- SquareConnect.CreateRefundRequest
- SquareConnect.CreateRefundResponse
- SquareConnect.CreateShiftRequest
- SquareConnect.CreateShiftResponse
- SquareConnect.CreateTerminalCheckoutRequest
- SquareConnect.CreateTerminalCheckoutResponse
- SquareConnect.Currency
- SquareConnect.Customer
- SquareConnect.CustomerCreationSource
- SquareConnect.CustomerCreationSourceFilter
- SquareConnect.CustomerFilter
- SquareConnect.CustomerGroup
- SquareConnect.CustomerGroupInfo
- SquareConnect.CustomerInclusionExclusion
- SquareConnect.CustomerPreferences
- SquareConnect.CustomerQuery
- SquareConnect.CustomerSegment
- SquareConnect.CustomerSort
- SquareConnect.CustomerSortField
- SquareConnect.CustomerTextFilter
- SquareConnect.DateRange
- SquareConnect.DayOfWeek
- SquareConnect.DeleteBreakTypeRequest
- SquareConnect.DeleteBreakTypeResponse
- SquareConnect.DeleteCatalogObjectRequest
- SquareConnect.DeleteCatalogObjectResponse
- SquareConnect.DeleteCustomerCardRequest
- SquareConnect.DeleteCustomerCardResponse
- SquareConnect.DeleteCustomerGroupRequest
- SquareConnect.DeleteCustomerGroupResponse
- SquareConnect.DeleteCustomerRequest
- SquareConnect.DeleteCustomerResponse
- SquareConnect.DeleteLoyaltyRewardRequest
- SquareConnect.DeleteLoyaltyRewardResponse
- SquareConnect.DeleteShiftRequest
- SquareConnect.DeleteShiftResponse
- SquareConnect.Device
- SquareConnect.DeviceCheckoutOptions
- SquareConnect.DeviceCode
- SquareConnect.DeviceCodeStatus
- SquareConnect.DeviceDetails
- SquareConnect.Dispute
- SquareConnect.DisputeEvidence
- SquareConnect.DisputeEvidenceFile
- SquareConnect.DisputeEvidenceType
- SquareConnect.DisputeReason
- SquareConnect.DisputeState
- SquareConnect.DisputedPayment
- SquareConnect.EcomVisibility
- SquareConnect.Employee
- SquareConnect.EmployeeStatus
- SquareConnect.EmployeeWage
- SquareConnect.Error
- SquareConnect.ErrorCategory
- SquareConnect.ErrorCode
- SquareConnect.ExcludeStrategy
- SquareConnect.FilterValue
- SquareConnect.GetBankAccountByV1IdRequest
- SquareConnect.GetBankAccountByV1IdResponse
- SquareConnect.GetBankAccountRequest
- SquareConnect.GetBankAccountResponse
- SquareConnect.GetBreakTypeRequest
- SquareConnect.GetBreakTypeResponse
- SquareConnect.GetDeviceCodeRequest
- SquareConnect.GetDeviceCodeResponse
- SquareConnect.GetEmployeeWageRequest
- SquareConnect.GetEmployeeWageResponse
- SquareConnect.GetPaymentRefundRequest
- SquareConnect.GetPaymentRefundResponse
- SquareConnect.GetPaymentRequest
- SquareConnect.GetPaymentResponse
- SquareConnect.GetShiftRequest
- SquareConnect.GetShiftResponse
- SquareConnect.GetTerminalCheckoutRequest
- SquareConnect.GetTerminalCheckoutResponse
- SquareConnect.InventoryAdjustment
- SquareConnect.InventoryAlertType
- SquareConnect.InventoryChange
- SquareConnect.InventoryChangeType
- SquareConnect.InventoryCount
- SquareConnect.InventoryPhysicalCount
- SquareConnect.InventoryState
- SquareConnect.InventoryTransfer
- SquareConnect.ItemVariationLocationOverrides
- SquareConnect.ListAdditionalRecipientReceivableRefundsRequest
- SquareConnect.ListAdditionalRecipientReceivableRefundsResponse
- SquareConnect.ListAdditionalRecipientReceivablesRequest
- SquareConnect.ListAdditionalRecipientReceivablesResponse
- SquareConnect.ListBankAccountsRequest
- SquareConnect.ListBankAccountsResponse
- SquareConnect.ListBreakTypesRequest
- SquareConnect.ListBreakTypesResponse
- SquareConnect.ListCashDrawerShiftEventsRequest
- SquareConnect.ListCashDrawerShiftEventsResponse
- SquareConnect.ListCashDrawerShiftsRequest
- SquareConnect.ListCashDrawerShiftsResponse
- SquareConnect.ListCatalogRequest
- SquareConnect.ListCatalogResponse
- SquareConnect.ListCustomerGroupsRequest
- SquareConnect.ListCustomerGroupsResponse
- SquareConnect.ListCustomerSegmentsRequest
- SquareConnect.ListCustomerSegmentsResponse
- SquareConnect.ListCustomersRequest
- SquareConnect.ListCustomersResponse
- SquareConnect.ListDeviceCodesRequest
- SquareConnect.ListDeviceCodesResponse
- SquareConnect.ListDisputeEvidenceRequest
- SquareConnect.ListDisputeEvidenceResponse
- SquareConnect.ListDisputesRequest
- SquareConnect.ListDisputesResponse
- SquareConnect.ListEmployeeWagesRequest
- SquareConnect.ListEmployeeWagesResponse
- SquareConnect.ListEmployeesRequest
- SquareConnect.ListEmployeesResponse
- SquareConnect.ListLocationsRequest
- SquareConnect.ListLocationsResponse
- SquareConnect.ListLoyaltyProgramsRequest
- SquareConnect.ListLoyaltyProgramsResponse
- SquareConnect.ListMerchantsRequest
- SquareConnect.ListMerchantsResponse
- SquareConnect.ListPaymentRefundsRequest
- SquareConnect.ListPaymentRefundsResponse
- SquareConnect.ListPaymentsRequest
- SquareConnect.ListPaymentsResponse
- SquareConnect.ListRefundsRequest
- SquareConnect.ListRefundsResponse
- SquareConnect.ListTransactionsRequest
- SquareConnect.ListTransactionsResponse
- SquareConnect.ListWorkweekConfigsRequest
- SquareConnect.ListWorkweekConfigsResponse
- SquareConnect.Location
- SquareConnect.LocationCapability
- SquareConnect.LocationStatus
- SquareConnect.LocationType
- SquareConnect.LoyaltyAccount
- SquareConnect.LoyaltyAccountMapping
- SquareConnect.LoyaltyAccountMappingType
- SquareConnect.LoyaltyEvent
- SquareConnect.LoyaltyEventAccumulatePoints
- SquareConnect.LoyaltyEventAdjustPoints
- SquareConnect.LoyaltyEventCreateReward
- SquareConnect.LoyaltyEventDateTimeFilter
- SquareConnect.LoyaltyEventDeleteReward
- SquareConnect.LoyaltyEventExpirePoints
- SquareConnect.LoyaltyEventFilter
- SquareConnect.LoyaltyEventLocationFilter
- SquareConnect.LoyaltyEventLoyaltyAccountFilter
- SquareConnect.LoyaltyEventOrderFilter
- SquareConnect.LoyaltyEventOther
- SquareConnect.LoyaltyEventQuery
- SquareConnect.LoyaltyEventRedeemReward
- SquareConnect.LoyaltyEventSource
- SquareConnect.LoyaltyEventType
- SquareConnect.LoyaltyEventTypeFilter
- SquareConnect.LoyaltyProgram
- SquareConnect.LoyaltyProgramAccrualRule
- SquareConnect.LoyaltyProgramAccrualRuleType
- SquareConnect.LoyaltyProgramExpirationPolicy
- SquareConnect.LoyaltyProgramRewardDefinition
- SquareConnect.LoyaltyProgramRewardDefinitionScope
- SquareConnect.LoyaltyProgramRewardDefinitionType
- SquareConnect.LoyaltyProgramRewardTier
- SquareConnect.LoyaltyProgramStatus
- SquareConnect.LoyaltyProgramTerminology
- SquareConnect.LoyaltyReward
- SquareConnect.LoyaltyRewardStatus
- SquareConnect.MeasurementUnit
- SquareConnect.MeasurementUnitArea
- SquareConnect.MeasurementUnitCustom
- SquareConnect.MeasurementUnitGeneric
- SquareConnect.MeasurementUnitLength
- SquareConnect.MeasurementUnitTime
- SquareConnect.MeasurementUnitUnitType
- SquareConnect.MeasurementUnitVolume
- SquareConnect.MeasurementUnitWeight
- SquareConnect.Merchant
- SquareConnect.MerchantStatus
- SquareConnect.MethodErrorCodes
- SquareConnect.ModelBreak
- SquareConnect.Money
- SquareConnect.ObtainTokenRequest
- SquareConnect.ObtainTokenResponse
- SquareConnect.Order
- SquareConnect.OrderCreated
- SquareConnect.OrderCreatedObject
- SquareConnect.OrderEntry
- SquareConnect.OrderFulfillment
- SquareConnect.OrderFulfillmentPickupDetails
- SquareConnect.OrderFulfillmentPickupDetailsCurbsidePickupDetails
- SquareConnect.OrderFulfillmentPickupDetailsScheduleType
- SquareConnect.OrderFulfillmentRecipient
- SquareConnect.OrderFulfillmentShipmentDetails
- SquareConnect.OrderFulfillmentState
- SquareConnect.OrderFulfillmentType
- SquareConnect.OrderFulfillmentUpdated
- SquareConnect.OrderFulfillmentUpdatedObject
- SquareConnect.OrderFulfillmentUpdatedUpdate
- SquareConnect.OrderLineItem
- SquareConnect.OrderLineItemAppliedDiscount
- SquareConnect.OrderLineItemAppliedTax
- SquareConnect.OrderLineItemDiscount
- SquareConnect.OrderLineItemDiscountScope
- SquareConnect.OrderLineItemDiscountType
- SquareConnect.OrderLineItemModifier
- SquareConnect.OrderLineItemTax
- SquareConnect.OrderLineItemTaxScope
- SquareConnect.OrderLineItemTaxType
- SquareConnect.OrderMoneyAmounts
- SquareConnect.OrderQuantityUnit
- SquareConnect.OrderReturn
- SquareConnect.OrderReturnDiscount
- SquareConnect.OrderReturnLineItem
- SquareConnect.OrderReturnLineItemModifier
- SquareConnect.OrderReturnServiceCharge
- SquareConnect.OrderReturnTax
- SquareConnect.OrderReward
- SquareConnect.OrderRoundingAdjustment
- SquareConnect.OrderServiceCharge
- SquareConnect.OrderServiceChargeCalculationPhase
- SquareConnect.OrderSource
- SquareConnect.OrderState
- SquareConnect.OrderUpdated
- SquareConnect.OrderUpdatedObject
- SquareConnect.PayOrderRequest
- SquareConnect.PayOrderResponse
- SquareConnect.Payment
- SquareConnect.PaymentOptions
- SquareConnect.PaymentRefund
- SquareConnect.ProcessingFee
- SquareConnect.Product
- SquareConnect.ProductType
- SquareConnect.RedeemLoyaltyRewardRequest
- SquareConnect.RedeemLoyaltyRewardResponse
- SquareConnect.Refund
- SquareConnect.RefundPaymentRequest
- SquareConnect.RefundPaymentResponse
- SquareConnect.RefundStatus
- SquareConnect.RegisterDomainRequest
- SquareConnect.RegisterDomainResponse
- SquareConnect.RegisterDomainResponseStatus
- SquareConnect.RemoveDisputeEvidenceRequest
- SquareConnect.RemoveDisputeEvidenceResponse
- SquareConnect.RemoveGroupFromCustomerRequest
- SquareConnect.RemoveGroupFromCustomerResponse
- SquareConnect.RenewTokenRequest
- SquareConnect.RenewTokenResponse
- SquareConnect.RetrieveCashDrawerShiftRequest
- SquareConnect.RetrieveCashDrawerShiftResponse
- SquareConnect.RetrieveCatalogObjectRequest
- SquareConnect.RetrieveCatalogObjectResponse
- SquareConnect.RetrieveCustomerGroupRequest
- SquareConnect.RetrieveCustomerGroupResponse
- SquareConnect.RetrieveCustomerRequest
- SquareConnect.RetrieveCustomerResponse
- SquareConnect.RetrieveCustomerSegmentRequest
- SquareConnect.RetrieveCustomerSegmentResponse
- SquareConnect.RetrieveDisputeEvidenceRequest
- SquareConnect.RetrieveDisputeEvidenceResponse
- SquareConnect.RetrieveDisputeRequest
- SquareConnect.RetrieveDisputeResponse
- SquareConnect.RetrieveEmployeeRequest
- SquareConnect.RetrieveEmployeeResponse
- SquareConnect.RetrieveInventoryAdjustmentRequest
- SquareConnect.RetrieveInventoryAdjustmentResponse
- SquareConnect.RetrieveInventoryChangesRequest
- SquareConnect.RetrieveInventoryChangesResponse
- SquareConnect.RetrieveInventoryCountRequest
- SquareConnect.RetrieveInventoryCountResponse
- SquareConnect.RetrieveInventoryPhysicalCountRequest
- SquareConnect.RetrieveInventoryPhysicalCountResponse
- SquareConnect.RetrieveLocationRequest
- SquareConnect.RetrieveLocationResponse
- SquareConnect.RetrieveLoyaltyAccountRequest
- SquareConnect.RetrieveLoyaltyAccountResponse
- SquareConnect.RetrieveLoyaltyRewardRequest
- SquareConnect.RetrieveLoyaltyRewardResponse
- SquareConnect.RetrieveMerchantRequest
- SquareConnect.RetrieveMerchantResponse
- SquareConnect.RetrieveTransactionRequest
- SquareConnect.RetrieveTransactionResponse
- SquareConnect.RevokeTokenRequest
- SquareConnect.RevokeTokenResponse
- SquareConnect.SearchCatalogObjectsRequest
- SquareConnect.SearchCatalogObjectsResponse
- SquareConnect.SearchCustomersRequest
- SquareConnect.SearchCustomersResponse
- SquareConnect.SearchLoyaltyAccountsRequest
- SquareConnect.SearchLoyaltyAccountsRequestLoyaltyAccountQuery
- SquareConnect.SearchLoyaltyAccountsResponse
- SquareConnect.SearchLoyaltyEventsRequest
- SquareConnect.SearchLoyaltyEventsResponse
- SquareConnect.SearchLoyaltyRewardsRequest
- SquareConnect.SearchLoyaltyRewardsRequestLoyaltyRewardQuery
- SquareConnect.SearchLoyaltyRewardsResponse
- SquareConnect.SearchOrdersCustomerFilter
- SquareConnect.SearchOrdersDateTimeFilter
- SquareConnect.SearchOrdersFilter
- SquareConnect.SearchOrdersFulfillmentFilter
- SquareConnect.SearchOrdersQuery
- SquareConnect.SearchOrdersRequest
- SquareConnect.SearchOrdersResponse
- SquareConnect.SearchOrdersSort
- SquareConnect.SearchOrdersSortField
- SquareConnect.SearchOrdersSourceFilter
- SquareConnect.SearchOrdersStateFilter
- SquareConnect.SearchShiftsRequest
- SquareConnect.SearchShiftsResponse
- SquareConnect.SearchTerminalCheckoutsRequest
- SquareConnect.SearchTerminalCheckoutsResponse
- SquareConnect.Shift
- SquareConnect.ShiftFilter
- SquareConnect.ShiftFilterStatus
- SquareConnect.ShiftQuery
- SquareConnect.ShiftSort
- SquareConnect.ShiftSortField
- SquareConnect.ShiftStatus
- SquareConnect.ShiftWage
- SquareConnect.ShiftWorkday
- SquareConnect.ShiftWorkdayMatcher
- SquareConnect.SortOrder
- SquareConnect.SourceApplication
- SquareConnect.StandardUnitDescription
- SquareConnect.StandardUnitDescriptionGroup
- SquareConnect.SubmitEvidenceRequest
- SquareConnect.SubmitEvidenceResponse
- SquareConnect.TaxCalculationPhase
- SquareConnect.TaxInclusionType
- SquareConnect.Tender
- SquareConnect.TenderCardDetails
- SquareConnect.TenderCardDetailsEntryMethod
- SquareConnect.TenderCardDetailsStatus
- SquareConnect.TenderCashDetails
- SquareConnect.TenderType
- SquareConnect.TerminalCheckout
- SquareConnect.TerminalCheckoutCancelReason
- SquareConnect.TerminalCheckoutQuery
- SquareConnect.TerminalCheckoutQueryFilter
- SquareConnect.TerminalCheckoutQuerySort
- SquareConnect.TimeRange
- SquareConnect.TipSettings
- SquareConnect.Transaction
- SquareConnect.TransactionProduct
- SquareConnect.TransactionType
- SquareConnect.UpdateBreakTypeRequest
- SquareConnect.UpdateBreakTypeResponse
- SquareConnect.UpdateCustomerGroupRequest
- SquareConnect.UpdateCustomerGroupResponse
- SquareConnect.UpdateCustomerRequest
- SquareConnect.UpdateCustomerResponse
- SquareConnect.UpdateItemModifierListsRequest
- SquareConnect.UpdateItemModifierListsResponse
- SquareConnect.UpdateItemTaxesRequest
- SquareConnect.UpdateItemTaxesResponse
- SquareConnect.UpdateLocationRequest
- SquareConnect.UpdateLocationResponse
- SquareConnect.UpdateOrderRequest
- SquareConnect.UpdateOrderResponse
- SquareConnect.UpdateShiftRequest
- SquareConnect.UpdateShiftResponse
- SquareConnect.UpdateWorkweekConfigRequest
- SquareConnect.UpdateWorkweekConfigResponse
- SquareConnect.UpsertCatalogObjectRequest
- SquareConnect.UpsertCatalogObjectResponse
- SquareConnect.V1AdjustInventoryRequest
- SquareConnect.V1AdjustInventoryRequestAdjustmentType
- SquareConnect.V1ApplyFeeRequest
- SquareConnect.V1ApplyModifierListRequest
- SquareConnect.V1BankAccount
- SquareConnect.V1BankAccountType
- SquareConnect.V1CashDrawerEvent
- SquareConnect.V1CashDrawerEventEventType
- SquareConnect.V1CashDrawerShift
- SquareConnect.V1CashDrawerShiftEventType
- SquareConnect.V1Category
- SquareConnect.V1CreateCategoryRequest
- SquareConnect.V1CreateDiscountRequest
- SquareConnect.V1CreateEmployeeRoleRequest
- SquareConnect.V1CreateFeeRequest
- SquareConnect.V1CreateItemRequest
- SquareConnect.V1CreateModifierListRequest
- SquareConnect.V1CreateModifierOptionRequest
- SquareConnect.V1CreatePageRequest
- SquareConnect.V1CreateRefundRequest
- SquareConnect.V1CreateRefundRequestType
- SquareConnect.V1CreateVariationRequest
- SquareConnect.V1DeleteCategoryRequest
- SquareConnect.V1DeleteDiscountRequest
- SquareConnect.V1DeleteFeeRequest
- SquareConnect.V1DeleteItemRequest
- SquareConnect.V1DeleteModifierListRequest
- SquareConnect.V1DeleteModifierOptionRequest
- SquareConnect.V1DeletePageCellRequest
- SquareConnect.V1DeletePageRequest
- SquareConnect.V1DeleteTimecardRequest
- SquareConnect.V1DeleteTimecardResponse
- SquareConnect.V1DeleteVariationRequest
- SquareConnect.V1Discount
- SquareConnect.V1DiscountColor
- SquareConnect.V1DiscountDiscountType
- SquareConnect.V1Employee
- SquareConnect.V1EmployeeRole
- SquareConnect.V1EmployeeRolePermissions
- SquareConnect.V1EmployeeStatus
- SquareConnect.V1Fee
- SquareConnect.V1FeeAdjustmentType
- SquareConnect.V1FeeCalculationPhase
- SquareConnect.V1FeeInclusionType
- SquareConnect.V1FeeType
- SquareConnect.V1InventoryEntry
- SquareConnect.V1Item
- SquareConnect.V1ItemColor
- SquareConnect.V1ItemImage
- SquareConnect.V1ItemType
- SquareConnect.V1ItemVisibility
- SquareConnect.V1ListBankAccountsRequest
- SquareConnect.V1ListBankAccountsResponse
- SquareConnect.V1ListCashDrawerShiftsRequest
- SquareConnect.V1ListCashDrawerShiftsResponse
- SquareConnect.V1ListCategoriesRequest
- SquareConnect.V1ListCategoriesResponse
- SquareConnect.V1ListDiscountsRequest
- SquareConnect.V1ListDiscountsResponse
- SquareConnect.V1ListEmployeeRolesRequest
- SquareConnect.V1ListEmployeeRolesResponse
- SquareConnect.V1ListEmployeesRequest
- SquareConnect.V1ListEmployeesRequestStatus
- SquareConnect.V1ListEmployeesResponse
- SquareConnect.V1ListFeesRequest
- SquareConnect.V1ListFeesResponse
- SquareConnect.V1ListInventoryRequest
- SquareConnect.V1ListInventoryResponse
- SquareConnect.V1ListItemsRequest
- SquareConnect.V1ListItemsResponse
- SquareConnect.V1ListLocationsRequest
- SquareConnect.V1ListLocationsResponse
- SquareConnect.V1ListModifierListsRequest
- SquareConnect.V1ListModifierListsResponse
- SquareConnect.V1ListOrdersRequest
- SquareConnect.V1ListOrdersResponse
- SquareConnect.V1ListPagesRequest
- SquareConnect.V1ListPagesResponse
- SquareConnect.V1ListPaymentsRequest
- SquareConnect.V1ListPaymentsResponse
- SquareConnect.V1ListRefundsRequest
- SquareConnect.V1ListRefundsResponse
- SquareConnect.V1ListSettlementsRequest
- SquareConnect.V1ListSettlementsRequestStatus
- SquareConnect.V1ListSettlementsResponse
- SquareConnect.V1ListTimecardEventsRequest
- SquareConnect.V1ListTimecardEventsResponse
- SquareConnect.V1ListTimecardsRequest
- SquareConnect.V1ListTimecardsResponse
- SquareConnect.V1Merchant
- SquareConnect.V1MerchantAccountType
- SquareConnect.V1MerchantBusinessType
- SquareConnect.V1MerchantLocationDetails
- SquareConnect.V1ModifierList
- SquareConnect.V1ModifierListSelectionType
- SquareConnect.V1ModifierOption
- SquareConnect.V1Money
- SquareConnect.V1Order
- SquareConnect.V1OrderHistoryEntry
- SquareConnect.V1OrderHistoryEntryAction
- SquareConnect.V1OrderState
- SquareConnect.V1Page
- SquareConnect.V1PageCell
- SquareConnect.V1PageCellObjectType
- SquareConnect.V1PageCellPlaceholderType
- SquareConnect.V1Payment
- SquareConnect.V1PaymentDiscount
- SquareConnect.V1PaymentItemDetail
- SquareConnect.V1PaymentItemization
- SquareConnect.V1PaymentItemizationItemizationType
- SquareConnect.V1PaymentModifier
- SquareConnect.V1PaymentSurcharge
- SquareConnect.V1PaymentSurchargeType
- SquareConnect.V1PaymentTax
- SquareConnect.V1PaymentTaxInclusionType
- SquareConnect.V1PhoneNumber
- SquareConnect.V1Refund
- SquareConnect.V1RefundType
- SquareConnect.V1RemoveFeeRequest
- SquareConnect.V1RemoveModifierListRequest
- SquareConnect.V1RetrieveBankAccountRequest
- SquareConnect.V1RetrieveBusinessRequest
- SquareConnect.V1RetrieveCashDrawerShiftRequest
- SquareConnect.V1RetrieveEmployeeRequest
- SquareConnect.V1RetrieveEmployeeRoleRequest
- SquareConnect.V1RetrieveItemRequest
- SquareConnect.V1RetrieveModifierListRequest
- SquareConnect.V1RetrieveOrderRequest
- SquareConnect.V1RetrievePaymentRequest
- SquareConnect.V1RetrieveSettlementRequest
- SquareConnect.V1RetrieveTimecardRequest
- SquareConnect.V1Settlement
- SquareConnect.V1SettlementEntry
- SquareConnect.V1SettlementEntryType
- SquareConnect.V1SettlementStatus
- SquareConnect.V1Tender
- SquareConnect.V1TenderCardBrand
- SquareConnect.V1TenderEntryMethod
- SquareConnect.V1TenderType
- SquareConnect.V1Timecard
- SquareConnect.V1TimecardEvent
- SquareConnect.V1TimecardEventEventType
- SquareConnect.V1UpdateCategoryRequest
- SquareConnect.V1UpdateDiscountRequest
- SquareConnect.V1UpdateEmployeeRequest
- SquareConnect.V1UpdateEmployeeRoleRequest
- SquareConnect.V1UpdateFeeRequest
- SquareConnect.V1UpdateItemRequest
- SquareConnect.V1UpdateModifierListRequest
- SquareConnect.V1UpdateModifierListRequestSelectionType
- SquareConnect.V1UpdateModifierOptionRequest
- SquareConnect.V1UpdateOrderRequest
- SquareConnect.V1UpdateOrderRequestAction
- SquareConnect.V1UpdatePageCellRequest
- SquareConnect.V1UpdatePageRequest
- SquareConnect.V1UpdateTimecardRequest
- SquareConnect.V1UpdateVariationRequest
- SquareConnect.V1Variation
- SquareConnect.V1VariationInventoryAlertType
- SquareConnect.V1VariationPricingType
- SquareConnect.VoidTransactionRequest
- SquareConnect.VoidTransactionResponse
- SquareConnect.Weekday
- SquareConnect.WorkweekConfig
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://connect.squareup.com/oauth2/authorize
- Scopes:
- BANK_ACCOUNTS_READ: HTTP Method: `GET` Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint.
- CASH_DRAWER_READ: HTTP Method: `GET` Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint.
- CUSTOMERS_READ: HTTP Method: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint.
- CUSTOMERS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles.
- DEVICE_CREDENTIAL_MANAGEMENT: HTTP Method: `POST`, `GET` Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint.
- EMPLOYEES_READ: HTTP Method: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
- EMPLOYEES_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles.
- INVENTORY_READ: HTTP Method: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
- INVENTORY_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
- ITEMS_READ: HTTP Method: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
- ITEMS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog.
- LOYALTY_READ: HTTP Method: `GET` Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint.
- LOYALTY_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint.
- MERCHANT_PROFILE_READ: HTTP Method: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
- ORDERS_READ: HTTP Method: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
- ORDERS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint.
- PAYMENTS_READ: HTTP Method: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
- PAYMENTS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API.
- PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: HTTP Method: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. Required to use multiparty transaction functionality with the Payments API.
- PAYMENTS_WRITE_IN_PERSON: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to payments and refunds information. For example, to process in-person payments.
- SETTLEMENTS_READ: HTTP Method: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
- TIMECARDS_READ: HTTP Method: `GET` Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint.
- TIMECARDS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to employee shift information. For example, to create and modify employee shifts.
- TIMECARDS_SETTINGS_READ: HTTP Method: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
- TIMECARDS_SETTINGS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
V1 Endpoints return pagination information via HTTP headers. In order to obtain
response headers and extract the batch_token
parameter you will need to follow
the following steps:
-
Use the full information endpoint methods of each API to get the response HTTP Headers. They are named as their simple counterpart with a
WithHttpInfo
suffix. HencelistEmployeeRoles
would be calledlistEmployeeRolesWithHttpInfo
. This method returns aCompleteResponse
object with the response data deserialized along with a helper to retrieve the token if present. -
Use
var batchToken = completeResponse.batch_token;
to extract the token and proceed to get the following page if a token is present.
var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";
var api = new SquareConnect.V1EmployeesApi();
var opts = {
order: "order_example",
limit: 56,
batch_token: null
}
function getAllEmployeeRoles(batch_token){
if (batch_token) {
api.listEmployeeRolesWithHttpInfo(opts).then(function(resp) {
var batch_token = resp.batch_token;
opts['batch_token'] = batch_token;
getAllEmployeeRoles(token);
}, function(error) {
console.error(error);
});
}
}
getAllEmployeeRoles(true);
Send bug reports, feature requests, and code contributions to the API specifications repository, as this repository contains only the generated SDK code.
Copyright 2017 Square, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.