ListCatalog
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.
Query parameters
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.
An optional case-insensitive, comma-separated list of object types to retrieve.
The valid values are defined in the CatalogObjectType enum, including ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, or IMAGE.
If this is unspecified, the operation returns objects of all the types at the version of the Square API used to make the request.
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
Success
Example response
{
"objects": [
{
"category_data": {
"name": "Beverages"
},
"id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
"is_deleted": false,
"present_at_all_locations": true,
"type": "CATEGORY",
"updated_at": "2017-02-21T14:50:26.495Z",
"version": 1487688626495
},
{
"id": "L5R47DGBZOOVKCAFIXC56AEN",
"is_deleted": false,
"present_at_all_locations": true,
"tax_data": {
"calculation_phase": "TAX_SUBTOTAL_PHASE",
"enabled": true,
"inclusion_type": "ADDITIVE",
"name": "Sales Tax",
"percentage": "5.0"
},
"type": "TAX",
"updated_at": "2017-02-21T14:50:26.495Z",
"version": 1487688626495
}
]
}