WooCommerce · Schema

ProductImage

An image associated with a product.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name Type Description
id integer Image unique identifier.
src string Image URL.
name string Image name.
alt string Image alternative text.
View JSON Schema on GitHub

JSON Schema

woocommerce-rest-api-product-image-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-product-image-schema.json",
  "title": "ProductImage",
  "description": "An image associated with a product.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Image unique identifier.",
      "example": 1
    },
    "src": {
      "type": "string",
      "format": "uri",
      "description": "Image URL.",
      "example": "https://example.com/path"
    },
    "name": {
      "type": "string",
      "description": "Image name.",
      "example": "Example Name"
    },
    "alt": {
      "type": "string",
      "description": "Image alternative text.",
      "example": "string-value"
    }
  }
}