Connectors

Finance, Billing & Payments

Square

Payments and commerce: payments, orders, customers, catalog, and inventory

Square API referenceAPI checked August 18, 2026

Signs in with: API token
Runs on: Cloud or On-Prem Worker
Operations: 334
Ready-made triggers: 42

Connect Square

In Neblex open Connect › Connections and click New Connection.
Search for Square and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

Field	What to enter
Access tokenRequiredSecret
OAuth application secretOptionalSecret

Triggers

Start a flow when something changes in Square: add a Poll for changes trigger, choose Square and pick the event.

Event	What it does	How
New or updated bankaccount	Fires for each bankaccount that appears or changes since the last check.	Checks for changes
New or updated booking	Fires for each booking that appears or changes since the last check.	Checks for changes
New or updated labor	Fires for each labor that appears or changes since the last check.	Checks for changes
New or updated card	Fires for each card that appears or changes since the last check.	Checks for changes
New or updated catalog	Fires for each catalog that appears or changes since the last check.	Checks for changes
New or updated channel	Fires for each channel that appears or changes since the last check.	Checks for changes
New or updated customergroup	Fires for each customergroup that appears or changes since the last check.	Checks for changes
New or updated customer	Fires for each customer that appears or changes since the last check.	Checks for changes
New or updated device	Fires for each device that appears or changes since the last check.	Checks for changes
New or updated dispute	Fires for each dispute that appears or changes since the last check.	Checks for changes
New or updated giftcardactivity	Fires for each giftcardactivity that appears or changes since the last check.	Checks for changes
New or updated giftcard	Fires for each giftcard that appears or changes since the last check.	Checks for changes
New or updated invoice	Fires for each invoice that appears or changes since the last check.	Checks for changes
New or updated team	Fires for each team that appears or changes since the last check.	Checks for changes
New or updated loyalty	Fires for each loyalty that appears or changes since the last check.	Checks for changes
New or updated checkout	Fires for each checkout that appears or changes since the last check.	Checks for changes
New or updated refund	Fires for each refund that appears or changes since the last check.	Checks for changes
New or updated payment	Fires for each payment that appears or changes since the last check.	Checks for changes
New or updated subscription	Fires for each subscription that appears or changes since the last check.	Checks for changes
New or updated transaction	Fires for each transaction that appears or changes since the last check.	Checks for changes
New or updated webhooksubscription	Fires for each webhooksubscription that appears or changes since the last check.	Checks for changes
New bankaccount	Fires for each bankaccount that appears since the last check.	Checks for changes
New booking	Fires for each booking that appears since the last check.	Checks for changes
New labor	Fires for each labor that appears since the last check.	Checks for changes
New card	Fires for each card that appears since the last check.	Checks for changes
New catalog	Fires for each catalog that appears since the last check.	Checks for changes
New channel	Fires for each channel that appears since the last check.	Checks for changes
New customergroup	Fires for each customergroup that appears since the last check.	Checks for changes
New customer	Fires for each customer that appears since the last check.	Checks for changes
New device	Fires for each device that appears since the last check.	Checks for changes
New dispute	Fires for each dispute that appears since the last check.	Checks for changes
New giftcardactivity	Fires for each giftcardactivity that appears since the last check.	Checks for changes
New giftcard	Fires for each giftcard that appears since the last check.	Checks for changes
New invoice	Fires for each invoice that appears since the last check.	Checks for changes
New team	Fires for each team that appears since the last check.	Checks for changes
New loyalty	Fires for each loyalty that appears since the last check.	Checks for changes
New checkout	Fires for each checkout that appears since the last check.	Checks for changes
New refund	Fires for each refund that appears since the last check.	Checks for changes
New payment	Fires for each payment that appears since the last check.	Checks for changes
New subscription	Fires for each subscription that appears since the last check.	Checks for changes
New transaction	Fires for each transaction that appears since the last check.	Checks for changes
New webhooksubscription	Fires for each webhooksubscription that appears since the last check.	Checks for changes

Use it in a flow

Open a flow, open the node library and search for Square.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

Operations

334 operations in 43 groups. Each one is a step you can add to a flow.

ApplePay1

Register DomainRegisterDomain POST Activates a domain for use with Apple Pay on the Web and Square.

BankAccount5

Create Bank Account`CreateBankAccount`	POST	Store a bank account on file for a square account
Disable Bank Account`DisableBankAccount`	POST	Disable a bank account.
Get Bank Account`GetBankAccount`	GET	Retrieve details of a BankAccount bank account linked to a Square account.
Get Bank Account By V 1 Id`GetBankAccountByV1Id`	GET	Returns details of a BankAccount identified by V1 bank account ID.
List Bank Accounts`ListBankAccounts`	GET	Returns a list of BankAccount objects linked to a Square account.

Booking13

