Square API
You are viewing an old version of the API
Deprecated
Square API
View older Connect APIs and endpoints that have been deprecated and replaced with newer versions in the Square API.
Note We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 and API retirement timelines to learn more.
OAuth
You are viewing an old version of the API
V1Batching
Catalog
-
Create category
DEPRECATED POST /v1/{location_id}/categories - Creates an item category
-
List categories
DEPRECATED GET /v1/{location_id}/categories - Lists all the item categories for a given location
-
Delete category
DEPRECATED DELETE /v1/{location_id}/categories/{category_id} - Deletes an existing item category
-
Update category
DEPRECATED PUT /v1/{location_id}/categories/{category_id} - Modifies the details of an existing item category
-
List discounts
DEPRECATED GET /v1/{location_id}/discounts - Lists all the discounts for a given location
-
Create discount
DEPRECATED POST /v1/{location_id}/discounts - Creates a discount
-
Delete discount
DEPRECATED DELETE /v1/{location_id}/discounts/{discount_id} - Deletes an existing discount
-
Update discount
DEPRECATED PUT /v1/{location_id}/discounts/{discount_id} - Modifies the details of an existing discount
-
Create fee
DEPRECATED POST /v1/{location_id}/fees - Creates a fee tax
-
List fees
DEPRECATED GET /v1/{location_id}/fees - Lists all the fees taxes for a given location
-
Delete fee
DEPRECATED DELETE /v1/{location_id}/fees/{fee_id} - Deletes an existing fee tax
-
Update fee
DEPRECATED PUT /v1/{location_id}/fees/{fee_id} - Modifies the details of an existing fee tax
-
Create item
DEPRECATED POST /v1/{location_id}/items - Creates an item and at least one variation for it
-
List items
DEPRECATED GET /v1/{location_id}/items - Provides summary information of all items for a given location
-
Update item
DEPRECATED PUT /v1/{location_id}/items/{item_id} - Modifies the core details of an existing item
-
Retrieve item
DEPRECATED GET /v1/{location_id}/items/{item_id} - Provides the details for a single item including associated modifier lists and fees
-
Delete item
DEPRECATED DELETE /v1/{location_id}/items/{item_id} - Deletes an existing item and all item variations associated with it
-
Apply fee
DEPRECATED PUT /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
-
Remove fee
DEPRECATED DELETE /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
-
Upload item image
DEPRECATED POST /v1/{location_id}/items/{item_id}/image - Uploads a JPEG or PNG image and sets it as the master image for an item
-
Apply modifier list
DEPRECATED PUT /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
-
Remove modifier list
DEPRECATED DELETE /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
-
Create variation
DEPRECATED POST /v1/{location_id}/items/{item_id}/variations - Creates an item variation for an existing item
-
Delete variation
DEPRECATED DELETE /v1/{location_id}/items/{item_id}/variations/{variation_id} - Deletes an existing item variation from an item
-
Update variation
DEPRECATED PUT /v1/{location_id}/items/{item_id}/variations/{variation_id} - Modifies the details of an existing item variation
-
Create modifier list
DEPRECATED POST /v1/{location_id}/modifier-lists - Creates an item modifier list and at least 1 modifier option for it
-
List modifier lists
DEPRECATED GET /v1/{location_id}/modifier-lists - Lists all the modifier lists for a given location
-
Update modifier list
DEPRECATED PUT /v1/{location_id}/modifier-lists/{modifier_list_id} - Modifies the details of an existing item modifier list
-
Delete modifier list
DEPRECATED DELETE /v1/{location_id}/modifier-lists/{modifier_list_id} - Deletes an existing item modifier list and all modifier options associated with it
-
Retrieve modifier list
DEPRECATED GET /v1/{location_id}/modifier-lists/{modifier_list_id} - Provides the details for a single modifier list
-
Create modifier option
DEPRECATED POST /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options - Creates an item modifier option and adds it to a modifier list
-
Delete modifier option
DEPRECATED DELETE /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} - Deletes an existing item modifier option from a modifier list
-
Update modifier option
DEPRECATED PUT /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} - Modifies the details of an existing item modifier option
-
Create page
DEPRECATED POST /v1/{location_id}/pages - Creates a Favorites page in Square Point of Sale
-
List pages
DEPRECATED GET /v1/{location_id}/pages - Lists all Favorites pages in Square Point of Sale for a given location
-
Update page
DEPRECATED PUT /v1/{location_id}/pages/{page_id} - Modifies the details of a Favorites page in Square Point of Sale
-
Delete page
DEPRECATED DELETE /v1/{location_id}/pages/{page_id} - Deletes an existing Favorites page and all of its cells
-
Update page cell
DEPRECATED PUT /v1/{location_id}/pages/{page_id}/cells - Modifies a cell of a Favorites page in Square Point of Sale
-
Delete page cell
DEPRECATED DELETE /v1/{location_id}/pages/{page_id}/cells - Deletes a cell from a Favorites page in Square Point of Sale
Inventory
-
List inventory
DEPRECATED GET /v1/{location_id}/inventory - Provides inventory information for all inventory-enabled item variations
-
Adjust inventory
DEPRECATED POST /v1/{location_id}/inventory/{variation_id} - Adjusts the current available inventory of an item variation
Locations
-
Retrieve business
DEPRECATED GET /v1/me - Get the general information for a business
-
List locations
DEPRECATED GET /v1/me/locations - Provides details for all business locations associated with a Square account including the Square-assigned object ID for the location
Reporting
-
List additional recipient receivable refunds
DEPRECATED GET /v2/locations/{location_id}/additional-recipient-receivable-refunds - Returns a list of refunded transactions across all possible originating locations relating to monies credited to the provided location ID by another Square account using the additional_recipients field in a transaction
-
List additional recipient receivables
DEPRECATED GET /v2/locations/{location_id}/additional-recipient-receivables - Returns a list of receivables across all possible sending locations representing monies credited to the provided location ID by another Square account using the additional_recipients field in a transaction
Transactions
-
List refunds
DEPRECATED GET /v2/locations/{location_id}/refunds - Lists refunds for one of a business's locations
-
Charge
DEPRECATED POST /v2/locations/{location_id}/transactions - Charges a card represented by a card nonce or a customer's card on file
-
List transactions
DEPRECATED GET /v2/locations/{location_id}/transactions - Lists transactions for a particular location
-
Retrieve transaction
DEPRECATED GET /v2/locations/{location_id}/transactions/{transaction_id} - Retrieves details for a single transaction
-
Capture transaction
DEPRECATED POST /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
-
Create refund
DEPRECATED POST /v2/locations/{location_id}/transactions/{transaction_id}/refund - Initiates a refund for a previously charged tender
-
Void transaction
DEPRECATED POST /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