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 retrieve catalog objects
POST /v2/catalog/batch-retrieve - Returns a set of objects based on the provided ID
-
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