Bulk Retrieve Bookings`BulkRetrieveBookings`	POST	Bulk-Retrieves a list of bookings by booking IDs.
Bulk Retrieve Team Member Booking Profiles`BulkRetrieveTeamMemberBookingProfiles`	POST	Retrieves one or more team members' booking profiles.
Cancel Booking`CancelBooking`	POST	Cancels an existing booking.
Create Booking`CreateBooking`	POST	Creates a booking.
List Bookings`ListBookings`	GET	Retrieve a collection of bookings.
List Location Booking Profiles`ListLocationBookingProfiles`	GET	Lists location booking profiles of a seller.
List Team Member Booking Profiles`ListTeamMemberBookingProfiles`	GET	Lists booking profiles for team members.
Retrieve Booking`RetrieveBooking`	GET	Retrieves a booking.
Retrieve Business Booking Profile`RetrieveBusinessBookingProfile`	GET	Retrieves a seller's booking profile.
Retrieve Location Booking Profile`RetrieveLocationBookingProfile`	GET	Retrieves a seller's location booking profile.
Retrieve Team Member Booking Profile`RetrieveTeamMemberBookingProfile`	GET	Retrieves a team member's booking profile.
Search Availability`SearchAvailability`	POST	Searches for availabilities for booking.
Update Booking`UpdateBooking`	PUT	Updates a booking.

BookingCustomAttribute11

Bulk Delete Booking Custom Attributes`BulkDeleteBookingCustomAttributes`	POST	Bulk deletes bookings custom attributes.
Bulk Upsert Booking Custom Attributes`BulkUpsertBookingCustomAttributes`	POST	Bulk upserts bookings custom attributes.
Create Booking Custom Attribute Definition`CreateBookingCustomAttributeDefinition`	POST	Creates a bookings custom attribute definition.
Delete Booking Custom Attribute`DeleteBookingCustomAttribute`	DELETE	Deletes a bookings custom attribute.
Delete Booking Custom Attribute Definition`DeleteBookingCustomAttributeDefinition`	DELETE	Deletes a bookings custom attribute definition.
List Booking Custom Attribute Definitions`ListBookingCustomAttributeDefinitions`	GET	Get all bookings custom attribute definitions.
List Booking Custom Attributes`ListBookingCustomAttributes`	GET	Lists a booking's custom attributes.
Retrieve Booking Custom Attribute`RetrieveBookingCustomAttribute`	GET	Retrieves a bookings custom attribute.
Retrieve Booking Custom Attribute Definition`RetrieveBookingCustomAttributeDefinition`	GET	Retrieves a bookings custom attribute definition.
Update Booking Custom Attribute Definition`UpdateBookingCustomAttributeDefinition`	PUT	Updates a bookings custom attribute definition.
Upsert Booking Custom Attribute`UpsertBookingCustomAttribute`	PUT	Upserts a bookings custom attribute.

Card4

Create Card`CreateCard`	POST	Adds a card on file to an existing merchant.
Disable Card`DisableCard`	POST	Disables the card, preventing any further updates or charges.
List Cards`ListCards`	GET	Retrieves a list of cards owned by the account making the request.
Retrieve Card`RetrieveCard`	GET	Retrieves details for a specific Card.

CashDrawer3

List Cash Drawer Shift Events`ListCashDrawerShiftEvents`	GET	Provides a paginated list of events for a single cash drawer shift.
List Cash Drawer Shifts`ListCashDrawerShifts`	GET	Provides the details for all of the cash drawer shifts for a location in a date range.
Retrieve Cash Drawer Shift`RetrieveCashDrawerShift`	GET	Provides the summary details for a single cash drawer shift.

Catalog14

Batch Delete Catalog Objects`BatchDeleteCatalogObjects`	POST	Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response.
Batch Retrieve Catalog Objects`BatchRetrieveCatalogObjects`	POST	Returns a set of objects based on the provided ID.
Batch Upsert Catalog Objects`BatchUpsertCatalogObjects`	POST	Creates or updates up to 10,000 target objects based on the provided list of objects.
Catalog Info`CatalogInfo`	GET	Retrieves information about the Square Catalog API, such as batch size limits that can be used by the BatchUpsertCatalogObjects endpoint.
Create Catalog Image`CreateCatalogImage`	POST	Uploads an image file to be represented by a CatalogImage object that can be linked to an existing CatalogObject instance.
Delete Catalog Object`DeleteCatalogObject`	DELETE	Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response.
List Catalog`ListCatalog`	GET	Returns a list of all CatalogObjects of the specified types in the catalog.
Retrieve Catalog Object`RetrieveCatalogObject`	GET	Returns a single CatalogItem as a CatalogObject based on the provided ID.
Search Catalog Items`SearchCatalogItems`	POST	Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters.
Search Catalog Objects`SearchCatalogObjects`	POST	Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified...
Update Catalog Image`UpdateCatalogImage`	PUT	Uploads a new image file to replace the existing one in the specified CatalogImage object.
Update Item Modifier Lists`UpdateItemModifierLists`	POST	Updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.
Update Item Taxes`UpdateItemTaxes`	POST	Updates the CatalogTax objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.
Upsert Catalog Object`UpsertCatalogObject`	POST	Creates a new or updates the specified CatalogObject.

Channel3

Bulk Retrieve Channels`BulkRetrieveChannels`	POST
List Channels`ListChannels`	GET
Retrieve Channel`RetrieveChannel`	GET

Checkout10

