Available Square APIs

Naga Sri Hari Gonaboyina

Updated November 25, 2024 17:23

When you configure an export, import, or other type of flow step using the prebuilt Square connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Square API documentation. *You can also create a composite endpoint for this application in HTTP mode.

API	Operation	Export	Import
Customers	ListCustomers	X
	RetrieveCustomer	X
	SearchCustomers	X
	CreateCustomer		X
	UpdateCustomer		X
	Create Or Update Customer		X
	DeleteCustomer		X
	Add group to customer		X
	Remove group from customer		X
Locations	List Locations	X
	Retrieve location	X
	Create location		X
	Update location		X
	Create Or Update location		X
Catalog	ListCatalog	X
	CatalogInfo	X
	CatalogInfo	X
	RetrieveCatalogObject	X
	SearchCatalogObjects	X
	BatchRetrieveCatalogObjects	X
	BatchUpsertCatalogObjects		X
	UpsertCatalogObject		X
	Batchdeletecatalogobjects		X
	UpdateItemModifierLists		X
	UpdateItemTaxes		X
	Batchdeletecatalogobjects		X
Inventory	BatchRetrieveInventoryChanges	X
	BatchRetrieveInventoryCounts	X
	RetrieveInventoryAdjustment	X
	RetrieveInventoryChanges	X
	RetrieveInventoryCount	X
	RetrieveInventoryPhysicalCount	X
	BatchChangeInventory		X
Labor	GetBreakType	X
	GetShift	X
	ListBreakTypes	X
	ListWorkweekConfigs	X
	SearchShifts	X
	List team member wages	X
	Get team member wage	X
	CreateBreakType		X
	CreateBreakType		X
	DeleteBreakType		X
	UpdateBreakType		X
	Create or Update BreakType		X
	CreateShift		X
	DeleteShift		X
	UpdateShift		X
	Create or Update Shift		X
	UpdateWorkweekConfig		X
Orders	BatchRetrieveOrders	X
	SearchOrders	X
	RetriveOrder	X
	CreateOrder		X
Bank Accounts	List bank accounts	X
	Get bank account	X
	Get bank account by v1 ID	X
Merchants	List merchants	X
Merchants	Retrieve merchant	X
Payments	List payments	X
	Get payment	X
	Create payment		X
	Cancel payment		X
	Cancel payment by idempotency key		X
	Complete payment		X
Cash Drawers	List cash drawer shifts	X
	Retrieve cash drawer shift	X
	List cash drawer shift events	X
Team	Search team members	X
	Retrieve team member	X
	Retrieve wage setting	X
	Create team member		X
	Update team member		X
	Create Or Update team member		X
	Update wage setting		X
Customer Groups	List customer groups	X
	Retrieve customer group	X
	Create customer group		X
	Update customer group		X
	Create Or Update customer group		X
	Delete customer group		X
Refunds	List payment refunds	X
	Get payment refund	X
	Refund payment		X
Checkout	CreateCheckout		X
ApplePay	RegisterDomain		X
Cards	ListCards	X
Cards	RetrieveCard	X

Note

Can't find what you're looking for?