POST /v2/catalog/search-catalog-items

Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query expressions.

This (SearchCatalogItems) endpoint differs from the SearchCatalogObjects 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 use different call conventions, including the query filter formats.

Servers

https://connect.squareup.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`category_ids[]`	Array	No	The category id query expression to return items containing the specified category IDs.
`text_filter`	String	No	The text filter expression to return items or item variations containing specified text in the `name`, `description`, or `abbreviation` attribute value of an item, or in the `name`, `sku`, or `upc` attribute value of an item variation.
`stock_levels[]`	Array	No	The stock-level query expression to return item variations with the specified stock levels.
`sort_order`	String	No	The order to sort the results by item names. The default sort order is ascending (`ASC`).
`limit`	Integer	No	The maximum number of results to return per page. The default value is 100.
`product_types[]`	Array	No	The product types query expression to return items or item variations having the specified product types.
`enabled_location_ids[]`	Array	No	The enabled-location query expression to return items and item variations having specified enabled locations.
`custom_attribute_filters[]`	Array	No	The customer-attribute filter to return items or item variations matching the specified custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in a single call to the SearchCatalogItems endpoint.
`custom_attribute_filters[].string_filter`	String	No	A query expression to filter items or item variations by matching their custom attributes' `string_value` property value against the specified text.
`custom_attribute_filters[].custom_attribute_definition_id`	String	No	A query expression to filter items or item variations by matching their custom attributes' `custom_attribute_definition_id` property value against the the specified id.
`custom_attribute_filters[].key`	String	No	A query expression to filter items or item variations by matching their custom attributes' `key` property value against the specified key.
`custom_attribute_filters[].bool_filter`	Boolean	No	A query expression to filter items or item variations by matching their custom attributes' `boolean_value` property values against the specified Boolean expression.
`custom_attribute_filters[].number_filter`	Object	No	The range of a number value between the specified lower and upper bounds.
`custom_attribute_filters[].number_filter.min`	String	No	The lower bound of the number range.
`custom_attribute_filters[].number_filter.max`	String	No	The upper bound of the number range.
`custom_attribute_filters[].selection_uids_filter[]`	Array	No	A query expression to filter items or item variations by matching their custom attributes' `selection_uid_values` values against the specified selection uids.
`cursor`	String	No	The pagination token, returned in the previous response, used to fetch the next batch of pending results.

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.