Create Checkout`CreateCheckout`	POST	Links a checkoutId to a checkout page url that customers are directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
Create Payment Link`CreatePaymentLink`	POST	Creates a Square-hosted checkout page.
Delete Payment Link`DeletePaymentLink`	DELETE	Deletes a payment link.
List Payment Links`ListPaymentLinks`	GET	Lists all payment links.
Retrieve Location Settings`RetrieveLocationSettings`	GET	Retrieves the location-level settings for a Square-hosted checkout page.
Retrieve Merchant Settings`RetrieveMerchantSettings`	GET	Retrieves the merchant-level settings for a Square-hosted checkout page.
Retrieve Payment Link`RetrievePaymentLink`	GET	Retrieves a payment link.
Update Location Settings`UpdateLocationSettings`	PUT	Updates the location-level settings for a Square-hosted checkout page.
Update Merchant Settings`UpdateMerchantSettings`	PUT	Updates the merchant-level settings for a Square-hosted checkout page.
Update Payment Link`UpdatePaymentLink`	PUT	Updates a payment link.

Customer14

Add Group To Customer`AddGroupToCustomer`	PUT	Adds a group membership to a customer.
Bulk Create Customers`BulkCreateCustomers`	POST	Creates multiple customer profiles for a business.
Bulk Delete Customers`BulkDeleteCustomers`	POST	Deletes multiple customer profiles.
Bulk Retrieve Customers`BulkRetrieveCustomers`	POST	Retrieves multiple customer profiles.
Bulk Update Customers`BulkUpdateCustomers`	POST	Updates multiple customer profiles.
Create Customer`CreateCustomer`	POST	Creates a new customer for a business.
Create Customer Card`CreateCustomerCard`	POST	Adds a card on file to an existing customer.
Delete Customer`DeleteCustomer`	DELETE	Deletes a customer profile from a business.
Delete Customer Card`DeleteCustomerCard`	DELETE	Removes a card on file from a customer.
List Customers`ListCustomers`	GET	Lists customer profiles associated with a Square account.
Remove Group From Customer`RemoveGroupFromCustomer`	DELETE	Removes a group membership from a customer.
Retrieve Customer`RetrieveCustomer`	GET	Returns details for a single customer.
Search Customers`SearchCustomers`	POST	Searches the customer profiles associated with a Square account using one or more supported query filters.
Update Customer`UpdateCustomer`	PUT	Updates a customer profile.

CustomerCustomAttribute10

Bulk Upsert Customer Custom Attributes`BulkUpsertCustomerCustomAttributes`	POST	Creates or updates custom attributes for customer profiles as a bulk operation.
Create Customer Custom Attribute Definition`CreateCustomerCustomAttributeDefinition`	POST	Creates a customer-related custom attribute definition for a Square seller account.
Delete Customer Custom Attribute`DeleteCustomerCustomAttribute`	DELETE	Deletes a custom attribute associated with a customer profile.
Delete Customer Custom Attribute Definition`DeleteCustomerCustomAttributeDefinition`	DELETE	Deletes a customer-related custom attribute definition from a Square seller account.
List Customer Custom Attribute Definitions`ListCustomerCustomAttributeDefinitions`	GET	Lists the customer-related custom attribute definitions that belong to a Square seller account.
List Customer Custom Attributes`ListCustomerCustomAttributes`	GET	Lists the custom attributes associated with a customer profile.
Retrieve Customer Custom Attribute`RetrieveCustomerCustomAttribute`	GET	Retrieves a custom attribute associated with a customer profile.
Retrieve Customer Custom Attribute Definition`RetrieveCustomerCustomAttributeDefinition`	GET	Retrieves a customer-related custom attribute definition from a Square seller account.
Update Customer Custom Attribute Definition`UpdateCustomerCustomAttributeDefinition`	PUT	Updates a customer-related custom attribute definition for a Square seller account.
Upsert Customer Custom Attribute`UpsertCustomerCustomAttribute`	POST	Creates or updates a custom attribute for a customer profile.

CustomerGroup5

Create Customer Group`CreateCustomerGroup`	POST	Creates a new customer group for a business.
Delete Customer Group`DeleteCustomerGroup`	DELETE	Deletes a customer group as identified by the group id value.
List Customer Groups`ListCustomerGroups`	GET	Retrieves the list of customer groups of a business.
Retrieve Customer Group`RetrieveCustomerGroup`	GET	Retrieves a specific customer group as identified by the group id value.
Update Customer Group`UpdateCustomerGroup`	PUT	Updates a customer group as identified by the group id value.

CustomerSegment2

List Customer Segments`ListCustomerSegments`	GET	Retrieves the list of customer segments of a business.
Retrieve Customer Segment`RetrieveCustomerSegment`	GET	Retrieves a specific customer segment as identified by the segment id value.

Device5

Create Device Code`CreateDeviceCode`	POST	Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.
Get Device`GetDevice`	GET	Retrieves Device with the associated device id.
Get Device Code`GetDeviceCode`	GET	Retrieves DeviceCode with the associated ID.
List Device Codes`ListDeviceCodes`	GET	Lists all DeviceCodes associated with the merchant.
List Devices`ListDevices`	GET	List devices associated with the merchant.

Dispute9

Accept Dispute`AcceptDispute`	POST	Accepts the loss on a dispute.
Create Dispute Evidence File`CreateDisputeEvidenceFile`	POST	Uploads a file to use as evidence in a dispute challenge.
Create Dispute Evidence Text`CreateDisputeEvidenceText`	POST	Uploads text to use as evidence for a dispute challenge.
Delete Dispute Evidence`DeleteDisputeEvidence`	DELETE	Removes specified evidence from a dispute.
List Dispute Evidence`ListDisputeEvidence`	GET	Returns a list of evidence associated with a dispute.
List Disputes`ListDisputes`	GET	Returns a list of disputes associated with a particular account.
Retrieve Dispute`RetrieveDispute`	GET	Returns details about a specific dispute.
Retrieve Dispute Evidence`RetrieveDisputeEvidence`	GET	Returns the metadata for the evidence specified in the request URL path.
Submit Evidence`SubmitEvidence`	POST	Submits evidence to the cardholder's bank.

