productUpdateMedia mutation

Version 2020-04 (Release candidate)

Updates media for a product.

Required access

write_products access scope

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.


Arguments

media ( [UpdateMediaInput!]! ) required

A list of media updates.

productId ( ID! ) required

Specifies the product to update media on.

UpdateMediaInput fields

alt (String)

The alt text associated to the media.

id (ID!) Required

Specifies the media to update.

previewImageSource (String)

The source from which to update the media preview image. May be an external URL or signed upload URL.

Return fields

media ([Media!])

The updated media.

mediaUserErrors ([MediaUserError!]!)

List of errors that occurred executing the mutation.

product (Product)

The product which media was updated on.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use mediaUserErrors instead

Version 2020-01 (Latest)

Updates media for a product.

Required access

write_products access scope

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.


Arguments

media ( [UpdateMediaInput!]! ) required

A list of media updates.

productId ( ID! ) required

Specifies the product to update media on.

UpdateMediaInput fields

alt (String)

The alt text associated to the media.

id (ID!) Required

Specifies the media to update.

previewImageSource (String)

The source from which to update the media preview image. May be an external URL or signed upload URL.

Return fields

media ([Media!])

The updated media.

mediaUserErrors ([MediaUserError!]!)

List of errors that occurred executing the mutation.

product (Product)

The product which media was updated on.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use mediaUserErrors instead