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 include_deleted_objects
to true.
Query Parameters
| Name | Description |
|---|---|
cursor
|
The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information. |
types
|
An optional case-insensitive, comma-separated list of object types to retrieve, for example
The legal values are taken from the CatalogObjectType enum:
|
Response Fields
| Name | Description |
|---|---|
cursor
|
The pagination cursor to be used in a subsequent request. If unset, this is the final response. See Pagination for more information. |
errors
|
Information on any errors encountered. |
objects
|
The CatalogObjects returned. |
Examples
- cURL
- Ruby
- Python
curl https://connect.squareup.com/v2/catalog/list \
-H 'Square-Version: 2019-11-20' \
-H 'Authorization: Bearer ACCESS_TOKEN'{
"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
}
}
]
}