Employee2

List Employees`ListEmployees`	GET
Retrieve Employee`RetrieveEmployee`	GET

Event4

Disable Events`DisableEvents`	PUT	Disables events to prevent them from being searchable.
Enable Events`EnableEvents`	PUT	Enables events to make them searchable.
List Event Types`ListEventTypes`	GET	Lists all event types that you can subscribe to as webhooks or query using the Events API.
Search Events`SearchEvents`	POST	Search for Square API events that occur within a 28-day timeframe.

GiftCard7

Create Gift Card`CreateGiftCard`	POST	Creates a digital gift card or registers a physical (plastic) gift card.
Link Customer To Gift Card`LinkCustomerToGiftCard`	POST	Links a customer to a gift card, which is also referred to as adding a card on file.
List Gift Cards`ListGiftCards`	GET	Lists all gift cards.
Retrieve Gift Card`RetrieveGiftCard`	GET	Retrieves a gift card using the gift card ID.
Retrieve Gift Card From GAN`RetrieveGiftCardFromGAN`	POST	Retrieves a gift card using the gift card account number (GAN).
Retrieve Gift Card From Nonce`RetrieveGiftCardFromNonce`	POST	Retrieves a gift card using a secure payment token that represents the gift card.
Unlink Customer From Gift Card`UnlinkCustomerFromGiftCard`	POST	Unlinks a customer from a gift card, which is also referred to as removing a card on file.

GiftCardActivity2

Create Gift Card Activity`CreateGiftCardActivity`	POST	Creates a gift card activity to manage the balance or state of a gift card.
List Gift Card Activities`ListGiftCardActivities`	GET	Lists gift card activities.

Inventory19

Batch Change Inventory`BatchChangeInventory`	POST	Applies adjustments and counts to the provided item quantities.
Batch Retrieve Inventory Changes`BatchRetrieveInventoryChanges`	POST	Returns historical physical counts and adjustments based on the provided filter criteria.
Batch Retrieve Inventory Counts`BatchRetrieveInventoryCounts`	POST	Returns current counts for the provided CatalogObjects at the requested Locations.
Create Inventory Adjustment Reason`CreateInventoryAdjustmentReason`	POST	Creates a custom inventory adjustment reason.
Delete Inventory Adjustment Reason`DeleteInventoryAdjustmentReason`	POST	Soft deletes a custom inventory adjustment reason.
Deprecated Batch Change Inventory`DeprecatedBatchChangeInventory`	POST	Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention.
Deprecated Batch Retrieve Inventory Changes`DeprecatedBatchRetrieveInventoryChanges`	POST	Deprecated version of BatchRetrieveInventoryChanges after the endpoint URL is updated to conform to the standard convention.
Deprecated Batch Retrieve Inventory Counts`DeprecatedBatchRetrieveInventoryCounts`	POST	Deprecated version of BatchRetrieveInventoryCounts after the endpoint URL is updated to conform to the standard convention.
Deprecated Retrieve Inventory Adjustment`DeprecatedRetrieveInventoryAdjustment`	GET	Deprecated version of RetrieveInventoryAdjustment after the endpoint URL is updated to conform to the standard convention.
Deprecated Retrieve Inventory Physical Count`DeprecatedRetrieveInventoryPhysicalCount`	GET	Deprecated version of RetrieveInventoryPhysicalCount after the endpoint URL is updated to conform to the standard convention.
List Inventory Adjustment Reasons`ListInventoryAdjustmentReasons`	GET	Returns the standard and custom inventory adjustment reasons available to the seller.
Restore Inventory Adjustment Reason`RestoreInventoryAdjustmentReason`	POST	Restores a soft-deleted custom inventory adjustment reason.
Retrieve Inventory Adjustment`RetrieveInventoryAdjustment`	GET	Returns the InventoryAdjustment object with the provided adjustment id.
Retrieve Inventory Adjustment Reason`RetrieveInventoryAdjustmentReason`	POST	Returns the inventory adjustment reason identified by the provided reason id.
Retrieve Inventory Changes`RetrieveInventoryChanges`	GET	Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations.
Retrieve Inventory Count`RetrieveInventoryCount`	GET	Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.
Retrieve Inventory Physical Count`RetrieveInventoryPhysicalCount`	GET	Returns the InventoryPhysicalCount object with the provided physical count id.
Update Inventory Adjustment`UpdateInventoryAdjustment`	PUT	Applies an update to the provided adjustment.
Update Inventory Adjustment Reason`UpdateInventoryAdjustmentReason`	PUT	Updates a custom inventory adjustment reason.

Invoice10

