WooCommerce · Schema

StoreProductImage

Product image with thumbnail variants.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name	Type	Description
id	integer	Image attachment ID.
src	string	Full-size image URL.
thumbnail	string	Thumbnail image URL.
srcset	string	Responsive image srcset attribute value.
sizes	string	Responsive image sizes attribute value.
name	string	Image file name.
alt	string	Image alternative text.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-store-api-store-product-image-schema.json",
  "title": "StoreProductImage",
  "description": "Product image with thumbnail variants.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Image attachment ID.",
      "example": 1
    },
    "src": {
      "type": "string",
      "format": "uri",
      "description": "Full-size image URL.",
      "example": "https://example.com/path"
    },
    "thumbnail": {
      "type": "string",
      "format": "uri",
      "description": "Thumbnail image URL.",
      "example": "https://example.com/path"
    },
    "srcset": {
      "type": "string",
      "description": "Responsive image srcset attribute value.",
      "example": "string-value"
    },
    "sizes": {
      "type": "string",
      "description": "Responsive image sizes attribute value.",
      "example": "string-value"
    },
    "name": {
      "type": "string",
      "description": "Image file name.",
      "example": "Example Name"
    },
    "alt": {
      "type": "string",
      "description": "Image alternative text.",
      "example": "string-value"
    }
  }
}