Square.Connect.Model.SearchCatalogObjectsRequest
November 20, 2019 ยท View on GitHub
Description
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| Cursor | string | The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information. | [optional] |
| ObjectTypes | List | The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `"ITEM"`, `"ITEM_VARIATION"`, `"CATEGORY"`, `"DISCOUNT"`, `"TAX"`, `"MODIFIER"`, or `"MODIFIER_LIST"`. See CatalogObjectType for possible values | [optional] |
| IncludeDeletedObjects | bool? | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] |
| IncludeRelatedObjects | bool? | If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. | [optional] |
| BeginTime | 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. | [optional] |
| Query | CatalogQuery | A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. | [optional] |
| Limit | int? | 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. | [optional] |