Search > Search > suggestFiles
Commerce APISearchSearchsuggestFiles
suggestFiles
POST:suggest/files.json

Description

Perform a file suggest query.

This endpoint is useful for file autocompletion UI widgets and is optimized to work in situations alike.

Permission bit: "files.search"

Topic: Search

Arguments

data: FileQuery!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

only_images: Boolean

Restrict search to only images

Example: true


only_uploaded_private_files: Boolean

Restrict search to uploaded private files

Example: true


query: String

Search query string

Example: "fancy shoes"


Result

FileExpandableItems

Preview (typescript)

Loading module