Square

Square helps millions of sellers run their business- from secure credit card processing to point of sale solutions. Get paid faster with Square and sign up today!

Links

API Paths

Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Provides the details for a single modifier list. (GET) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Modifies the details of an existing item modifier list. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item modifier option and adds it to a modifier list. (POST) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options OpenAPI
Deletes an existing item modifier option from a modifier list. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} OpenAPI
Modifies the details of an existing item modifier option. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} OpenAPI
Provides summary information for a merchant's online store orders. (GET) /v1/{location_id}/orders OpenAPI
Provides comprehensive information for a single online store order, including the order's history. (GET) /v1/{location_id}/orders/{order_id} OpenAPI
Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: (PUT) /v1/{location_id}/orders/{order_id} OpenAPI
Lists all of a location's Favorites pages in Square Register. (GET) /v1/{location_id}/pages OpenAPI
Creates a Favorites page in Square Register. (POST) /v1/{location_id}/pages OpenAPI
Deletes an existing Favorites page and all of its cells. (DELETE) /v1/{location_id}/pages/{page_id} OpenAPI
Modifies the details of a Favorites page in Square Register. (PUT) /v1/{location_id}/pages/{page_id} OpenAPI
Deletes a cell from a Favorites page in Square Register. (DELETE) /v1/{location_id}/pages/{page_id}/cells OpenAPI
Modifies a cell of a Favorites page in Square Register. (PUT) /v1/{location_id}/pages/{page_id}/cells OpenAPI
Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. (GET) /v1/{location_id}/payments OpenAPI
Provides comprehensive information for a single payment. (GET) /v1/{location_id}/payments/{payment_id} OpenAPI
Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. (GET) /v1/{location_id}/refunds OpenAPI
Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. (POST) /v1/{location_id}/refunds OpenAPI
Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. (GET) /v1/{location_id}/settlements OpenAPI
Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. (GET) /v1/{location_id}/settlements/{settlement_id} OpenAPI
BatchDeleteCatalogObjects (POST) /v2/catalog/batch-delete OpenAPI
BatchRetrieveCatalogObjects (POST) /v2/catalog/batch-retrieve OpenAPI
BatchUpsertCatalogObjects (POST) /v2/catalog/batch-upsert OpenAPI
CatalogInfo (GET) /v2/catalog/info OpenAPI
ListCatalog (GET) /v2/catalog/list OpenAPI
UpsertCatalogObject (POST) /v2/catalog/object OpenAPI
DeleteCatalogObject (DELETE) /v2/catalog/object/{object_id} OpenAPI
RetrieveCatalogObject (GET) /v2/catalog/object/{object_id} OpenAPI
SearchCatalogObjects (POST) /v2/catalog/search OpenAPI
UpdateItemModifierLists (POST) /v2/catalog/update-item-modifier-lists OpenAPI
UpdateItemTaxes (POST) /v2/catalog/update-item-taxes OpenAPI
ListCustomers (GET) /v2/customers OpenAPI
CreateCustomer (POST) /v2/customers OpenAPI
DeleteCustomer (DELETE) /v2/customers/{customer_id} OpenAPI
RetrieveCustomer (GET) /v2/customers/{customer_id} OpenAPI
UpdateCustomer (PUT) /v2/customers/{customer_id} OpenAPI
CreateCustomerCard (POST) /v2/customers/{customer_id}/cards OpenAPI
DeleteCustomerCard (DELETE) /v2/customers/{customer_id}/cards/{card_id} OpenAPI
ListLocations (GET) /v2/locations OpenAPI
CreateCheckout (POST) /v2/locations/{location_id}/checkouts OpenAPI
ListRefunds (GET) /v2/locations/{location_id}/refunds OpenAPI
ListTransactions (GET) /v2/locations/{location_id}/transactions OpenAPI
Charge (POST) /v2/locations/{location_id}/transactions OpenAPI
RetrieveTransaction (GET) /v2/locations/{location_id}/transactions/{transaction_id} OpenAPI
CaptureTransaction (POST) /v2/locations/{location_id}/transactions/{transaction_id}/capture OpenAPI
CreateRefund (POST) /v2/locations/{location_id}/transactions/{transaction_id}/refund OpenAPI
VoidTransaction (POST) /v2/locations/{location_id}/transactions/{transaction_id}/void OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Provides the details for a single modifier list. (GET) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Provides the details for a single modifier list. (GET) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Modifies the details of an existing item modifier list. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Provides the details for a single modifier list. (GET) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Modifies the details of an existing item modifier list. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item modifier option and adds it to a modifier list. (POST) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Provides the details for a single modifier list. (GET) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Modifies the details of an existing item modifier list. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item modifier option and adds it to a modifier list. (POST) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options OpenAPI
Deletes an existing item modifier option from a modifier list. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles OpenAPI
Provides the details for a single employee role. (GET) /v1/me/roles/{role_id} OpenAPI
Modifies the details of an employee role. (PUT) /v1/me/roles/{role_id} OpenAPI
Provides summary information for all of a business's employee timecards. (GET) /v1/me/timecards OpenAPI
Creates a timecard for an employee. Each timecard corresponds to a single shift. (POST) /v1/me/timecards OpenAPI
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. (DELETE) /v1/me/timecards/{timecard_id} OpenAPI
Provides the details for a single timecard. (GET) /v1/me/timecards/{timecard_id} OpenAPI
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. (PUT) /v1/me/timecards/{timecard_id} OpenAPI
Provides summary information for all events associated with a particular timecard. (GET) /v1/me/timecards/{timecard_id}/events OpenAPI
Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts OpenAPI
Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. (GET) /v1/{location_id}/bank-accounts/{bank_account_id} OpenAPI
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. (GET) /v1/{location_id}/cash-drawer-shifts OpenAPI
Provides the details for a single cash drawer shift, including all events that occurred during the shift. (GET) /v1/{location_id}/cash-drawer-shifts/{shift_id} OpenAPI
Lists all of a location's item categories. (GET) /v1/{location_id}/categories OpenAPI
Creates an item category. (POST) /v1/{location_id}/categories OpenAPI
Deletes an existing item category. (DELETE) /v1/{location_id}/categories/{category_id} OpenAPI
Modifies the details of an existing item category. (PUT) /v1/{location_id}/categories/{category_id} OpenAPI
Lists all of a location's discounts. (GET) /v1/{location_id}/discounts OpenAPI
Creates a discount. (POST) /v1/{location_id}/discounts OpenAPI
Deletes an existing discount. (DELETE) /v1/{location_id}/discounts/{discount_id} OpenAPI
Modifies the details of an existing discount. (PUT) /v1/{location_id}/discounts/{discount_id} OpenAPI
Lists all of a location's fees (taxes). (GET) /v1/{location_id}/fees OpenAPI
Creates a fee (tax). (POST) /v1/{location_id}/fees OpenAPI
Deletes an existing fee (tax). (DELETE) /v1/{location_id}/fees/{fee_id} OpenAPI
Modifies the details of an existing fee (tax). (PUT) /v1/{location_id}/fees/{fee_id} OpenAPI
Provides inventory information for all of a merchant's inventory-enabled item variations. (GET) /v1/{location_id}/inventory OpenAPI
Adjusts an item variation's current available inventory. (POST) /v1/{location_id}/inventory/{variation_id} OpenAPI
Provides summary information for all of a location's items. (GET) /v1/{location_id}/items OpenAPI
Creates an item and at least one variation for it. (POST) /v1/{location_id}/items OpenAPI
Deletes an existing item and all item variations associated with it. (DELETE) /v1/{location_id}/items/{item_id} OpenAPI
Provides the details for a single item, including associated modifier lists and fees. (GET) /v1/{location_id}/items/{item_id} OpenAPI
Modifies the core details of an existing item. (PUT) /v1/{location_id}/items/{item_id} OpenAPI
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. (DELETE) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. (PUT) /v1/{location_id}/items/{item_id}/fees/{fee_id} OpenAPI
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. (DELETE) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. (PUT) /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item variation for an existing item. (POST) /v1/{location_id}/items/{item_id}/variations OpenAPI
Deletes an existing item variation from an item. (DELETE) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Modifies the details of an existing item variation. (PUT) /v1/{location_id}/items/{item_id}/variations/{variation_id} OpenAPI
Lists all of a location's modifier lists. (GET) /v1/{location_id}/modifier-lists OpenAPI
Creates an item modifier list and at least one modifier option for it. (POST) /v1/{location_id}/modifier-lists OpenAPI
Deletes an existing item modifier list and all modifier options associated with it. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Provides the details for a single modifier list. (GET) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Modifies the details of an existing item modifier list. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id} OpenAPI
Creates an item modifier option and adds it to a modifier list. (POST) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options OpenAPI
Deletes an existing item modifier option from a modifier list. (DELETE) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} OpenAPI
Modifies the details of an existing item modifier option. (PUT) /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} OpenAPI
Get a business's information. (GET) /v1/me OpenAPI
Provides summary information for all of a business's employees. (GET) /v1/me/employees OpenAPI
Creates an employee for a business. (POST) /v1/me/employees OpenAPI
Provides the details for a single employee. (GET) /v1/me/employees/{employee_id} OpenAPI
Update Employee (PUT) /v1/me/employees/{employee_id} OpenAPI
Provides details for a business's locations, including their IDs. (GET) /v1/me/locations OpenAPI
Provides summary information for all of a business's employee roles. (GET) /v1/me/roles OpenAPI
Creates an employee role you can then assign to employees. (POST) /v1/me/roles