Square API

You are viewing an old version of the API

2020-03-25

Version 2020-03-25

• All Versions

Square API

Deprecated

Bank Accounts

You are viewing an old version of the API

2020-03-25

Version 2020-03-25

• All Versions

• List bank accounts

  DEPRECATED GET /v1/{location_id}/bank-accounts - Provides non-confidential details for all of a location's associated bank accounts

• Retrieve bank account

  DEPRECATED GET /v1/{location_id}/bank-accounts/{bank_account_id} - Provides non-confidential details for a merchant's associated bank account

Cash Drawers

• List cash drawer shifts

  DEPRECATED GET /v1/{location_id}/cash-drawer-shifts - Provides the details for all of a location's cash drawer shifts during a date range

• Retrieve cash drawer shift

  DEPRECATED GET /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

Catalog

• List categories

  DEPRECATED GET /v1/{location_id}/categories - Lists all the item categories for a given location

• Create category

  DEPRECATED POST /v1/{location_id}/categories - Creates an item category

• 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

• List fees

  DEPRECATED GET /v1/{location_id}/fees - Lists all the fees taxes for a given location

• Create fee

  DEPRECATED POST /v1/{location_id}/fees - Creates a fee tax

• 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

• List items

  DEPRECATED GET /v1/{location_id}/items - Provides summary information of all items for a given location

• Create item

  DEPRECATED POST /v1/{location_id}/items - Creates an item and at least one variation for it

• Delete item

  DEPRECATED DELETE /v1/{location_id}/items/{item_id} - Deletes an existing item and all item variations associated with it

• Retrieve item

  DEPRECATED GET /v1/{location_id}/items/{item_id} - Provides the details for a single item including associated modifier lists and fees

• Update item

  DEPRECATED PUT /v1/{location_id}/items/{item_id} - Modifies the core details of an existing item

• 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

• 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

• 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

• 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

• 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

• 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

• List modifier lists

  DEPRECATED GET /v1/{location_id}/modifier-lists - Lists all the modifier lists for a given location

• Create modifier list

  DEPRECATED POST /v1/{location_id}/modifier-lists - Creates an item modifier list and at least 1 modifier option for it

• 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

• Update modifier list

  DEPRECATED PUT /v1/{location_id}/modifier-lists/{modifier_list_id} - Modifies the details of an existing item 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

• List pages

  DEPRECATED GET /v1/{location_id}/pages - Lists all Favorites pages in Square Point of Sale for a given location

• Create page

  DEPRECATED POST /v1/{location_id}/pages - Creates 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

  DEPRECATED PUT /v1/{location_id}/pages/{page_id} - Modifies the details 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

• Update page cell

  DEPRECATED PUT /v1/{location_id}/pages/{page_id}/cells - Modifies a cell of 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

Labor

• List timecards

  DEPRECATED GET /v1/me/timecards - Provides summary information for all of a business's employee timecards

• Create timecard

  DEPRECATED POST /v1/me/timecards - Creates a timecard for an employee and clocks them in with an API_CREATE event and a clockin_time set to the current time unless the request provides a different value

• Delete timecard

  DEPRECATED DELETE /v1/me/timecards/{timecard_id} - Deletes a timecard

• Retrieve timecard

  DEPRECATED GET /v1/me/timecards/{timecard_id} - Provides the details for a single timecard

• Update timecard

  DEPRECATED PUT /v1/me/timecards/{timecard_id} - Modifies the details of a timecard with an API_EDIT event for the timecard

• List timecard events

  DEPRECATED GET /v1/me/timecards/{timecard_id}/events - Provides summary information for all events associated with a particular timecard

Locations

• 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

Merchants

• Retrieve business

  DEPRECATED GET /v1/me - Get the general information for a business

OAuth

• Renew token

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

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

• List transactions

  DEPRECATED GET /v2/locations/{location_id}/transactions - Lists transactions for a particular location

• Charge

  DEPRECATED POST /v2/locations/{location_id}/transactions - Charges a card represented by a card nonce or a customer's card on file

• 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

V1 Batching

• V1 submit batch

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