Etsy · Schema
ShopReceiptTransaction
A transaction object associated with a shop receipt. Etsy generates one transaction per listing purchased as recorded on the order receipt.
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2
Properties
| Name | Type | Description |
|---|---|---|
| transaction_id | integer | The unique numeric ID for a transaction. |
| title | string | The title string of the [listing](/documentation/reference#tag/ShopListing) purchased in this transaction. |
| description | string | The description string of the [listing](/documentation/reference#tag/ShopListing) purchased in this transaction. |
| seller_user_id | integer | The numeric user ID for the seller in this transaction. |
| buyer_user_id | integer | The numeric user ID for the buyer in this transaction. |
| create_timestamp | integer | The transaction's creation date and time, in epoch seconds. |
| created_timestamp | integer | The transaction's creation date and time, in epoch seconds. |
| paid_timestamp | integer | The transaction's paid date and time, in epoch seconds. |
| shipped_timestamp | integer | The transaction's shipping date and time, in epoch seconds. |
| quantity | integer | The numeric quantity of products purchased in this transaction. |
| listing_image_id | integer | The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction. |
| receipt_id | integer | The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction. |
| is_digital | boolean | When true, the transaction recorded the purchase of a digital listing. |
| file_data | string | A string describing the files purchased in this transaction. |
| listing_id | integer | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction. |
| transaction_type | string | The type string for the transaction, usually "listing". |
| 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 |
| price | object | A money object representing the price recorded the transaction. |
| shipping_cost | object | A money object representing the shipping cost for this transaction. |
| variations | array | Array of variations and personalizations the buyer chose. |
| product_data | array | A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed. |
| shipping_profile_id | integer | The ID of the shipping profile selected for this listing. |
| min_processing_days | integer | The minimum number of days for processing the listing. |
| max_processing_days | integer | The maximum number of days for processing the listing. |
| shipping_method | string | Name of the selected shipping method. |
| shipping_upgrade | string | The name of the shipping upgrade selected for this listing. Default value is null. |
| expected_ship_date | integer | The date & time of the expected ship date, in epoch seconds. |
| buyer_coupon | number | The amount of the buyer coupon that was discounted in the shop's currency. |
| shop_coupon | number | The amount of the shop coupon that was discounted in the shop's currency. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ShopReceiptTransaction",
"description": "A transaction object associated with a shop receipt. Etsy generates one transaction per listing purchased as recorded on the order receipt.",
"$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-shop-receipt-transaction-schema.json",
"type": "object",
"properties": {
"transaction_id": {
"type": "integer",
"description": "The unique numeric ID for a transaction.",
"format": "int64",
"minimum": 1,
"example": 345678901
},
"title": {
"type": "string",
"description": "The title string of the [listing](/documentation/reference#tag/ShopListing) purchased in this transaction.",
"nullable": true,
"example": "Handmade Ceramic Mug \u2014 Stoneware"
},
"description": {
"type": "string",
"description": "The description string of the [listing](/documentation/reference#tag/ShopListing) purchased in this transaction.",
"nullable": true,
"example": "Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio."
},
"seller_user_id": {
"type": "integer",
"description": "The numeric user ID for the seller in this transaction.",
"format": "int64",
"minimum": 1,
"example": 456789
},
"buyer_user_id": {
"type": "integer",
"description": "The numeric user ID for the buyer in this transaction.",
"format": "int64",
"minimum": 1,
"example": 456789
},
"create_timestamp": {
"type": "integer",
"description": "The transaction's creation date and time, in epoch seconds.",
"minimum": 946684800,
"example": 1758153645
},
"created_timestamp": {
"type": "integer",
"description": "The transaction's creation date and time, in epoch seconds.",
"minimum": 946684800,
"example": 1758153645
},
"paid_timestamp": {
"type": "integer",
"description": "The transaction's paid date and time, in epoch seconds.",
"nullable": true,
"minimum": 946684800,
"example": 1758153645
},
"shipped_timestamp": {
"type": "integer",
"description": "The transaction's shipping date and time, in epoch seconds.",
"nullable": true,
"minimum": 946684800,
"example": 1758153645
},
"quantity": {
"type": "integer",
"description": "The numeric quantity of products purchased in this transaction.",
"minimum": 0,
"example": 1
},
"listing_image_id": {
"type": "integer",
"description": "The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.",
"format": "int64",
"nullable": true,
"minimum": 1,
"example": 1
},
"receipt_id": {
"type": "integer",
"description": "The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.",
"format": "int64",
"minimum": 1,
"example": 234567890
},
"is_digital": {
"type": "boolean",
"description": "When true, the transaction recorded the purchase of a digital listing.",
"example": true
},
"file_data": {
"type": "string",
"description": "A string describing the files purchased in this transaction.",
"example": "example string"
},
"listing_id": {
"type": "integer",
"description": "The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.",
"nullable": true,
"minimum": 0,
"example": 123456789
},
"transaction_type": {
"type": "string",
"description": "The type string for the transaction, usually \"listing\".",
"example": "example string"
},
"product_id": {
"type": "integer",
"description": "The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.",
"format": "int64",
"nullable": true,
"minimum": 1,
"example": 567890123
},
"sku": {
"type": "string",
"description": "The SKU string for the product",
"nullable": true,
"example": "SKU-12345"
},
"price": {
"description": "A money object representing the price recorded the transaction.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"example": "example"
},
"shipping_cost": {
"description": "A money object representing the shipping cost for this transaction.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"example": "example"
},
"variations": {
"type": "array",
"description": "Array of variations and personalizations the buyer chose.",
"items": {
"description": "Array of variations and personalizations the buyer chose.",
"oneOf": [
{
"$ref": "#/components/schemas/TransactionVariations"
}
]
}
},
"product_data": {
"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"
}
]
}
},
"shipping_profile_id": {
"type": "integer",
"description": "The ID of the shipping profile selected for this listing.",
"format": "int64",
"nullable": true,
"minimum": 1,
"example": 1
},
"min_processing_days": {
"type": "integer",
"description": "The minimum number of days for processing the listing.",
"nullable": true,
"minimum": 0,
"example": 1
},
"max_processing_days": {
"type": "integer",
"description": "The maximum number of days for processing the listing.",
"nullable": true,
"minimum": 0,
"example": 1
},
"shipping_method": {
"type": "string",
"description": "Name of the selected shipping method.",
"nullable": true,
"example": "example string"
},
"shipping_upgrade": {
"type": "string",
"description": "The name of the shipping upgrade selected for this listing. Default value is null.",
"nullable": true,
"example": "example string"
},
"expected_ship_date": {
"type": "integer",
"description": "The date & time of the expected ship date, in epoch seconds.",
"nullable": true,
"minimum": 946684800,
"example": 1
},
"buyer_coupon": {
"type": "number",
"description": "The amount of the buyer coupon that was discounted in the shop's currency.",
"format": "float",
"default": 0,
"example": 1.0
},
"shop_coupon": {
"type": "number",
"description": "The amount of the shop coupon that was discounted in the shop's currency.",
"format": "float",
"default": 0,
"example": 1.0
}
}
}