Square Search Catalog Objects

• limitinteger
  Maximum number of results to return per page. This is advisory only; Square may return more or fewer results. Maximum: 1000. Default: 25.
• queryobject
  Composite query for filtering and sorting catalog objects.
• cursorstring
  Pagination cursor returned by a previous call. Use to retrieve the next set of results.
• begin_timestring
  Return objects modified after this RFC 3339 timestamp (exclusive). Use for incremental sync.
• object_typesarray
  The desired catalog object types to include in the result. If not specified, all object types may be returned. Common types include: ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE, MEASUREMENT_UNIT, ITEM_OPTION, PRICING_RULE, PRODUCT_SET, TIME_PERI…
• include_deleted_objectsboolean
  If true, returns deleted objects with is_deleted set to true. Cannot be true simultaneously with include_category_path_to_root. Default: false.
• include_related_objectsboolean
  If true, includes related objects referenced by the result objects (one level deep). For example, if an ITEM is returned, its variations are included. Default: false.
• include_category_path_to_rootboolean
  If true, includes the path_to_root field in category objects showing the hierarchy from root to the category. Cannot be true with include_deleted_objects. Default: false.

• data

  Required
  Data from the action execution
• errorstring
  Error if any occurred during the execution of the action
• successfulboolean

  Required
  Whether or not the action execution was successful or not

No verified related use cases are linked yet.

No published Skills explicitly reference this Action yet.