Skip to main content
Anchor to MediaUserError

MediaUserError

object

Represents an error that happens during execution of a Media query or mutation.

Anchor to FieldsFields

Anchor to codecode
•MediaUserErrorCode

The error code.

Anchor to fieldfield
•[String!]

The path to the input field that caused the error.

Anchor to messagemessage
•String!
non-null

The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to productReorderMediaproductReorderMedia
•mutation

Reorders media attached to a product, changing their sequence in product displays. The operation processes asynchronously to handle products with large media collections.

Specify the product ID and an array of moves, where each move contains a media ID and its new zero-based position.

Note

Only include media items that need repositioning. Unchanged items maintain their relative order automatically.

The mutation returns a Job to track the reordering progress. Poll the job status to determine when the operation completes and media positions update across all sales channels.

Learn more about reordering product media.

Arguments

Anchor to idid
•ID!
required

The ID of the product on which to reorder medias.

Anchor to movesmoves
•[MoveInput!]!
required

A list of moves to perform which will be evaluated in order.

Anchor to productVariantAppendMediaproductVariantAppendMedia
•mutation

Appends existing media from a product to specific variants of that product, creating associations between media files and particular product options. This allows different variants to showcase relevant images or videos.

For example, a t-shirt product might have color variants where each color variant displays only the images showing that specific color, helping customers see exactly what they're purchasing.

Use ProductVariantAppendMedia to:

  • Associate specific images with product variants for accurate display
  • Build variant-specific media management in product interfaces
  • Implement automated media assignment based on variant attributes

The operation links existing product media to variants without duplicating files, maintaining efficient media storage while enabling variant-specific displays.

Learn more about product variants.

Arguments

Anchor to productIdproductId
•ID!
required

Specifies the product associated to the media.

Anchor to variantMediavariantMedia
•[ProductVariantAppendMediaInput!]!
required

A list of pairs of variants and media to be attached to the variants.

Anchor to productVariantDetachMediaproductVariantDetachMedia
•mutation

Detaches media from product variants.

Arguments

Anchor to productIdproductId
•ID!
required

Specifies the product to which the variants and media are associated.

Anchor to variantMediavariantMedia
•[ProductVariantDetachMediaInput!]!
required

A list of pairs of variants and media to be deleted from the variants.

Deprecated mutations

Anchor to productCreateMediaproductCreateMedia
•mutation
Deprecated

Arguments

Anchor to productIdproductId
•ID!
required

Specifies the product associated with the media.

Anchor to mediamedia
•[CreateMediaInput!]!
required

List of new media to be added to a product.

Anchor to productDeleteMediaproductDeleteMedia
•mutation
Deprecated

Arguments

Anchor to productIdproductId
•ID!
required

Specifies the product ID from which the media will be deleted.

Anchor to mediaIdsmediaIds
•[ID!]!
required

The media IDs to be deleted.

Anchor to productUpdateMediaproductUpdateMedia
•mutation
Deprecated

Arguments

Anchor to productIdproductId
•ID!
required

Specifies the product on which media will be updated.

Anchor to mediamedia
•[UpdateMediaInput!]!
required

A list of media updates.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?