Cancel Invoice`CancelInvoice`	POST	Cancels an invoice.
Create Invoice`CreateInvoice`	POST	Creates a draft invoice for an order created using the Orders API.
Create Invoice Attachment`CreateInvoiceAttachment`	POST	Uploads a file and attaches it to an invoice.
Delete Invoice`DeleteInvoice`	DELETE	Deletes the specified invoice.
Delete Invoice Attachment`DeleteInvoiceAttachment`	DELETE	Removes an attachment from an invoice and permanently deletes the file.
Get Invoice`GetInvoice`	GET	Retrieves an invoice by invoice ID.
List Invoices`ListInvoices`	GET	Returns a list of invoices for a given location.
Publish Invoice`PublishInvoice`	POST	Publishes the specified draft invoice.
Search Invoices`SearchInvoices`	POST	Searches for invoices from a location specified in the filter.
Update Invoice`UpdateInvoice`	PUT	Updates an invoice.

Labor27

Bulk Publish Scheduled Shifts`BulkPublishScheduledShifts`	POST	Publishes 1 - 100 scheduled shifts.
Create Break Type`CreateBreakType`	POST	Creates a new BreakType.
Create Scheduled Shift`CreateScheduledShift`	POST	Creates a scheduled shift by providing draft shift details such as job ID, team member assignment, and start and end times.
Create Shift`CreateShift`	POST	Creates a new Shift.
Create Timecard`CreateTimecard`	POST	Creates a new Timecard.
Delete Break Type`DeleteBreakType`	DELETE	Deletes an existing BreakType.
Delete Shift`DeleteShift`	DELETE	Deletes a Shift.
Delete Timecard`DeleteTimecard`	DELETE	Deletes a Timecard.
Get Break Type`GetBreakType`	GET	Returns a single BreakType specified by id.
Get Employee Wage`GetEmployeeWage`	GET	Returns a single EmployeeWage specified by id.
Get Shift`GetShift`	GET	Returns a single Shift specified by id.
Get Team Member Wage`GetTeamMemberWage`	GET	Returns a single TeamMemberWage specified by id.
List Break Types`ListBreakTypes`	GET	Returns a paginated list of BreakType instances for a business.
List Employee Wages`ListEmployeeWages`	GET	Returns a paginated list of EmployeeWage instances for a business.
List Team Member Wages`ListTeamMemberWages`	GET	Returns a paginated list of TeamMemberWage instances for a business.
List Workweek Configs`ListWorkweekConfigs`	GET	Returns a list of WorkweekConfig instances for a business.
Publish Scheduled Shift`PublishScheduledShift`	POST	Publishes a scheduled shift.
Retrieve Scheduled Shift`RetrieveScheduledShift`	GET	Retrieves a scheduled shift by ID.
Retrieve Timecard`RetrieveTimecard`	GET	Returns a single Timecard specified by id.
Search Scheduled Shifts`SearchScheduledShifts`	POST	Returns a paginated list of scheduled shifts, with optional filter and sort settings.
Search Shifts`SearchShifts`	POST	Returns a paginated list of Shift records for a business.
Search Timecards`SearchTimecards`	POST	Returns a paginated list of Timecard records for a business.
Update Break Type`UpdateBreakType`	PUT	Updates an existing BreakType.
Update Scheduled Shift`UpdateScheduledShift`	PUT	Updates the draft shift details for a scheduled shift.
Update Shift`UpdateShift`	PUT	Updates an existing Shift.
Update Timecard`UpdateTimecard`	PUT	Updates an existing Timecard.
Update Workweek Config`UpdateWorkweekConfig`	PUT	Updates a WorkweekConfig.

Location4

Create Location`CreateLocation`	POST	Creates a location.
List Locations`ListLocations`	GET	Provides details about all of the seller's locations, including those with an inactive status.
Retrieve Location`RetrieveLocation`	GET	Retrieves details of a single location.
Update Location`UpdateLocation`	PUT	Updates a location.

LocationCustomAttribute11

Bulk Delete Location Custom Attributes`BulkDeleteLocationCustomAttributes`	POST	Deletes custom attributes for locations as a bulk operation.
Bulk Upsert Location Custom Attributes`BulkUpsertLocationCustomAttributes`	POST	Creates or updates custom attributes for locations as a bulk operation.
Create Location Custom Attribute Definition`CreateLocationCustomAttributeDefinition`	POST	Creates a location-related custom attribute definition for a Square seller account.
Delete Location Custom Attribute`DeleteLocationCustomAttribute`	DELETE	Deletes a custom attribute associated with a location.
Delete Location Custom Attribute Definition`DeleteLocationCustomAttributeDefinition`	DELETE	Deletes a location-related custom attribute definition from a Square seller account.
List Location Custom Attribute Definitions`ListLocationCustomAttributeDefinitions`	GET	Lists the location-related custom attribute definitions that belong to a Square seller account.
List Location Custom Attributes`ListLocationCustomAttributes`	GET	Lists the custom attributes associated with a location.
Retrieve Location Custom Attribute`RetrieveLocationCustomAttribute`	GET	Retrieves a custom attribute associated with a location.
Retrieve Location Custom Attribute Definition`RetrieveLocationCustomAttributeDefinition`	GET	Retrieves a location-related custom attribute definition from a Square seller account.
Update Location Custom Attribute Definition`UpdateLocationCustomAttributeDefinition`	PUT	Updates a location-related custom attribute definition for a Square seller account.
Upsert Location Custom Attribute`UpsertLocationCustomAttribute`	POST	Creates or updates a custom attribute for a location.

Loyalty18

