stagedUploadsCreate
mutation

Choose a version:

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.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'StagedUploadsCreatePayload returns'

StagedUploadsCreatePayload returns

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

Was this section helpful?

Examples

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-01/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();

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)

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"
        }
      ]
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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

{
  "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"
    }
  ]
}

stagedUploadsCreatemutation

Arguments

StagedUploadsCreatePayload returns

Examples

stagedUploadsCreate
mutation