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.
Servers
- https://connect.squareup.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
types |
String | No |
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_version |
Integer | No |
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' |
cursor |
String | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.