Articles in this section

Available Square APIs

Naga Sri Hari Gonaboyina
Updated

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.

Resource API endpoint Export Import
Apple pay Register domain   X
Bank accounts Get bank account X  
Get bank account by v1 ID X  
List bank accounts X  
Cards List cards X  
Retrieve card X  
Cash drawers List cash drawer shift events X  
List cash drawer shifts X  
Retrieve cash drawer shift X  
Catalog Batch delete catalog objects   X
Batch retrieve catalog objects X  
Batch upsert catalog objects   X
Catalog info X  
Delete catalog object   X
List catalog X  
Retrieve catalog object X  
Search catalog objects X  
Update item modifier lists   X
Update item taxes   X
Upsert catalog object   X
Checkout Create checkout   X
Customer groups Create customer group   X
Delete customer group   X
List customer groups X  
Retrieve customer group X  
Update customer group   X
Customer segments List customer segments X  
Retrieve customer segment X  
Customers Add group to customer   X
Create customer   X
Delete customer   X
List customers X  
Remove group from customer   X
Retrieve customer X  
Search customers X  
Update customer   X
Inventory Batch change inventory   X
Batch retrieve inventory changes X  
Batch retrieve inventory counts X  
Retrieve inventory adjustment X  
Retrieve inventory changes X  
Retrieve inventory count X  
Retrieve inventory physical count X  
Labor Create break type   X
Create shift   X
Delete break type   X
Delete shift   X
Get break type X  
Get shift X  
Get team member wage X  
List break types X  
List team member wages X  
List work week configs X  
Search shifts X  
Update break type   X
Update shift   X
Update work week config   X
Locations Create location   X
List locations X  
Retrieve location X  
Update location   X
Merchants List merchants X  
Retrieve merchant X  
Orders Batch retrieve orders X  
Create order   X
Retrieve order X  
Search orders X  
Payments Cancel payment   X
Cancel payment by idempotency key   X
Complete payment   X
Create payment   X
Get payment X  
List payments X  
Refunds Get payment refund X  
List payment refunds X  
Refund payment   X
Team Create team member   X
Retrieve team member X  
Retrieve wage setting X  
Search team members X  
Update team member   X
Update wage setting   X