List catalog
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.
| Name | Description |
|---|---|
cursor
|
The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See Pagination for more information. |
types
|
An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the CatalogObjectType enum, including
If this is unspecified, the operation returns objects of all the types at the version of the Square API used to make the request. |
catalog_
Beta
|
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' |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
cursor
|
The pagination cursor to be used in a subsequent request. If unset, this is the final response. See Pagination for more information. |
objects
|
The CatalogObjects returned. |
Examples
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/catalog/list?types=category%2Ctax \
-H 'Square-Version: 2021-05-13' \
-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
}
}
]
}