<- Catalog API

Catalog API

Search catalog objects

POST

 /v2/catalog/search

Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters.

This (SearchCatalogObjects) endpoint differs from the SearchCatalogItems endpoint in the following aspects:

  • SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
  • SearchCatalogItems supports the custom attribute query filters to return items or item variations that contain custom attribute values, where SearchCatalogObjects does not.
  • SearchCatalogItems does not support the include_deleted_objects filter to search for deleted items or item variations, whereas SearchCatalogObjects does.
  • The both endpoints have different call conventions, including the query filter formats.
Permissions:ITEMS_READ

Guide

Call SearchCatalogObjects

Try in API Explorer
Link to section

Request body

Example code

Link to section

cursor

string

The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information.

Link to section

object_types

string [ ]

The desired set of object types to appear in the search results.

If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults.

At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.

Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest in this field.

Link to section

include_deleted_objects

boolean

If true, deleted objects will be included in the results. Deleted objects will have their is_deleted field set to true.

Link to section

include_related_objects

boolean

If true, the response will include additional objects that are related to the requested objects. Related objects are objects that are referenced by object ID by the objects in the response. This is helpful if the objects are being fetched for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example:

If the objects field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the related_objects field of the response. If the objects field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the related_objects field of the response.

Default value: false

Link to section

begin_time

string

Return objects modified after this timestamp, in RFC 3339 format, e.g., 2016-09-04T23:59:33.123Z. The timestamp is exclusive - objects with a timestamp equal to begin_time will not be included in the response.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

query

A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.

Link to section

limit

integer(32-bit)

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If unset, this is the final response. See Pagination for more information.

Link to section

objects

The CatalogObjects returned.

Link to section

related_objects

A list of CatalogObjects referenced by the objects in the objects field.

Link to section

latest_time

string

Beta

When the associated product catalog was last updated. Will match the value for end_time or cursor if either field is included in the SearchCatalog request.