You are viewing an old version of the API

All Versions

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.

The types parameter is specified as a comma-separated list of valid CatalogObject types: ITEM, ITEM_VARIATION, MODIFIER, MODIFIER_LIST, CATEGORY, DISCOUNT, TAX, IMAGE.

Important: ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set the include_deleted_objects attribute value to true.

Permissions

ITEMS_READ

Try in API Explorer

Query Parameters

Example code

Name	Description
`cursor string`	The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information.
`types string`	An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.
`catalog_version integer (32-bit)`	The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' `version` attribute.

Response Fields

Name	Description
`errors Error [ ]`	Any errors that occurred during the request.
`cursor string`	The pagination cursor to be used in a subsequent request. If unset, this is the final response. See Pagination for more information.
`objects CatalogObject [ ]`	The CatalogObjects returned.

Examples

curl https://connect.squareup.com/v2/catalog/list?types=category%2Ctax \
  -H 'Square-Version: 2021-03-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

{
  "objects": [
    {
      "type": "CATEGORY",
      "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
      "updated_at": "2017-02-21T14:50:26.495Z",
      "version": 1487688626495,
      "is_deleted": false,
      "present_at_all_locations": true,
      "category_data": {
        "name": "Beverages"
      }
    },
    {
      "type": "TAX",
      "id": "L5R47DGBZOOVKCAFIXC56AEN",
      "updated_at": "2017-02-21T14:50:26.495Z",
      "version": 1487688626495,
      "is_deleted": false,
      "present_at_all_locations": true,
      "tax_data": {
        "name": "Sales Tax",
        "calculation_phase": "TAX_SUBTOTAL_PHASE",
        "inclusion_type": "ADDITIVE",
        "percentage": "5.0",
        "enabled": true
      }
    }
  ]
}

Catalog API You are viewing an old version of the API 2021-03-17 Version 2021-03-17 All Versions Catalog API List catalog

Query Parameters

Response Fields

Examples

Share Feedback

You are viewing an old version of the API

All Versions

List catalog