Etsy · Schema

TransactionReview

A transaction review record left by a User.

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name	Type	Description
shop_id	integer	The shop's numeric ID.
listing_id	integer	The ID of the ShopListing that the TransactionReview belongs to.
transaction_id	integer	The ID of the ShopReceipt Transaction that the TransactionReview belongs to.
buyer_user_id	integer	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.
rating	integer	Rating value on scale from 1 to 5
review	string	A message left by the author, explaining the feedback, if provided.
language	string	The language of the TransactionReview
image_url_fullxfull	string	The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings.
create_timestamp	integer	The date and time the TransactionReview was created in epoch seconds.
created_timestamp	integer	The date and time the TransactionReview was created in epoch seconds.
update_timestamp	integer	The date and time the TransactionReview was updated in epoch seconds.
updated_timestamp	integer	The date and time the TransactionReview was updated in epoch seconds.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TransactionReview",
  "description": "A transaction review record left by a User.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-transaction-review-schema.json",
  "type": "object",
  "properties": {
    "shop_id": {
      "type": "integer",
      "description": "The shop's numeric ID.",
      "format": "int64",
      "minimum": 1,
      "example": 123456
    },
    "listing_id": {
      "type": "integer",
      "description": "The ID of the ShopListing that the TransactionReview belongs to.",
      "format": "int64",
      "minimum": 1,
      "example": 123456789
    },
    "transaction_id": {
      "type": "integer",
      "description": "The ID of the ShopReceipt Transaction that the TransactionReview belongs to.",
      "format": "int64",
      "minimum": 1,
      "example": 345678901
    },
    "buyer_user_id": {
      "type": "integer",
      "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.",
      "format": "int64",
      "nullable": true,
      "minimum": 1,
      "example": 456789
    },
    "rating": {
      "type": "integer",
      "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": "integer",
      "description": "The date and time the TransactionReview was created in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "created_timestamp": {
      "type": "integer",
      "description": "The date and time the TransactionReview was created in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "update_timestamp": {
      "type": "integer",
      "description": "The date and time the TransactionReview was updated in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "updated_timestamp": {
      "type": "integer",
      "description": "The date and time the TransactionReview was updated in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    }
  }
}