Square API
You are viewing an old version of the API
Catalog
Square API
Sync items to Square POS to itemize payments consistently across all channels
The Catalog API allows you to manage your item catalog in Point of Sale, including items, variations, categories, discounts, taxes, modifiers, and more.
You can efficiently sync items between your systems and Square by using our batch APIs, which allow you update many catalog items at once.
Endpoints
You are viewing an old version of the API
-
Batch delete catalog objects
POST /v2/catalog/batch-delete - Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response
-
Batch upsert catalog objects
POST /v2/catalog/batch-upsert - Creates or updates up to 10000 target objects based on the provided list of objects
-
Create catalog image
POST /v2/catalog/images - Upload an image file to create a new CatalogImage for an existing CatalogObject
-
Catalog info
GET /v2/catalog/info - Returns information about the Square Catalog API such as batch size limits for BatchUpsertCatalogObjects
-
List catalog
GET /v2/catalog/list - Returns a list of CatalogObjects that includes all objects of a set of desired types for example all CatalogItem and CatalogTax objects in the catalog
-
Upsert catalog object
POST /v2/catalog/object - Creates or updates the target CatalogObject
-
Delete catalog object
DELETE /v2/catalog/object/{object_id} - Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response
-
Retrieve catalog object
GET /v2/catalog/object/{object_id} - Returns a single CatalogItem as a CatalogObject based on the provided ID
-
Search catalog objects
POST /v2/catalog/search - Queries the targeted catalog using a variety of query types: CatalogQuerySortedAttribute CatalogQueryExact CatalogQueryRange CatalogQueryText CatalogQueryItemsForTax and CatalogQueryItemsForModifierList
-
Update item modifier lists
POST /v2/catalog/update-item-modifier-lists - Updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item
-
Update item taxes
POST /v2/catalog/update-item-taxes - Updates the CatalogTax objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item
-
Batch retrieve catalog objects
POST /v2/catalog/batch-retrieve - Returns a set of objects based on the provided ID
V1 Endpoints
Some operations require use of Connect V1 endpoints. See When to use Connect V1 to learn more.
-
Delete item
DELETE /v1/{location_id}/items/{item_id} - Deletes an existing item and all item variations associated with it
V1 -
Apply fee
PUT /v1/{location_id}/items/{item_id}/fees/{fee_id} - Associates a fee with an item meaning the fee is automatically applied to the item in Square Register
V1 -
Apply modifier list
PUT /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} - Associates a modifier list with an item meaning modifier options from the list can be applied to the item
V1 -
Create category
POST /v1/{location_id}/categories - Creates an item category
V1 -
Create discount
POST /v1/{location_id}/discounts - Creates a discount
V1 -
Create fee
POST /v1/{location_id}/fees - Creates a fee tax
V1 -
Create item
POST /v1/{location_id}/items - Creates an item and at least one variation for it
V1 -
Create modifier list
POST /v1/{location_id}/modifier-lists - Creates an item modifier list and at least one modifier option for it
V1 -
Create modifier option
POST /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options - Creates an item modifier option and adds it to a modifier list
V1 -
Create page
POST /v1/{location_id}/pages - Creates a Favorites page in Square Register
V1 -
Create variation
POST /v1/{location_id}/items/{item_id}/variations - Creates an item variation for an existing item
V1 -
Delete category
DELETE /v1/{location_id}/categories/{category_id} - Deletes an existing item category
V1 -
Delete discount
DELETE /v1/{location_id}/discounts/{discount_id} - Deletes an existing discount
V1 -
Delete fee
DELETE /v1/{location_id}/fees/{fee_id} - Deletes an existing fee tax
V1 -
Delete modifier list
DELETE /v1/{location_id}/modifier-lists/{modifier_list_id} - Deletes an existing item modifier list and all modifier options associated with it
V1 -
Delete modifier option
DELETE /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} - Deletes an existing item modifier option from a modifier list
V1 -
Delete page
DELETE /v1/{location_id}/pages/{page_id} - Deletes an existing Favorites page and all of its cells
V1 -
Delete page cell
DELETE /v1/{location_id}/pages/{page_id}/cells - Deletes a cell from a Favorites page in Square Register
V1 -
Delete variation
DELETE /v1/{location_id}/items/{item_id}/variations/{variation_id} - Deletes an existing item variation from an item
V1 -
List categories
GET /v1/{location_id}/categories - Lists all of a location's item categories
V1 -
List discounts
GET /v1/{location_id}/discounts - Lists all of a location's discounts
V1 -
List fees
GET /v1/{location_id}/fees - Lists all of a location's fees taxes
V1 -
List items
GET /v1/{location_id}/items - Provides summary information for all of a location's items
V1 -
List modifier lists
GET /v1/{location_id}/modifier-lists - Lists all of a location's modifier lists
V1 -
List pages
GET /v1/{location_id}/pages - Lists all of a location's Favorites pages in Square Register
V1 -
Remove fee
DELETE /v1/{location_id}/items/{item_id}/fees/{fee_id} - Removes a fee assocation from an item meaning the fee is no longer automatically applied to the item in Square Register
V1 -
Remove modifier list
DELETE /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} - Removes a modifier list association from an item meaning modifier options from the list can no longer be applied to the item
V1 -
Retrieve item
GET /v1/{location_id}/items/{item_id} - Provides the details for a single item including associated modifier lists and fees
V1 -
Retrieve modifier list
GET /v1/{location_id}/modifier-lists/{modifier_list_id} - Provides the details for a single modifier list
V1 -
Update category
PUT /v1/{location_id}/categories/{category_id} - Modifies the details of an existing item category
V1 -
Update discount
PUT /v1/{location_id}/discounts/{discount_id} - Modifies the details of an existing discount
V1 -
Update fee
PUT /v1/{location_id}/fees/{fee_id} - Modifies the details of an existing fee tax
V1 -
Update item
PUT /v1/{location_id}/items/{item_id} - Modifies the core details of an existing item
V1 -
Update modifier list
PUT /v1/{location_id}/modifier-lists/{modifier_list_id} - Modifies the details of an existing item modifier list
V1 -
Update modifier option
PUT /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} - Modifies the details of an existing item modifier option
V1 -
Update page
PUT /v1/{location_id}/pages/{page_id} - Modifies the details of a Favorites page in Square Register
V1 -
Update page cell
PUT /v1/{location_id}/pages/{page_id}/cells - Modifies a cell of a Favorites page in Square Register
V1 -
Update variation
PUT /v1/{location_id}/items/{item_id}/variations/{variation_id} - Modifies the details of an existing item variation
V1 -
Upload item image
POST /v1/{location_id}/items/{item_id}/image - Uploads a JPEG or PNG image and sets it as the master image for an item
V1