stagedUploadsCreate

mutation

Creates staged upload targets for each input. This is the first step in the upload process. The returned staged upload targets' URL and parameter fields can be used to send a request to upload the file described in the corresponding input.

For more information on the upload process, refer to Upload media to Shopify.

Arguments

Anchor to inputinput • [StagedUploadInput!]!required: The information required to generate staged upload targets.

Was this section helpful?

Anchor to StagedUploadsCreatePayload returnsStagedUploadsCreatePayload returns

Anchor to stagedTargetsstagedTargets • [StagedMediaUploadTarget!]: The staged upload targets that were generated.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create staged upload targets
stagedUploadsCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
6    stagedUploadsCreate(input: $input) {
7      stagedTargets {
8        url
9        resourceUrl
10        parameters {
11          name
12          value
13        }
14      }
15    }
16  }`,
17  {
18    variables: {
19      "input": [
20        {
21          "filename": "image1.png",
22          "mimeType": "image/png",
23          "httpMethod": "POST",
24          "resource": "IMAGE"
25        },
26        {
27          "filename": "video.mp4",
28          "mimeType": "video/mp4",
29          "fileSize": "1234",
30          "resource": "VIDEO"
31        },
32        {
33          "filename": "3d_model.glb",
34          "mimeType": "model/gltf-binary",
35          "resource": "MODEL_3D",
36          "fileSize": "456"
37        }
38      ]
39    },
40  },
41);
42
43const data = await response.json();
44

mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
  stagedUploadsCreate(input: $input) {
    stagedTargets {
      url
      resourceUrl
      parameters {
        name
        value
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation stagedUploadsCreate($input: [StagedUploadInput!]!) { stagedUploadsCreate(input: $input) { stagedTargets { url resourceUrl parameters { name value } } } }",
 "variables": {
    "input": [
      {
        "filename": "image1.png",
        "mimeType": "image/png",
        "httpMethod": "POST",
        "resource": "IMAGE"
      },
      {
        "filename": "video.mp4",
        "mimeType": "video/mp4",
        "fileSize": "1234",
        "resource": "VIDEO"
      },
      {
        "filename": "3d_model.glb",
        "mimeType": "model/gltf-binary",
        "resource": "MODEL_3D",
        "fileSize": "456"
      }
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
    stagedUploadsCreate(input: $input) {
      stagedTargets {
        url
        resourceUrl
        parameters {
          name
          value
        }
      }
    }
  }`,
  {
    variables: {
      "input": [
        {
          "filename": "image1.png",
          "mimeType": "image/png",
          "httpMethod": "POST",
          "resource": "IMAGE"
        },
        {
          "filename": "video.mp4",
          "mimeType": "video/mp4",
          "fileSize": "1234",
          "resource": "VIDEO"
        },
        {
          "filename": "3d_model.glb",
          "mimeType": "model/gltf-binary",
          "resource": "MODEL_3D",
          "fileSize": "456"
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
      stagedUploadsCreate(input: $input) {
        stagedTargets {
          url
          resourceUrl
          parameters {
            name
            value
          }
        }
      }
    }`,
    "variables": {
      "input": [
        {
          "filename": "image1.png",
          "mimeType": "image/png",
          "httpMethod": "POST",
          "resource": "IMAGE"
        },
        {
          "filename": "video.mp4",
          "mimeType": "video/mp4",
          "fileSize": "1234",
          "resource": "VIDEO"
        },
        {
          "filename": "3d_model.glb",
          "mimeType": "model/gltf-binary",
          "resource": "MODEL_3D",
          "fileSize": "456"
        }
      ]
    },
  },
});

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
  mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
    stagedUploadsCreate(input: $input) {
      stagedTargets {
        url
        resourceUrl
        parameters {
          name
          value
        }
      }
    }
  }
QUERY

variables = {
  "input": [{"filename"=>"image1.png", "mimeType"=>"image/png", "httpMethod"=>"POST", "resource"=>"IMAGE"}, {"filename"=>"video.mp4", "mimeType"=>"video/mp4", "fileSize"=>"1234", "resource"=>"VIDEO"}, {"filename"=>"3d_model.glb", "mimeType"=>"model/gltf-binary", "resource"=>"MODEL_3D", "fileSize"=>"456"}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": [
3    {
4      "filename": "image1.png",
5      "mimeType": "image/png",
6      "httpMethod": "POST",
7      "resource": "IMAGE"
8    },
9    {
10      "filename": "video.mp4",
11      "mimeType": "video/mp4",
12      "fileSize": "1234",
13      "resource": "VIDEO"
14    },
15    {
16      "filename": "3d_model.glb",
17      "mimeType": "model/gltf-binary",
18      "resource": "MODEL_3D",
19      "fileSize": "456"
20    }
21  ]
22}

Response

JSON

1{
2  "stagedUploadsCreate": {
3    "stagedTargets": [
4      {
5        "url": "https://snowdevil.myshopify.com/admin/tmp/files",
6        "resourceUrl": "https://snowdevil.myshopify.com/tmp/26371970/products/a743377e-dca3-4d44-94a0-45ab3b06d592/image1.png",
7        "parameters": [
8          {
9            "name": "filename",
10            "value": "image1.png"
11          },
12          {
13            "name": "mime_type",
14            "value": "image/png"
15          },
16          {
17            "name": "key",
18            "value": "tmp/26371970/products/a743377e-dca3-4d44-94a0-45ab3b06d592/image1.png"
19          }
20        ]
21      },
22      {
23        "url": "http://upload.example.com/target",
24        "resourceUrl": "http://upload.example.com/target?external_video_id=25",
25        "parameters": [
26          {
27            "name": "GoogleAccessId",
28            "value": "video-development@video-production123.iam.gserviceaccount.com"
29          },
30          {
31            "name": "key",
32            "value": "dev/o/v/video.mp4"
33          },
34          {
35            "name": "policy",
36            "value": "abc123"
37          },
38          {
39            "name": "signature",
40            "value": "abc123"
41          }
42        ]
43      },
44      {
45        "url": "http://upload.example.com/target/dev/o/v/3d_model.glb?external_model3d_id=25",
46        "resourceUrl": "http://upload.example.com/target/dev/o/v/3d_model.glb?external_model3d_id=25",
47        "parameters": [
48          {
49            "name": "GoogleAccessId",
50            "value": "video-development@video-production123.iam.gserviceaccount.com"
51          },
52          {
53            "name": "key",
54            "value": "dev/o/v/3d_model.glb"
55          },
56          {
57            "name": "policy",
58            "value": "abc123"
59          },
60          {
61            "name": "signature",
62            "value": "abc123"
63          }
64        ]
65      }
66    ]
67  }
68}