Search > Search > searchFiles
Commerce APISearchSearchsearchFiles
searchFiles
POST:search/files.json

Description

Perform a file search query getting metadata back.

Permission bit: "files.search"

Topic: Search

Arguments

data: [SearchOption]!

Main argument for mutations.


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: SearchFilesSortBy

Whether to sort output in some specific way. See also: Pagination


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


Data Argument Fields

boolean: Boolean

Value of the option (if boolean)


context: String

Override nesting level context (when automatic logic gives undesired results)


name: String

Name of the option

Example: "total_price"


nil: Boolean

Value is nil


now: Boolean

Value is now (rfc3339 time value, server's idea of now)


number: Float

Value of the option (if number)


op: SearchOp!

Combining or comparison operator

Example: "and"


parent_index: Int

Index of the parent option (usually "and", "or", "not"), -1 if no parent


text: String

Value of the option (if text)


zero: Boolean

Value is number zero


Result

FileSearchResult

Preview (typescript)

Loading module