Choose a version:

mediaCreate

mutation

Create a new shop video with related products.

Anchor to Arguments

Arguments

Anchor to inputinput

•MediaCreateInput!

required

Was this section helpful?

Anchor to MediaCreatePayload returnsMediaCreatePayload returns

Anchor to shopVideoshopVideo •ShopVideo
Anchor to userErrorsuserErrors •[UserError!]! non-null: List of errors that occured while executing the mutation.

Was this section helpful?

Examples

mediaCreate reference

Mutation Reference

mutation mediaCreate($input: MediaCreateInput!) {

mediaCreate(input: $input) {

shopVideo {

# ShopVideo fields

}

userErrors {

field

message

}

Input

{

"input": {

"mediaImageId": "gid://shopify/<objectName>/10079785100",

"previewImageUrl": "https://example.myshopify.com",

"relatedProducts": [

{

"productId": "gid://shopify/<objectName>/10079785100",

"productVariantId": "gid://shopify/<objectName>/10079785100"

}

"videoId": "gid://shopify/<objectName>/10079785100",

"videoUrl": "https://example.myshopify.com"

}

Variables

{
  "input": {
    "mediaImageId": "gid://shopify/<objectName>/10079785100",
    "previewImageUrl": "https://example.myshopify.com",
    "relatedProducts": [
      {
        "productId": "gid://shopify/<objectName>/10079785100",
        "productVariantId": "gid://shopify/<objectName>/10079785100"
      }
    ],
    "videoId": "gid://shopify/<objectName>/10079785100",
    "videoUrl": "https://example.myshopify.com"
  }
}

Schema

input MediaCreateInput {
  mediaImageId: ID
  previewImageUrl: URL!
  relatedProducts: [RelatedProductInput!]!
  videoId: ID
  videoUrl: URL!
}

input RelatedProductInput {
  productId: ID!
  productVariantId: ID
}