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 pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information.
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.
If true
, deleted objects will be included in the results. Deleted objects will have their
is_deleted
field set to true
.
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
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
A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.
The pagination cursor to be used in a subsequent request. If unset, this is the final response. See Pagination for more information.
A list of CatalogObjects referenced by the objects in the objects
field.