search-catalog-items-response.md

Search Catalog Items Response

Defines the response body returned from the SearchCatalogItems endpoint.

Structure

SearchCatalogItemsResponse

Fields

Name	Type	Tags	Description	Getter
Errors	List<Error>	Optional	Any errors that occurred during the request.	List getErrors()
Items	List<CatalogObject>	Optional	Returned items matching the specified query expressions.	List getItems()
Cursor	String	Optional	Pagination token used in the next request to return more of the search result.	String getCursor()
MatchedVariationIds	List<String>	Optional	Ids of returned item variations matching the specified query expression.	List getMatchedVariationIds()

Example (as JSON)

{
  "errors": null,
  "items": null,
  "cursor": null,
  "matched_variation_ids": null
}