Skip to main content

ProductImage

ProductImage is an entity that represents an image of the product. Product can have multiple images. Each image can have a type. Only image with 'TRY_ON' type can be used for try on generation. There is no strict limitation on the number of images with 'TRY_ON' type. Please consider that only the first image with 'TRY_ON' type will be used for try on generation.

type ProductImage {
  id: ID!
  url: String!
  externalId: String
  parsedBodyData: String
  type: [ProductImageType]
}

Fields​

ProductImage.id ● ID! non-null scalar​

Autogenerated unique uuid.

ProductImage.url ● String! non-null scalar​

Image url.

ProductImage.externalId ● String scalar​

Reference to a product image in your system.

ProductImage.parsedBodyData ● String scalar​

Parsed body data. It's a string that represents the body data of the image. It's used for try on generation.

ProductImage.type ● [ProductImageType] list enum​

Type of the image. Only image with 'TRY_ON' type can be used for try on generation.

Returned By​

createProductImage mutation

Member Of​

Product object