WooCommerce · JSON Structure

Woocommerce Rest Api Product Image Structure

An image associated with a product.

Type: object Properties: 4
eCommerceOpen SourceOrdersProductsWordPress

ProductImage is a JSON Structure definition published by WooCommerce, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id src name alt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-rest-api-product-image-structure.json",
  "name": "ProductImage",
  "description": "An image associated with a product.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Image unique identifier.",
      "example": 1
    },
    "src": {
      "type": "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"
    }
  }
}