Accumulate Loyalty Points`AccumulateLoyaltyPoints`	POST	Adds points earned from a purchase to a loyalty account.
Adjust Loyalty Points`AdjustLoyaltyPoints`	POST	Adds points to or subtracts points from a buyer's account.
Calculate Loyalty Points`CalculateLoyaltyPoints`	POST	Calculates the number of points a buyer can earn from a purchase.
Cancel Loyalty Promotion`CancelLoyaltyPromotion`	POST	Cancels a loyalty promotion.
Create Loyalty Account`CreateLoyaltyAccount`	POST	Creates a loyalty account.
Create Loyalty Promotion`CreateLoyaltyPromotion`	POST	Creates a loyalty promotion for a loyalty program.
Create Loyalty Reward`CreateLoyaltyReward`	POST	Creates a loyalty reward.
Delete Loyalty Reward`DeleteLoyaltyReward`	DELETE	Deletes a loyalty reward by doing the following:
List Loyalty Programs`ListLoyaltyPrograms`	GET	Returns a list of loyalty programs in the seller's account.
List Loyalty Promotions`ListLoyaltyPromotions`	GET	Lists the loyalty promotions associated with a loyalty program.
Redeem Loyalty Reward`RedeemLoyaltyReward`	POST	Redeems a loyalty reward.
Retrieve Loyalty Account`RetrieveLoyaltyAccount`	GET	Retrieves a loyalty account.
Retrieve Loyalty Program`RetrieveLoyaltyProgram`	GET	Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword main.
Retrieve Loyalty Promotion`RetrieveLoyaltyPromotion`	GET	Retrieves a loyalty promotion.
Retrieve Loyalty Reward`RetrieveLoyaltyReward`	GET	Retrieves a loyalty reward.
Search Loyalty Accounts`SearchLoyaltyAccounts`	POST	Searches for loyalty accounts in a loyalty program.
Search Loyalty Events`SearchLoyaltyEvents`	POST	Searches for loyalty events.
Search Loyalty Rewards`SearchLoyaltyRewards`	POST	Searches for loyalty rewards.

Merchant2

List Merchants`ListMerchants`	GET	Provides details about the merchant associated with a given access token.
Retrieve Merchant`RetrieveMerchant`	GET	Retrieves the Merchant object for the given merchant id.

MerchantCustomAttribute11

Bulk Delete Merchant Custom Attributes`BulkDeleteMerchantCustomAttributes`	POST	Deletes custom attributes for a merchant as a bulk operation.
Bulk Upsert Merchant Custom Attributes`BulkUpsertMerchantCustomAttributes`	POST	Creates or updates custom attributes for a merchant as a bulk operation.
Create Merchant Custom Attribute Definition`CreateMerchantCustomAttributeDefinition`	POST	Creates a merchant-related custom attribute definition for a Square seller account.
Delete Merchant Custom Attribute`DeleteMerchantCustomAttribute`	DELETE	Deletes a custom attribute associated with a merchant.
Delete Merchant Custom Attribute Definition`DeleteMerchantCustomAttributeDefinition`	DELETE	Deletes a merchant-related custom attribute definition from a Square seller account.
List Merchant Custom Attribute Definitions`ListMerchantCustomAttributeDefinitions`	GET	Lists the merchant-related custom attribute definitions that belong to a Square seller account.
List Merchant Custom Attributes`ListMerchantCustomAttributes`	GET	Lists the custom attributes associated with a merchant.
Retrieve Merchant Custom Attribute`RetrieveMerchantCustomAttribute`	GET	Retrieves a custom attribute associated with a merchant.
Retrieve Merchant Custom Attribute Definition`RetrieveMerchantCustomAttributeDefinition`	GET	Retrieves a merchant-related custom attribute definition from a Square seller account.
Update Merchant Custom Attribute Definition`UpdateMerchantCustomAttributeDefinition`	PUT	Updates a merchant-related custom attribute definition for a Square seller account.
Upsert Merchant Custom Attribute`UpsertMerchantCustomAttribute`	POST	Creates or updates a custom attribute for a merchant.

OAuth3

Obtain Token`ObtainToken`	POST	Returns an OAuth access token and refresh token using the authorization code or refresh token grant type.
Retrieve Token Status`RetrieveTokenStatus`	POST	Returns information about an OAuth access token or an application’s personal access token.
Revoke Token`RevokeToken`	POST	Revokes an access token generated with the OAuth flow.

Order8

Batch Retrieve Orders`BatchRetrieveOrders`	POST	Retrieves a set of orders by their IDs.
Calculate Order`CalculateOrder`	POST	Enables applications to preview order pricing without creating an order.
Clone Order`CloneOrder`	POST	Creates a new order, in the DRAFT state, by duplicating an existing order.
Create Order`CreateOrder`	POST	Creates a new order that can include information about products for purchase and settings to apply to the purchase.
Pay Order`PayOrder`	POST	Pay for an order using one or more approved payments or settle an order with a total of 0.
Retrieve Order`RetrieveOrder`	GET	Retrieves an Order by ID.
Search Orders`SearchOrders`	POST	Search all orders for one or more locations.
Update Order`UpdateOrder`	PUT	Updates an open order by adding, replacing, or deleting fields.

OrderCustomAttribute11

