Skip to main content

Media

A media asset in the library. Currently supports images only.

type Media {
  altText: String
  boards: [MediaBoard!]!
  comments: [MediaComment!]!
  companyId: ID
  createdAt: ISO8601DateTime!
  description: String
  fileSize: Int
  filename: String
  height: Int
  id: ID!
  mediaAttributes: [MediaAttribute!]!
  mimeType: String
  openCommentCount: Int!
  originalMedia: Media
  position: Int
  products: [Product!]
  src: Url!
  tags: [String!]!
  updatedAt: ISO8601DateTime!
  uploadedBy: Party
  variantType: MediaVariantTypeEnum!
  variants(
    type: MediaVariantTypeEnum
  ): [Media!]
  width: Int
}

Fields​

Media.altText ● String scalar common​

Media.boards ● [MediaBoard!]! non-null object products​

The boards this image sits on.

Media.comments ● [MediaComment!]! non-null object products​

Comment threads, oldest first, each with its replies. Archived comments are left out.

Media.companyId ● ID scalar common​

Media.createdAt ● ISO8601DateTime! non-null scalar common​

Media.description ● String scalar common​

Free-form notes about the image.

Media.fileSize ● Int scalar common​

Size in bytes, known for images uploaded through Endless.

Media.filename ● String scalar common​

The image file name, from the stored upload key, or from the source URL when no key is present.

Media.height ● Int scalar common​

Media.id ● ID! non-null scalar common​

Media.mediaAttributes ● [MediaAttribute!]! non-null object products​

Custom field values, from the company's image attribute definitions. Values of archived definitions are left out.

Media.mimeType ● String scalar common​

Content type, known for images uploaded through Endless.

Media.openCommentCount ● Int! non-null scalar common​

Threads not yet resolved.

Media.originalMedia ● Media object products​

Media.position ● Int scalar common​

The image's order within the product it was requested through. Null when the image is read from the library, where it may belong to any number of products.

Media.products ● [Product!] list object products​

Media.src ● Url! non-null scalar common​

Media.tags ● [String!]! non-null scalar common​

Free tags, in the order they were added.

Media.updatedAt ● ISO8601DateTime! non-null scalar common​

Media.uploadedBy ● Party object common​

Who uploaded the file, when known.

Media.variantType ● MediaVariantTypeEnum! non-null enum products​

Media.variants ● [Media!] list object products​

Media.variants.type ● MediaVariantTypeEnum enum products​

Media.width ● Int scalar common​

Returned By​

mediaArchive mutation ● mediaUpdate mutation ● mediaUploadBulk mutation ● productMediaUpload mutation

Member Of​

ASNAvailableItem object ● DemandProduct object ● InventoryProduct object ● Media object ● MediaBoard object ● MediaComment object ● MediaConnection object ● MediaEdge object ● MediaSlotPlacement object ● Product object ● ProductMediaCandidates object ● ShipmentProduct object ● SupplyShipmentItem object