younifyd
Menu

files

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…

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the files action (under Files).
  3. Fill in the fields below, then reference the result from later steps as {{files.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query Files($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: FileSortKeys, $query: String, $savedSearchId: ID) {
  files(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
    savedSearchId: $savedSearchId
  ) {
    edges {
      cursor
      node {
        alt
        createdAt
        fileErrors
        fileStatus
        id
        preview
        updatedAt
      }
    }
    nodes {
      alt
      createdAt
      fileErrors {
        code
        details
        message
      }
      fileStatus
      id
      preview {
        image
        status
      }
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofCREATED_ATFILENAMEIDORIGINAL_UPLOAD_SIZERELEVANCEUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | created_at | time | | filename | string | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | ids | string | | media_type | string | | original_upload_size | string | Filter by the file's original upload size in bytes. This filter supports both exact values and ranges. It accepts an optional unit of measurement as a suffix (B, KB, MB, GB, TB). When no unit is provided, the value is interpreted as bytes. Units use binary (1024-based) multipliers. | | | - `original_upload_size:1024`<br/> - `original_upload_size:1.5MB`<br/> - `original_upload_size:>=10MB original_upload_size:<=100MB`<br/> - `original_upload_size:512KB` | | product_id | string | | status | string | | updated_at | time | | used_in | string | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

savedSearchIdstring

The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.

json
{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string",
  "savedSearchId": "string"
}

Response

Read the result with {{files.response.data.data.files}}. If the API returns errors, the step fails and they are at {{files.response.data.errors}}.

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
altobject
createdAtobject
fileErrorsobject
fileStatusobject
idobject
previewobject
updatedAtobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.