Bulk Delete Order Custom Attributes`BulkDeleteOrderCustomAttributes`	POST	Deletes order custom attributes as a bulk operation.
Bulk Upsert Order Custom Attributes`BulkUpsertOrderCustomAttributes`	POST	Creates or updates order custom attributes as a bulk operation.
Create Order Custom Attribute Definition`CreateOrderCustomAttributeDefinition`	POST	Creates an order-related custom attribute definition.
Delete Order Custom Attribute`DeleteOrderCustomAttribute`	DELETE	Deletes a custom attribute associated with a customer profile.
Delete Order Custom Attribute Definition`DeleteOrderCustomAttributeDefinition`	DELETE	Deletes an order-related custom attribute definition from a Square seller account.
List Order Custom Attribute Definitions`ListOrderCustomAttributeDefinitions`	GET	Lists the order-related custom attribute definitions that belong to a Square seller account.
List Order Custom Attributes`ListOrderCustomAttributes`	GET	Lists the custom attributes associated with an order.
Retrieve Order Custom Attribute`RetrieveOrderCustomAttribute`	GET	Retrieves a custom attribute associated with an order.
Retrieve Order Custom Attribute Definition`RetrieveOrderCustomAttributeDefinition`	GET	Retrieves an order-related custom attribute definition from a Square seller account.
Update Order Custom Attribute Definition`UpdateOrderCustomAttributeDefinition`	PUT	Updates an order-related custom attribute definition for a Square seller account.
Upsert Order Custom Attribute`UpsertOrderCustomAttribute`	POST	Creates or updates a custom attribute for an order.

Payment7

Cancel Payment`CancelPayment`	POST	Cancels (voids) a payment.
Cancel Payment By Idempotency Key`CancelPaymentByIdempotencyKey`	POST	Cancels (voids) a payment identified by the idempotency key that is specified in the request.
Complete Payment`CompletePayment`	POST	Completes (captures) a payment.
Create Payment`CreatePayment`	POST	Creates a payment using the provided source.
Get Payment`GetPayment`	GET	Retrieves details for a specific payment.
List Payments`ListPayments`	GET	Retrieves a list of payments taken by the account making the request.
Update Payment`UpdatePayment`	PUT	Updates a payment with the APPROVED status.

Payout3

Get Payout`GetPayout`	GET	Retrieves details of a specific payout identified by a payout ID.
List Payout Entries`ListPayoutEntries`	GET	Retrieves a list of all payout entries for a specific payout.
List Payouts`ListPayouts`	GET	Retrieves a list of all payouts for the default location.

Refund3

Get Payment Refund`GetPaymentRefund`	GET	Retrieves a specific refund using the refund id.
List Payment Refunds`ListPaymentRefunds`	GET	Retrieves a list of refunds for the account making the request.
Refund Payment`RefundPayment`	POST	Refunds a payment.

Site1

List SitesListSites GET Lists the Square Online sites that belong to a seller.

Snippet3

Delete Snippet`DeleteSnippet`	DELETE	Removes your snippet from a Square Online site.
Retrieve Snippet`RetrieveSnippet`	GET	Retrieves your snippet from a Square Online site.
Upsert Snippet`UpsertSnippet`	POST	Adds a snippet to a Square Online site or updates the existing snippet on the site.

Subscription12

Bulk Swap Plan`BulkSwapPlan`	POST	Schedules a plan variation change for all active subscriptions under a given plan variation.
Cancel Subscription`CancelSubscription`	POST	Schedules a CANCEL action to cancel an active subscription.
Change Billing Anchor Date`ChangeBillingAnchorDate`	POST	Changes the billing anchor date for a subscription.
Create Subscription`CreateSubscription`	POST	Enrolls a customer in a subscription.
Delete Subscription Action`DeleteSubscriptionAction`	DELETE	Deletes a scheduled action for a subscription.
List Subscription Events`ListSubscriptionEvents`	GET	Lists all events for a specific subscription.
Pause Subscription`PauseSubscription`	POST	Schedules a PAUSE action to pause an active subscription.
Resume Subscription`ResumeSubscription`	POST	Schedules a RESUME action to resume a paused or a deactivated subscription.
Retrieve Subscription`RetrieveSubscription`	GET	Retrieves a specific subscription.
Search Subscriptions`SearchSubscriptions`	POST	Searches for subscriptions.
Swap Plan`SwapPlan`	POST	Schedules a SWAP PLAN action to swap a subscription plan variation in an existing subscription.
Update Subscription`UpdateSubscription`	PUT	Updates a subscription by modifying or clearing subscription field values.

Team12

Bulk Create Team Members`BulkCreateTeamMembers`	POST	Creates multiple TeamMember objects.
Bulk Update Team Members`BulkUpdateTeamMembers`	POST	Updates multiple TeamMember objects.
Create Job`CreateJob`	POST	Creates a job in a seller account.
Create Team Member`CreateTeamMember`	POST	Creates a single TeamMember object.
List Jobs`ListJobs`	GET	Lists jobs in a seller account.
Retrieve Job`RetrieveJob`	GET	Retrieves a specified job.
Retrieve Team Member`RetrieveTeamMember`	GET	Retrieves a TeamMember object for the given TeamMember.id.
Retrieve Wage Setting`RetrieveWageSetting`	GET	Retrieves a WageSetting object for a team member specified by TeamMember.id.
Search Team Members`SearchTeamMembers`	POST	Returns a paginated list of TeamMember objects for a business.
Update Job`UpdateJob`	PUT	Updates the title or tip eligibility of a job.
Update Team Member`UpdateTeamMember`	PUT	Updates a single TeamMember object.
Update Wage Setting`UpdateWageSetting`	PUT	Creates or updates a WageSetting object.

