Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 3.05 KB

SearchCatalogObjectsRequest.md

File metadata and controls

17 lines (13 loc) · 3.05 KB

SearchCatalogObjectsRequest

Properties

Name Getter Setter Type Description Notes
cursor getCursor() setCursor($value) string The pagination cursor returned in the previous response. Leave unset for an initial request. See Paginating results for more information. [optional]
object_types getObjectTypes() setObjectTypes($value) string[] The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enumeration, namely `"ITEM"`, `"ITEM_VARIATION"`, `"CATEGORY"`, `"DISCOUNT"`, `"TAX"`, `"MODIFIER"`, or `"MODIFIER_LIST"`. [optional]
include_deleted_objects getIncludeDeletedObjects() setIncludeDeletedObjects($value) bool If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. [optional]
include_related_objects getIncludeRelatedObjects() setIncludeRelatedObjects($value) 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, CatalogTaxes, and CatalogModifierLists 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]
begin_time getBeginTime() setBeginTime($value) 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 getQuery() setQuery($value) \SquareConnect\Model\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 getLimit() setLimit($value) 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]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]