Etsy · JSON Structure

Open Api V3 Listing Video Structure

Reference urls and metadata for a video associated with a specific listing.

Type: object Properties: 6
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

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

Properties

video_id height width thumbnail_url video_url video_state

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/etsy/refs/heads/main/json-structure/open-api-v3-listing-video-structure.json",
  "name": "ListingVideo",
  "description": "Reference urls and metadata for a video associated with a specific listing.",
  "type": "object",
  "properties": {
    "video_id": {
      "type": "int64",
      "description": "The unique ID of a video associated with a listing.",
      "minimum": 1,
      "example": 1
    },
    "height": {
      "type": "int32",
      "description": "The video height dimension in pixels.",
      "example": 1
    },
    "width": {
      "type": "int32",
      "description": "The video width dimension in pixels.",
      "example": 1
    },
    "thumbnail_url": {
      "type": "string",
      "description": "The url of the video thumbnail.",
      "example": "https://www.etsy.com/listing/123456789"
    },
    "video_url": {
      "type": "string",
      "description": "The url of the video file.",
      "example": "https://www.etsy.com/listing/123456789"
    },
    "video_state": {
      "type": "string",
      "description": "The current state of a given video. Value is one of `active`, `inactive`, `deleted` or `flagged`.",
      "enum": [
        "active",
        "inactive",
        "deleted",
        "flagged"
      ],
      "default": "active",
      "example": "active"
    }
  }
}