Partnerships
Sign In
Sign In

Home
Payments
Orders
Invoices
Items
Customers
Loyalty
Business
Team Management
Financials
Auth
Objects & Enums
Webhook Events
Deprecated
SDKs

Square API

All versions ->

Deprecated

View older Connect APIs, endpoints, and webhooks that have been deprecated and replaced with newer versions in the Square API.

Endpoints
Webhooks

All versions ->

Bank Accounts

ListBankAccounts
DEPRECATED/v1/{location_id}/bank-accounts
Provides non-confidential details for all of a location's associated bank accounts.
V1
RetrieveBankAccount
DEPRECATED/v1/{location_id}/bank-accounts/{bank_account_id}
Provides non-confidential details for a merchant's associated bank account.
V1

Cash Drawers

ListCashDrawerShifts
DEPRECATED/v1/{location_id}/cash-drawer-shifts
Provides the details for all of a location's cash drawer shifts during a date range.
V1
RetrieveCashDrawerShift
DEPRECATED/v1/{location_id}/cash-drawer-shifts/{shift_id}
Provides the details for a single cash drawer shift, including all events that occurred during the shift.
V1

Catalog

ApplyFee
DEPRECATED/v1/{location_id}/items/{item_id}/fees/{fee_id}
Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale.
V1
ApplyModifierList
DEPRECATED/v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}
Associates a modifier list with an item so the associated modifier options can be applied to the item.
V1
CreateCategory
DEPRECATED/v1/{location_id}/categories
Creates an item category.
V1
CreateDiscount
DEPRECATED/v1/{location_id}/discounts
Creates a discount.
V1
CreateFee
DEPRECATED/v1/{location_id}/fees
Creates a fee (tax).
V1
CreateItem
DEPRECATED/v1/{location_id}/items
Creates an item and at least one variation for it.
V1
CreateModifierList
DEPRECATED/v1/{location_id}/modifier-lists
Creates an item modifier list and at least 1 modifier option for it.
V1
CreateModifierOption
DEPRECATED/v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options
Creates an item modifier option and adds it to a modifier list.
V1
CreatePage
DEPRECATED/v1/{location_id}/pages
Creates a Favorites page in Square Point of Sale.
V1
CreateVariation
DEPRECATED/v1/{location_id}/items/{item_id}/variations
Creates an item variation for an existing item.
V1
DeleteCategory
DEPRECATED/v1/{location_id}/categories/{category_id}
Deletes an existing item category.
V1
DeleteDiscount
DEPRECATED/v1/{location_id}/discounts/{discount_id}
Deletes an existing discount.
V1
DeleteFee
DEPRECATED/v1/{location_id}/fees/{fee_id}
Deletes an existing fee (tax).
V1
DeleteItem
DEPRECATED/v1/{location_id}/items/{item_id}
Deletes an existing item and all item variations associated with it.
V1
DeleteModifierList
DEPRECATED/v1/{location_id}/modifier-lists/{modifier_list_id}
Deletes an existing item modifier list and all modifier options associated with it.
V1
DeleteModifierOption
DEPRECATED/v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id}
Deletes an existing item modifier option from a modifier list.
V1
DeletePage
DEPRECATED/v1/{location_id}/pages/{page_id}
Deletes an existing Favorites page and all of its cells.
V1
DeletePageCell
DEPRECATED/v1/{location_id}/pages/{page_id}/cells
Deletes a cell from a Favorites page in Square Point of Sale.
V1
DeleteVariation
DEPRECATED/v1/{location_id}/items/{item_id}/variations/{variation_id}
Deletes an existing item variation from an item.
V1
ListCategories
DEPRECATED/v1/{location_id}/categories
Lists all the item categories for a given location.
V1
ListDiscounts
DEPRECATED/v1/{location_id}/discounts
Lists all the discounts for a given location.
V1
ListFees
DEPRECATED/v1/{location_id}/fees
Lists all the fees (taxes) for a given location.
V1
ListItems
DEPRECATED/v1/{location_id}/items
Provides summary information of all items for a given location.
V1
ListModifierLists
DEPRECATED/v1/{location_id}/modifier-lists
Lists all the modifier lists for a given location.
V1
ListPages
DEPRECATED/v1/{location_id}/pages
Lists all Favorites pages (in Square Point of Sale) for a given location.
V1
RemoveFee
DEPRECATED/v1/{location_id}/items/{item_id}/fees/{fee_id}
Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale.
V1
RemoveModifierList
DEPRECATED/v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}
Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item.
V1
RetrieveItem
DEPRECATED/v1/{location_id}/items/{item_id}
Provides the details for a single item, including associated modifier lists and fees.
V1
RetrieveModifierList
DEPRECATED/v1/{location_id}/modifier-lists/{modifier_list_id}
Provides the details for a single modifier list.
V1
UpdateCategory
DEPRECATED/v1/{location_id}/categories/{category_id}
Modifies the details of an existing item category.
V1
UpdateDiscount
DEPRECATED/v1/{location_id}/discounts/{discount_id}
Modifies the details of an existing discount.
V1
UpdateFee
DEPRECATED/v1/{location_id}/fees/{fee_id}
Modifies the details of an existing fee (tax).
V1
UpdateItem
DEPRECATED/v1/{location_id}/items/{item_id}
Modifies the core details of an existing item.
V1
UpdateModifierList
DEPRECATED/v1/{location_id}/modifier-lists/{modifier_list_id}
Modifies the details of an existing item modifier list.
V1
UpdateModifierOption
DEPRECATED/v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id}
Modifies the details of an existing item modifier option.
V1
UpdatePage
DEPRECATED/v1/{location_id}/pages/{page_id}
Modifies the details of a Favorites page in Square Point of Sale.
V1
UpdatePageCell
DEPRECATED/v1/{location_id}/pages/{page_id}/cells
Modifies a cell of a Favorites page in Square Point of Sale.
V1
UpdateVariation
DEPRECATED/v1/{location_id}/items/{item_id}/variations/{variation_id}
Modifies the details of an existing item variation.
V1
UploadItemImage
DEPRECATED/v1/{location_id}/items/{item_id}/image
Uploads a JPEG or PNG image and sets it as the master image for an item.
V1

