productCreateMedia mutation

Version 2020-04 (Release candidate)

Creates 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 ( [CreateMediaInput!]! ) required

List of new media to be added to a product.

productId ( ID! ) required

Specifies the product associated to the media.

CreateMediaInput fields

alt (String)

The alt text associated to the media.

mediaContentType (MediaContentType!) Required

The media content type.

originalSource (String!) Required

The original source of the media object. May be an external URL or signed upload URL.

Return fields

media ([Media!])

The newly created media.

mediaUserErrors ([MediaUserError!]!)

List of errors that occurred executing the mutation.

product (Product)

The product associated with the media.

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)

Creates 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 ( [CreateMediaInput!]! ) required

List of new media to be added to a product.

productId ( ID! ) required

Specifies the product associated to the media.

CreateMediaInput fields

alt (String)

The alt text associated to the media.

mediaContentType (MediaContentType!) Required

The media content type.

originalSource (String!) Required

The original source of the media object. May be an external URL or signed upload URL.

Return fields

media ([Media!])

The newly created media.

mediaUserErrors ([MediaUserError!]!)

List of errors that occurred executing the mutation.

product (Product)

The product associated with the media.

Deprecated return fields

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

List of errors that occurred executing the mutation.

Deprecation warning

Use mediaUserErrors instead

Sign up for a Partner account to get started.

Sign up