Etsy · JSON Structure

Open Api V3 Transaction Review Structure

A transaction review record left by a User.

Type: object Properties: 12
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

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

Properties

shop_id listing_id transaction_id buyer_user_id rating review language image_url_fullxfull create_timestamp created_timestamp update_timestamp updated_timestamp

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-transaction-review-structure.json",
  "name": "TransactionReview",
  "description": "A transaction review record left by a User.",
  "type": "object",
  "properties": {
    "shop_id": {
      "type": "int64",
      "description": "The shop's numeric ID.",
      "minimum": 1,
      "example": 123456
    },
    "listing_id": {
      "type": "int64",
      "description": "The ID of the ShopListing that the TransactionReview belongs to.",
      "minimum": 1,
      "example": 123456789
    },
    "transaction_id": {
      "type": "int64",
      "description": "The ID of the ShopReceipt Transaction that the TransactionReview belongs to.",
      "minimum": 1,
      "example": 345678901
    },
    "buyer_user_id": {
      "type": "int64",
      "description": "The numeric ID of the user who was the buyer in this transaction. Note: This field may be absent, depending on the buyer's privacy settings.",
      "nullable": true,
      "minimum": 1,
      "example": 456789
    },
    "rating": {
      "type": "int32",
      "description": "Rating value on scale from 1 to 5",
      "minimum": 1,
      "maximum": 5,
      "example": 5
    },
    "review": {
      "type": "string",
      "description": "A message left by the author, explaining the feedback, if provided.",
      "default": "",
      "example": "example string"
    },
    "language": {
      "type": "string",
      "description": "The language of the TransactionReview",
      "example": "en-US"
    },
    "image_url_fullxfull": {
      "type": "string",
      "description": "The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings.",
      "nullable": true,
      "example": "https://www.etsy.com/listing/123456789"
    },
    "create_timestamp": {
      "type": "int32",
      "description": "The date and time the TransactionReview was created in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "created_timestamp": {
      "type": "int32",
      "description": "The date and time the TransactionReview was created in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "update_timestamp": {
      "type": "int32",
      "description": "The date and time the TransactionReview was updated in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "updated_timestamp": {
      "type": "int32",
      "description": "The date and time the TransactionReview was updated in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    }
  }
}