--- title: Image - GraphQL Admin description: Represents an image resource. api_version: 2024-10 api_name: admin type: object api_type: graphql source_url: html: 'https://shopify.dev/docs/api/admin-graphql/2024-10/objects/Image' md: 'https://shopify.dev/docs/api/admin-graphql/2024-10/objects/Image.txt' --- # Image object Represents an image resource. ## Fields * alt​Text [String](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/String) A word or phrase to share the nature or contents of an image. * height [Int](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/Int) The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. * id [ID](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID) A unique ID for the image. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/2024-10/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * url [URL!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/URL) non-null The location of the image as a URL. If no transform options are specified, then the original image will be preserved including any pre-applied transforms. All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). * transform [Image​Transform​Input](https://shopify.dev/docs/api/admin-graphql/2024-10/input-objects/ImageTransformInput) ### Arguments A set of options to transform the original image. *** * width [Int](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/Int) The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. ### Deprecated fields * original​Src [URL!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/URL) non-nullDeprecated * private​Metafield [Private​Metafield](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/PrivateMetafield) Deprecated * private​Metafields [Private​Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/2024-10/connections/PrivateMetafieldConnection) non-nullDeprecated * src [URL!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/URL) non-nullDeprecated * transformed​Src [URL!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/URL) non-nullDeprecated * max​Width [Int](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/Int) ### Arguments Image width in pixels between 1 and 5760. * max​Height [Int](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/Int) Image height in pixels between 1 and 5760. * crop [Crop​Region](https://shopify.dev/docs/api/admin-graphql/2024-10/enums/CropRegion) Crops the image according to the specified region. * scale [Int](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/Int) Default:1 Image size multiplier for high-resolution retina displays. Must be between 1 and 3. * preferred​Content​Type [Image​Content​Type](https://shopify.dev/docs/api/admin-graphql/2024-10/enums/ImageContentType) Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported). *** *** ## Map ### Fields and connections with this object * {}[AbandonedCheckoutLineItem.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/AbandonedCheckoutLineItem#field-image) * {}[App.banner](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/App#field-banner) * {}[App.icon](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/App#field-icon) * {}[App.screenshots](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/App#field-screenshots) * {}[Article.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/Article#field-image) * {}[CalculatedDraftOrderLineItem.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CalculatedDraftOrderLineItem#field-image) * {}[CalculatedLineItem.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CalculatedLineItem#field-image) * {}[CheckoutBrandingHeaderCartLink.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CheckoutBrandingHeaderCartLink#field-image) * {}[CheckoutBrandingImage.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CheckoutBrandingImage#field-image) * {}[CheckoutBrandingLogo.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CheckoutBrandingLogo#field-image) * {}[Collection.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/Collection#field-image) * {}[CommentEventAttachment.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CommentEventAttachment#field-image) * {}[Customer.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/Customer#field-image) * {}[DeliveryCarrierService.icon](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/DeliveryCarrierService#field-icon) * {}[DiscountShareableUrl.targetItemImage](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/DiscountShareableUrl#field-targetItemImage) * {}[DraftOrderLineItem.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/DraftOrderLineItem#field-image) * {}[FulfillmentOrderLineItem.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/FulfillmentOrderLineItem#field-image) * <->[ImageConnection.nodes](https://shopify.dev/docs/api/admin-graphql/2024-10/connections/ImageConnection#field-nodes) * {}[ImageEdge.node](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/ImageEdge#field-node) * {}[LineItem.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/LineItem#field-image) * {}[MediaImage.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/MediaImage#field-image) * {}[MediaPreviewImage.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/MediaPreviewImage#field-image) * {}[OrderApp.icon](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/OrderApp#field-icon) * {}[OrderTransaction.paymentIcon](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/OrderTransaction#field-paymentIcon) * {}[PriceRuleShareableUrl.targetItemImage](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/PriceRuleShareableUrl#field-targetItemImage) * {}[ProductVariant.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/ProductVariant#field-image) * {}[SearchResult.image](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/SearchResult#field-image) * {}[StaffMember.avatar](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/StaffMember#field-avatar) * {}[SubscriptionLine.variantImage](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/SubscriptionLine#field-variantImage) *** ## Interfaces * [Has​Metafields](https://shopify.dev/docs/api/admin-graphql/2024-10/interfaces/HasMetafields) interface *** ## ||-Image Implements ### Implements * ||-[Has​Metafields](https://shopify.dev/docs/api/admin-graphql/2024-10/interfaces/HasMetafields)