Inventory

AdjustInventory
DEPRECATED/v1/{location_id}/inventory/{variation_id}
Adjusts the current available inventory of an item variation.
V1
ListInventory
DEPRECATED/v1/{location_id}/inventory
Provides inventory information for all inventory-enabled item variations.
V1

Labor

CreateTimecard
DEPRECATED/v1/me/timecards
Creates a timecard for an employee and clocks them in with an APICREATE event and a clockintime set to the current time unless the request provides a different value.
V1
DeleteTimecard
DEPRECATED/v1/me/timecards/{timecard_id}
Deletes a timecard.
V1
ListTimecardEvents
DEPRECATED/v1/me/timecards/{timecard_id}/events
Provides summary information for all events associated with a particular timecard.
V1
ListTimecards
DEPRECATED/v1/me/timecards
Provides summary information for all of a business's employee timecards.
V1
RetrieveTimecard
DEPRECATED/v1/me/timecards/{timecard_id}
Provides the details for a single timecard.
V1
UpdateTimecard
DEPRECATED/v1/me/timecards/{timecard_id}
Modifies the details of a timecard with an API_EDIT event for the timecard.
V1

Locations

ListLocations
DEPRECATED/v1/me/locations
Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location.
V1

Merchants

RetrieveBusiness
DEPRECATED/v1/me
Get the general information for a business.
V1

OAuth

RenewToken
DEPRECATED/oauth2/clients/{client_id}/access-token/renew
RenewToken is deprecated.

Transactions

CaptureTransaction
DEPRECATED/v2/locations/{location_id}/transactions/{transaction_id}/capture
Captures a transaction that was created with the Charge endpoint with a delay_capture value of true.
Charge
DEPRECATED/v2/locations/{location_id}/transactions
Charges a card represented by a card nonce or a customer's card on file.
CreateRefund
DEPRECATED/v2/locations/{location_id}/transactions/{transaction_id}/refund
Initiates a refund for a previously charged tender.
ListRefunds
DEPRECATED/v2/locations/{location_id}/refunds
Lists refunds for one of a business's locations.
ListTransactions
DEPRECATED/v2/locations/{location_id}/transactions
Lists transactions for a particular location.
RetrieveTransaction
DEPRECATED/v2/locations/{location_id}/transactions/{transaction_id}
Retrieves details for a single transaction.
VoidTransaction
DEPRECATED/v2/locations/{location_id}/transactions/{transaction_id}/void
Cancels a transaction that was created with the Charge endpoint with a delay_capture value of true.

V1Batching

V1SubmitBatch
DEPRECATED/v1/batch
Bundle multiple requests to Connect V1 API endpoints as a single request.
V1

Development

Guides
API Reference
API Explorer
SDKs
Sample apps
System status

Support

Developer forums
Contact support
Developer blog
Discord community
YouTube
X

More

Square Home
Square Developer
App Marketplace
Partner with Square
Solutions Partner Program
Pricing
Sales

© 2025 Square, Inc.

Developer terms of service
Developer Integration and Marketing Agreement
Privacy policy