Open Api V3 Shop Receipt Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-structure/open-api-v3-shop-receipt-structure.json",
  "name": "ShopReceipt",
  "description": "The record of a purchase from a shop. Shop receipts display monetary values using the shop's currency.",
  "type": "object",
  "properties": {
    "receipt_id": {
      "type": "int64",
      "description": "The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.",
      "minimum": 1,
      "example": 234567890
    },
    "receipt_type": {
      "type": "int32",
      "description": "The numeric value for the Etsy channel that serviced the purchase: 0 or 5 for Etsy.com, 1 for a Pattern shop.",
      "minimum": 0,
      "example": 1
    },
    "seller_user_id": {
      "type": "int64",
      "description": "The numeric ID for the [user](/documentation/reference#tag/User) (seller) fulfilling the purchase.",
      "minimum": 1,
      "example": 456789
    },
    "seller_email": {
      "type": "string",
      "description": "The email address string for the seller of the listing.",
      "format": "email",
      "nullable": true,
      "example": "seller@example.com"
    },
    "buyer_user_id": {
      "type": "int64",
      "description": "The numeric ID for the [user](/documentation/reference#tag/User) making the purchase.",
      "minimum": 1,
      "example": 456789
    },
    "buyer_email": {
      "type": "string",
      "description": "The email address string for the buyer of the listing. It will be null if access hasn't been granted. Access is case-by-case and subject to approval.",
      "nullable": true,
      "example": "seller@example.com"
    },
    "name": {
      "type": "string",
      "description": "The name string for the recipient in the shipping address.",
      "example": "Handmade Ceramic Mug"
    },
    "first_line": {
      "type": "string",
      "description": "The first address line string for the recipient in the shipping address.",
      "nullable": true,
      "example": "123 Main St"
    },
    "second_line": {
      "type": "string",
      "description": "The optional second address line string for the recipient in the shipping address.",
      "nullable": true,
      "example": "Apt 4B"
    },
    "city": {
      "type": "string",
      "description": "The city string for the recipient in the shipping address.",
      "nullable": true,
      "example": "Brooklyn"
    },
    "state": {
      "type": "string",
      "description": "The state string for the recipient in the shipping address.",
      "nullable": true,
      "example": "example string"
    },
    "zip": {
      "type": "string",
      "description": "The zip code string (not necessarily a number) for the recipient in the shipping address.",
      "nullable": true,
      "example": "11201"
    },
    "status": {
      "type": "string",
      "description": "The current order status string. One of: `paid`, `completed`, `open`, `payment processing` or `canceled`.",
      "enum": [
        "paid",
        "completed",
        "open",
        "payment processing",
        "canceled",
        "fully refunded",
        "partially refunded"
      ],
      "example": "paid"
    },
    "formatted_address": {
      "type": "string",
      "description": "The formatted shipping address string for the recipient in the shipping address.",
      "nullable": true,
      "example": "example string"
    },
    "country_iso": {
      "type": "string",
      "description": "The ISO-3166 alpha-2 country code string for the recipient in the shipping address.",
      "nullable": true,
      "example": "US"
    },
    "payment_method": {
      "type": "string",
      "description": "The payment method string identifying purchaser's payment method, which must be one of: 'cc' (credit card), 'paypal', 'check', 'mo' (money order), 'bt' (bank transfer), 'other', 'ideal', 'sofort', 'apple_pay', 'google', 'android_pay', 'google_pay', 'klarna', 'k_pay_in_4' (klarna), 'k_pay_in_3' (klarna), or 'k_financing' (klarna).",
      "example": "example string"
    },
    "payment_email": {
      "type": "string",
      "description": "The email address string for the email address to which to send payment confirmation",
      "nullable": true,
      "example": "seller@example.com"
    },
    "message_from_seller": {
      "type": "string",
      "description": "An optional message string from the seller.",
      "nullable": true,
      "example": "Thanks for your order! Shipping out tomorrow."
    },
    "message_from_buyer": {
      "type": "string",
      "description": "An optional message string from the buyer.",
      "nullable": true,
      "example": "Thanks for your order! Shipping out tomorrow."
    },
    "message_from_payment": {
      "type": "string",
      "description": "The machine-generated acknowledgement string from the payment system.",
      "nullable": true,
      "example": "Thanks for your order! Shipping out tomorrow."
    },
    "is_paid": {
      "type": "boolean",
      "description": "When true, buyer paid for this purchase.",
      "example": true
    },
    "is_shipped": {
      "type": "boolean",
      "description": "When true, seller shipped the products.",
      "example": true
    },
    "create_timestamp": {
      "type": "int32",
      "description": "The receipt's creation time, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "created_timestamp": {
      "type": "int32",
      "description": "The receipt's creation time, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "update_timestamp": {
      "type": "int32",
      "description": "The time of the last update to the receipt, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "updated_timestamp": {
      "type": "int32",
      "description": "The time of the last update to the receipt, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "is_gift": {
      "type": "boolean",
      "description": "When true, the buyer indicated this purchase is a gift.",
      "example": true
    },
    "gift_message": {
      "type": "string",
      "description": "A gift message string the buyer requests delivered with the product.",
      "example": "Thanks for your order! Shipping out tomorrow."
    },
    "gift_sender": {
      "type": "string",
      "description": "The name of the person who sent the gift.",
      "example": "example string"
    },
    "grandtotal": {
      "description": "A number equal to the total_price minus the coupon discount plus tax and shipping costs.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "subtotal": {
      "description": "A number equal to the total_price minus coupon discounts. Does not include tax or shipping costs.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "total_price": {
      "description": "A number equal to the sum of the individual listings' (price * quantity). Does not include tax or shipping costs.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "total_shipping_cost": {
      "description": "A number equal to the total shipping cost of the receipt.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "total_tax_cost": {
      "description": "The total sales tax of the receipt.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "total_vat_cost": {
      "description": "A number equal to the total value-added tax (VAT) of the receipt.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "discount_amt": {
      "description": "The numeric total discounted price for the receipt when using a discount (percent or fixed) coupon. Free shipping coupons are not included in this discount amount.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "gift_wrap_price": {
      "description": "The numeric price of gift wrap for this receipt.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "example": "example"
    },
    "shipments": {
      "type": "array",
      "description": "A list of shipment statements for this receipt.",
      "items": {
        "description": "A list of shipment statements for this receipt.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/ShopReceiptShipment"
          }
        ]
      }
    },
    "transactions": {
      "type": "array",
      "description": "Array of transactions for the receipt.",
      "items": {
        "description": "Array of transactions for the receipt.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/ShopReceiptTransaction"
          }
        ]
      }
    },
    "refunds": {
      "type": "array",
      "description": "Refunds for a given receipt.",
      "items": {
        "description": "Refunds for a given receipt.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/ShopRefund"
          }
        ]
      }
    }
  }
}