Etsy · Schema

ListingInventoryProduct

A representation of a product for a listing.

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name Type Description
product_id integer The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
sku string The SKU string for the product
is_deleted boolean When true, someone deleted this product.
offerings array A list of product offering entries for this product.
property_values array A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.
View JSON Schema on GitHub

JSON Schema

open-api-v3-listing-inventory-product-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ListingInventoryProduct",
  "description": "A representation of a product for a listing.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-listing-inventory-product-schema.json",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "description": "The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.",
      "format": "int64",
      "minimum": 1,
      "example": 567890123
    },
    "sku": {
      "type": "string",
      "description": "The SKU string for the product",
      "example": "SKU-12345"
    },
    "is_deleted": {
      "type": "boolean",
      "description": "When true, someone deleted this product.",
      "example": true
    },
    "offerings": {
      "type": "array",
      "description": "A list of product offering entries for this product.",
      "items": {
        "description": "A list of product offering entries for this product.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/ListingInventoryProductOffering"
          }
        ]
      }
    },
    "property_values": {
      "type": "array",
      "description": "A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.",
      "items": {
        "description": "A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/ListingPropertyValue"
          }
        ]
      }
    }
  }
}