Skip to content

Latest commit

 

History

History
47 lines (44 loc) · 5.82 KB

ShopReceipt.md

File metadata and controls

47 lines (44 loc) · 5.82 KB

ShopReceipt

Properties

Name Type Description Notes
receipt_id int The numeric ID for the receipt associated to this transaction. [optional]
receipt_type int The numeric value for the Etsy channel that serviced the purchase: 0 for Etsy.com, 1 for a Pattern shop. [optional]
seller_user_id int The numeric ID for the user (seller) fulfilling the purchase. [optional]
seller_email string The email address string for the seller of the listing. [optional]
buyer_user_id int The numeric ID for the user making the purchase. [optional]
buyer_email string The email address string for the buyer of the listing. [optional]
name string The name string for the recipient in the shipping address. [optional]
first_line string The first address line string for the recipient in the shipping address. [optional]
second_line string The optional second address line string for the recipient in the shipping address. [optional]
city string The city string for the recipient in the shipping address. [optional]
state string The state string for the recipient in the shipping address. [optional]
zip string The zip code string (not necessarily a number) for the recipient in the shipping address. [optional]
status string The current order status string. One of: `paid`, `completed`, `open`, `payment processing` or `canceled`. [optional]
formatted_address string The formatted shipping address string for the recipient in the shipping address. [optional]
country_iso string The ISO-3166 alpha-2 country code string for the recipient in the shipping address. [optional]
payment_method string 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). [optional]
payment_email string The email address string for the email address to which to send payment confirmation [optional]
message_from_seller string An optional message string from the seller. [optional]
message_from_buyer string An optional message string from the buyer. [optional]
message_from_payment string The machine-generated acknowledgement string from the payment system. [optional]
is_paid bool When true, buyer paid for this purchase. [optional]
is_shipped bool When true, seller shipped the products. [optional]
create_timestamp int The receipt\'s creation time, in epoch seconds. [optional]
created_timestamp int The receipt\'s creation time, in epoch seconds. [optional]
update_timestamp int The time of the last update to the receipt, in epoch seconds. [optional]
updated_timestamp int The time of the last update to the receipt, in epoch seconds. [optional]
is_gift bool When true, the buyer indicated this purchase is a gift. [optional]
gift_message string A gift message string the buyer requests delivered with the product. [optional]
grandtotal AllOfShopReceiptGrandtotal A number equal to the total_price minus the coupon discount plus tax and shipping costs. [optional]
subtotal AllOfShopReceiptSubtotal A number equal to the total_price minus coupon discounts. Does not included tax or shipping costs. [optional]
total_price AllOfShopReceiptTotalPrice A number equal to the sum of the individual listings\' (price * quantity). Does not included tax or shipping costs. [optional]
total_shipping_cost AllOfShopReceiptTotalShippingCost A number equal to the total shipping cost of the receipt. [optional]
total_tax_cost AllOfShopReceiptTotalTaxCost The total sales tax of the receipt. [optional]
total_vat_cost AllOfShopReceiptTotalVatCost A number equal to the total value-added tax (VAT) of the receipt. [optional]
discount_amt AllOfShopReceiptDiscountAmt 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. [optional]
gift_wrap_price AllOfShopReceiptGiftWrapPrice The numeric price of gift wrap for this receipt. [optional]
shipments \Swagger\Client\Model\AllOfShopReceiptShipmentsItems[] A list of shipment statements for this receipt. [optional]
transactions \Swagger\Client\Model\AllOfShopReceiptTransactionsItems[] Array of transactions for the receipt. [optional]
refunds \Swagger\Client\Model\AllOfShopReceiptRefundsItems[] Refunds for a given receipt. [optional]

[Back to Model list] [Back to API list] [Back to README]