stagedUploadsCreate mutation

Creates staged upload target URLs for each input and is the first step in the upload process. The returned upload targets with URLs can be used as endpoints to upload the files.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation stagedUploadsCreate($input: [StagedUploadInput!]!) { stagedUploadsCreate(input: $input) { 
  1. <font style="color:#1F61A0;">stagedTargets</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">resourceUrl</font>
  5.   <font style="color:#1F61A0;">url</font>
  7. <font style="color:#555555;">}</font>
  9. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “input”: [ 
  1. <font style="color:#555555;">{</font>
  3.   <font style="color:#8B2BB9;">"resource"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  5.   <font style="color:#8B2BB9;">"filename"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  7.   <font style="color:#8B2BB9;">"mimeType"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
  9. <font style="color:#555555;">}</font>
] }

Arguments

Argument Description
input
(
[[StagedUploadInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/stageduploadinput)

) REQUIRED		 Input for the mutation includes information needed to generate staged upload targets.

StagedUploadInput fields

  • fileSize ([UnsignedInt64](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    Size of the file to upload, in bytes. This is required for VIDEO and MODEL_3D resources.
  • filename ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    Media filename.
  • httpMethod ([StagedUploadHttpMethodType](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/stageduploadhttpmethodtype))
    HTTP method to be used by the Staged Upload.
  • mimeType ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    Media MIME type.
  • resource ([StagedUploadTargetGenerateUploadResource!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/stageduploadtargetgenerateuploadresource)) REQUIRED
    Media resource.

Return fields

  • stagedTargets ([[StagedMediaUploadTarget!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/stagedmediauploadtarget))
    The staged upload targets that were generated.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.