stagedUploadTargetGenerate mutation

Deprecation warning

Use stagedUploadsCreate instead

Generates the URL and signed paramaters needed to upload an asset to Shopify.

On this page

• Interactive example
• Arguments
• StagedUploadTargetGenerateInput fields
• Return fields

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.

<font style="color:#1F61A0;">parameters</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">name</font>
  <font style="color:#1F61A0;">value</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">url</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

<font style="color:#8B2BB9;">"resource"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
<font style="color:#8B2BB9;">"filename"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
<font style="color:#8B2BB9;">"mimeType"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>

Arguments

StagedUploadTargetGenerateInput fields

• fileSize ([UnsignedInt64](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
  The size of the file to upload, in bytes.
• filename ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
  The filename of the asset being uploaded.
• httpMethod ([StagedUploadHttpMethodType](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/stageduploadhttpmethodtype))
  The HTTP method to be used by the staged upload.
• mimeType ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
  The MIME type of the asset being uploaded.
• resource ([StagedUploadTargetGenerateUploadResource!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/stageduploadtargetgenerateuploadresource)) REQUIRED
  The resource type being uploaded.

Return fields

• parameters ([[MutationsStagedUploadTargetGenerateUploadParameter!]!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mutationsstageduploadtargetgenerateuploadparameter))
  The signed parameters that can be used to upload the asset.
• url ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The signed URL where the asset can be uploaded.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.