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.
-
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 10,000 target objects based on the provided list of objects.
-
Create catalog image
POST /v2/catalog/images - Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.
-
Catalog info
GET /v2/catalog/info - Retrieves information about the Square Catalog API, such as batch size limits that can be used by the BatchUpsertCatalogObjects endpoint.
-
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 - Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions, This SearchCatalogObjects endpoint differs from the SearchCatalogItems endpoint in the following aspects: - SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
-
Search catalog items
POST /v2/catalog/search-catalog-items - Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query expressions, This SearchCatalogItems endpoint differs from the SearchCatalogObjects endpoint in the following aspects: - SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
BETA -
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.