Etsy · Schema

TransactionVariations

A list of variations chosen by the buyer during checkout.

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name Type Description
property_id integer The variation property ID.
value_id integer The ID of the variation value selected.
formatted_name string Formatted name of the variation.
formatted_value string Value of the variation entered by the buyer.
question_id integer [Personalization only] The ID of the original personalization question.
View JSON Schema on GitHub

JSON Schema

open-api-v3-transaction-variations-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TransactionVariations",
  "description": "A list of variations chosen by the buyer during checkout.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-transaction-variations-schema.json",
  "type": "object",
  "properties": {
    "property_id": {
      "type": "integer",
      "description": "The variation property ID.",
      "example": 1
    },
    "value_id": {
      "type": "integer",
      "description": "The ID of the variation value selected.",
      "nullable": true,
      "example": 1
    },
    "formatted_name": {
      "type": "string",
      "description": "Formatted name of the variation.",
      "example": "Handmade Ceramic Mug"
    },
    "formatted_value": {
      "type": "string",
      "description": "Value of the variation entered by the buyer.",
      "example": "example string"
    },
    "question_id": {
      "type": "integer",
      "description": "[Personalization only] The ID of the original personalization question.",
      "nullable": true,
      "example": 1
    }
  }
}