API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

productUpdateMedia mutation

Version unstable

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2021-07 (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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2021-04 (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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2021-01

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2020-10

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2020-07

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2020-04 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2020-01 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2019-10 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2019-07 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead

Version 2019-04 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use mediaUserErrors instead