Choose a version:

files

query

Requires read_files access scope, read_themes access scope or read_images access scope.

Retrieves a paginated list of files that have been uploaded to a Shopify store. Files represent digital assets that merchants can upload to their store for various purposes including product images, marketing materials, documents, and brand assets.

Use the files query to retrieve information associated with the following workflows:

Managing product media and images
Theme development and asset management
Brand asset management and checkout branding

Files can include multiple content types, such as images, videos, 3D models, and generic files. Each file has properties like dimensions, file size, alt text for accessibility, and upload status. Files can be filtered by media type and can be associated with products, themes, and other store resources.

FileConnection arguments

•FileConnection!

after

•String

The elements that come after the specified cursor.

before

•String

The elements that come before the specified cursor.

first

•Int

The first n elements from the paginated list.

last

•Int

The last n elements from the paginated list.

query

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to filename •string
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to media_type •string
Anchor to original_upload_size •float
Anchor to product_id •string
Anchor to status •string
Anchor to updated_at •time
Anchor to used_in •string

reverse

•Boolean

Default:false

Reverse the order of the underlying list.

savedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

sortKey

•FileSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[FileEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[File!]! non-null: A list of nodes that are contained in FileEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Filter files by whether they are used in products
Retrieve a file's features by its ID
Retrieve a list of files
Retrieve a list of files by type
Retrieve files connected to a specific product
Retrieve files with detailed metadata
Search for files by filename pattern

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

usedInProduct: files(first: 10, query: "used_in:product") {

edges {

node {

... on MediaImage {

alt

}

unusedFiles: files(first: 10, query: "used_in:none") {

edges {

node {

... on GenericFile {

alt

}

}`,

);

const data = await response.json();

query {
  usedInProduct: files(first: 10, query: "used_in:product") {
    edges {
      node {
        ... on MediaImage {
          id
          alt
        }
      }
    }
  }
  unusedFiles: files(first: 10, query: "used_in:none") {
    edges {
      node {
        ... on GenericFile {
          id
          alt
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { usedInProduct: files(first: 10, query: \"used_in:product\") { edges { node { ... on MediaImage { id alt } } } } unusedFiles: files(first: 10, query: \"used_in:none\") { edges { node { ... on GenericFile { id alt } } } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    usedInProduct: files(first: 10, query: "used_in:product") {
      edges {
        node {
          ... on MediaImage {
            id
            alt
          }
        }
      }
    }
    unusedFiles: files(first: 10, query: "used_in:none") {
      edges {
        node {
          ... on GenericFile {
            id
            alt
          }
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    usedInProduct: files(first: 10, query: "used_in:product") {
      edges {
        node {
          ... on MediaImage {
            id
            alt
          }
        }
      }
    }
    unusedFiles: files(first: 10, query: "used_in:none") {
      edges {
        node {
          ... on GenericFile {
            id
            alt
          }
        }
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    usedInProduct: files(first: 10, query: "used_in:product") {
      edges {
        node {
          ... on MediaImage {
            id
            alt
          }
        }
      }
    }
    unusedFiles: files(first: 10, query: "used_in:none") {
      edges {
        node {
          ... on GenericFile {
            id
            alt
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"usedInProduct": {

"edges": [

{

"node": {

"id": "gid://shopify/MediaImage/1072273780",

"alt": "derp"

}

{

"node": {

"id": "gid://shopify/MediaImage/1072273781",

"alt": "Connected product image"

}

]

"unusedFiles": {

"edges": [

{

"node": {

"id": "gid://shopify/GenericFile/1072273782",

"alt": "Unused document"

}

]

}