Terminal15

Cancel Terminal Action`CancelTerminalAction`	POST	Cancels a Terminal action request if the status of the request permits it.
Cancel Terminal Checkout`CancelTerminalCheckout`	POST	Cancels a Terminal checkout request if the status of the request permits it.
Cancel Terminal Refund`CancelTerminalRefund`	POST	Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.
Create Terminal Action`CreateTerminalAction`	POST	Creates a Terminal action request and sends it to the specified device.
Create Terminal Checkout`CreateTerminalCheckout`	POST	Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
Create Terminal Refund`CreateTerminalRefund`	POST	Creates a request to refund an Interac payment completed on a Square Terminal.
Dismiss Terminal Action`DismissTerminalAction`	POST	Dismisses a Terminal action request if the status and type of the request permits it.
Dismiss Terminal Checkout`DismissTerminalCheckout`	POST	Dismisses a Terminal checkout request if the status and type of the request permits it.
Dismiss Terminal Refund`DismissTerminalRefund`	POST	Dismisses a Terminal refund request if the status and type of the request permits it.
Get Terminal Action`GetTerminalAction`	GET	Retrieves a Terminal action request by action id.
Get Terminal Checkout`GetTerminalCheckout`	GET	Retrieves a Terminal checkout request by checkout id.
Get Terminal Refund`GetTerminalRefund`	GET	Retrieves an Interac Terminal refund object by ID.
Search Terminal Actions`SearchTerminalActions`	POST	Retrieves a filtered list of Terminal action requests created by the account making the request.
Search Terminal Checkouts`SearchTerminalCheckouts`	POST	Returns a filtered list of Terminal checkout requests created by the application making the request.
Search Terminal Refunds`SearchTerminalRefunds`	POST	Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.

Transaction4

Capture Transaction`CaptureTransaction`	POST	Captures a transaction that was created with the Charge endpoint with a delay capture value of true.
List Transactions`ListTransactions`	GET	Lists transactions for a particular location.
Retrieve Transaction`RetrieveTransaction`	GET	Retrieves details for a single transaction.
Void Transaction`VoidTransaction`	POST	Cancels a transaction that was created with the Charge endpoint with a delay capture value of true.

TransferOrder8

Cancel Transfer Order`CancelTransferOrder`	POST	Cancels a transfer order in STARTED or PARTIALLY RECEIVED status.
Create Transfer Order`CreateTransferOrder`	POST	Creates a new transfer order in DRAFT status.
Delete Transfer Order`DeleteTransferOrder`	DELETE	Deletes a transfer order in DRAFT status.
Receive Transfer Order`ReceiveTransferOrder`	POST	Records receipt of CatalogItemVariations for a transfer order.
Retrieve Transfer Order`RetrieveTransferOrder`	GET	Retrieves a specific TransferOrder by ID.
Search Transfer Orders`SearchTransferOrders`	POST	Searches for transfer orders using filters.
Start Transfer Order`StartTransferOrder`	POST	Changes a DRAFT transfer order to STARTED status.
Update Transfer Order`UpdateTransferOrder`	PUT	Updates an existing transfer order.

V1Transaction3

V 1 List Orders`V1ListOrders`	GET	Provides summary information for a merchant's online store orders.
V 1 Retrieve Order`V1RetrieveOrder`	GET	Provides comprehensive information for a single online store order, including the order's history.
V 1 Update Order`V1UpdateOrder`	PUT	Updates the details of an online store order.

Vendor7

Bulk Create Vendors`BulkCreateVendors`	POST	Creates one or more Vendor objects to represent suppliers to a seller.
Bulk Retrieve Vendors`BulkRetrieveVendors`	POST	Retrieves one or more vendors of specified Vendor IDs.
Bulk Update Vendors`BulkUpdateVendors`	PUT	Updates one or more of existing Vendor objects as suppliers to a seller.
Create Vendor`CreateVendor`	POST	Creates a single Vendor object to represent a supplier to a seller.
Retrieve Vendor`RetrieveVendor`	GET	Retrieves the vendor of a specified Vendor ID.
Search Vendors`SearchVendors`	POST	Searches for vendors using a filter against supported Vendor properties and a supported sorter.
Update Vendor`UpdateVendor`	PUT	Updates an existing Vendor object as a supplier to a seller.

WebhookSubscription8

Create Webhook Subscription`CreateWebhookSubscription`	POST	Creates a webhook subscription.
Delete Webhook Subscription`DeleteWebhookSubscription`	DELETE	Deletes a webhook subscription.
List Webhook Event Types`ListWebhookEventTypes`	GET	Lists all webhook event types that can be subscribed to.
List Webhook Subscriptions`ListWebhookSubscriptions`	GET	Lists all webhook subscriptions owned by your application.
Retrieve Webhook Subscription`RetrieveWebhookSubscription`	GET	Retrieves a webhook subscription identified by its ID.
Test Webhook Subscription`TestWebhookSubscription`	POST	Tests a webhook subscription by sending a test event to the notification URL.
Update Webhook Subscription`UpdateWebhookSubscription`	PUT	Updates a webhook subscription.
Update Webhook Subscription Signature Key`UpdateWebhookSubscriptionSignatureKey`	POST	Updates a webhook subscription by replacing the existing signature key with a new one.