EtsyClient

Attributes

Channel module-attribute

Channel = Literal['etsy.com', 'wholesale', 'pattern', 'sell_on_facebook']

DestinationRegion1 module-attribute

DestinationRegion1 = Literal['eu', 'non_eu', 'none']

DestinationRegion module-attribute

DestinationRegion = Literal['eu', 'non_eu', 'none']

Include module-attribute

Include = Literal['Images', 'Shop', 'User']

Includes module-attribute

Includes = Literal['Listing']

Includes1 module-attribute

Includes1 = Literal['Images', 'Shop', 'User']

ItemDimensionsUnit2 module-attribute

ItemDimensionsUnit2 = Literal['in', 'ft', 'mm', 'cm', 'm', 'yd', 'inches']

ItemWeightUnit2 module-attribute

ItemWeightUnit2 = Literal['oz', 'lb', 'g', 'kg']

ItemDimensionsUnit module-attribute

ItemDimensionsUnit = Literal['in', 'ft', 'mm', 'cm', 'm', 'yd', 'inches']

ItemWeightUnit module-attribute

ItemWeightUnit = Literal['oz', 'lb', 'g', 'kg']

Occasion module-attribute

Occasion = Literal['anniversary', 'baptism', 'bar_or_bat_mitzvah', 'birthday', 'canada_day', 'chinese_new_year', 'cinco_de_mayo', 'confirmation', 'christmas', 'day_of_the_dead', 'easter', 'eid', 'engagement', 'fathers_day', 'get_well', 'graduation', 'halloween', 'hanukkah', 'housewarming', 'kwanzaa', 'prom', 'july_4th', 'mothers_day', 'new_baby', 'new_years', 'quinceanera', 'retirement', 'st_patricks_day', 'sweet_16', 'sympathy', 'thanksgiving', 'valentines', 'wedding']

ProcessingTimeUnit module-attribute

ProcessingTimeUnit = Literal['business_days', 'weeks']

ProfileType module-attribute

ProfileType = Literal['manual', 'calculated']

Recipient module-attribute

Recipient = Literal['men', 'women', 'unisex_adults', 'teen_boys', 'teen_girls', 'teens', 'boys', 'girls', 'children', 'baby_boys', 'baby_girls', 'babies', 'birds', 'cats', 'dogs', 'pets', 'not_specified']

SortOn module-attribute

SortOn = Literal['created', 'price', 'updated']

SortOrder module-attribute

SortOrder = Literal['asc', 'ascending', 'desc', 'descending', 'up', 'down']

State module-attribute

State = Literal[0, 1, 2, 3, 4, 5]

State2 module-attribute

State2 = Literal['active', 'inactive']

Type module-attribute

Type = Literal[0, 1]

Type1 module-attribute

Type1 = Literal['physical', 'download', 'both']

WhenMade2 module-attribute

WhenMade2 = Literal['made_to_order', '2020_2021', '2010_2019', '2002_2009', 'before_2002', '2000_2001', '1990s', '1980s', '1970s', '1960s', '1950s', '1940s', '1930s', '1920s', '1910s', '1900s', '1800s', '1700s', 'before_1700']

WhenMade module-attribute

WhenMade = Literal['made_to_order', '2020_2021', '2010_2019', '2002_2009', 'before_2002', '2000_2001', '1990s', '1980s', '1970s', '1960s', '1950s', '1940s', '1930s', '1920s', '1910s', '1900s', '1800s', '1700s', 'before_1700']

WhoMade2 module-attribute

WhoMade2 = Literal['i_did', 'someone_else', 'collective']

WhoMade module-attribute

WhoMade = Literal['i_did', 'someone_else', 'collective']

Classes

Pong dataclass

Pong(application_id: Optional[int] = None)

Response for Ping

Attributes

application_id class-attribute instance-attribute

application_id: Optional[int] = None

The authenticated application's ID

PaymentAccountLedgerEntries dataclass

PaymentAccountLedgerEntries(count: Optional[int] = None, results: Optional[List[PaymentAccountLedgerEntry]] = None)

Response for Get a shop payment account ledger's entries

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of payment account ledger entry resources found.

results class-attribute instance-attribute

results: Optional[List[PaymentAccountLedgerEntry]] = None

The payment account ledger entry resources found.

Payments dataclass

Payments(count: Optional[int] = None, results: Optional[List[Payment]] = None)

Response for Get a payment from a payment account ledger entry ID

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of payments in the response.

results class-attribute instance-attribute

results: Optional[List[Payment]] = None

A list of payments.

ShopReceipt dataclass

ShopReceipt(receipt_id: Optional[int] = None, receipt_type: Optional[int] = None, seller_user_id: Optional[int] = None, seller_email: Optional[str] = None, buyer_user_id: Optional[int] = None, buyer_email: Optional[str] = None, name: Optional[str] = None, first_line: Optional[str] = None, second_line: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, zip: Optional[str] = None, formatted_address: Optional[str] = None, country_iso: Optional[str] = None, payment_method: Optional[str] = None, payment_email: Optional[str] = None, message_from_seller: Optional[str] = None, message_from_buyer: Optional[str] = None, message_from_payment: Optional[str] = None, is_paid: Optional[bool] = None, is_shipped: Optional[bool] = None, create_timestamp: Optional[int] = None, update_timestamp: Optional[int] = None, gift_message: Optional[str] = None, grandtotal: Optional[Money] = None, subtotal: Optional[Money] = None, total_price: Optional[Money] = None, total_shipping_cost: Optional[Money] = None, total_tax_cost: Optional[Money] = None, total_vat_cost: Optional[Money] = None, discount_amt: Optional[Money] = None, gift_wrap_price: Optional[Money] = None, shipments: Optional[List[ShopReceiptShipment]] = None)

Response for Get a receipt

Attributes

receipt_id class-attribute instance-attribute

receipt_id: Optional[int] = None

The numeric ID for the receipt associated to this transaction.

receipt_type class-attribute instance-attribute

receipt_type: Optional[int] = None

The numeric value for the Etsy channel that serviced the purchase: 0 for Etsy.com, 1 for a Pattern shop.

seller_user_id class-attribute instance-attribute

seller_user_id: Optional[int] = None

The numeric ID for the user (seller) fulfilling the purchase.

seller_email class-attribute instance-attribute

seller_email: Optional[str] = None

The email address string for the seller of the listing.

buyer_user_id class-attribute instance-attribute

buyer_user_id: Optional[int] = None

The numeric ID for the user making the purchase.

buyer_email class-attribute instance-attribute

buyer_email: Optional[str] = None

The email address string for the buyer of the listing.

name class-attribute instance-attribute

name: Optional[str] = None

The name string for the recipient in the shipping address.

first_line class-attribute instance-attribute

first_line: Optional[str] = None

The first address line string for the recipient in the shipping address.

second_line class-attribute instance-attribute

second_line: Optional[str] = None

The optional second address line string for the recipient in the shipping address.

city class-attribute instance-attribute

city: Optional[str] = None

The city string for the recipient in the shipping address.

state class-attribute instance-attribute

state: Optional[str] = None

The state string for the recipient in the shipping address.

zip class-attribute instance-attribute

zip: Optional[str] = None

The zip code string (not necessarily a number) for the recipient in the shipping address.

formatted_address class-attribute instance-attribute

formatted_address: Optional[str] = None

The formatted shipping address string for the recipient in the shipping address.

country_iso class-attribute instance-attribute

country_iso: Optional[str] = None

The ISO-3166 alpha-2 country code string for the recipient in the shipping address.

payment_method class-attribute instance-attribute

payment_method: Optional[str] = None

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), or 'k_financing' (klarna).

payment_email class-attribute instance-attribute

payment_email: Optional[str] = None

The email address string for the email address to which to send payment confirmation

message_from_seller class-attribute instance-attribute

message_from_seller: Optional[str] = None

An optional message string from the seller.

message_from_buyer class-attribute instance-attribute

message_from_buyer: Optional[str] = None

An optional message string from the buyer.

message_from_payment class-attribute instance-attribute

message_from_payment: Optional[str] = None

The machine-generated acknowledgement string from the payment system.

is_paid class-attribute instance-attribute

is_paid: Optional[bool] = None

When true, buyer paid for this purchase.

is_shipped class-attribute instance-attribute

is_shipped: Optional[bool] = None

When true, seller shipped the products.

create_timestamp class-attribute instance-attribute

create_timestamp: Optional[int] = None

The receipt's creation time, in epoch seconds.

update_timestamp class-attribute instance-attribute

update_timestamp: Optional[int] = None

The time of the last update to the receipt, in epoch seconds.

gift_message class-attribute instance-attribute

gift_message: Optional[str] = None

A gift message string the buyer requests delivered with the product.

shipments class-attribute instance-attribute

shipments: Optional[List[ShopReceiptShipment]] = None

A list of shipment statements for this receipt.

ShopReceipts dataclass

ShopReceipts(count: Optional[int] = None, results: Optional[List[ShopReceipt]] = None)

Response for Get receipts

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of Shop Receipts found.

results class-attribute instance-attribute

results: Optional[List[ShopReceipt]] = None

List of Shop Receipt resources found, with all Shop Receipt fields for each resource.

ReceiptCreateShipmentInput dataclass

ReceiptCreateShipmentInput(tracking_code: Optional[str] = None, carrier_name: Optional[str] = None, send_bcc: Optional[bool] = None)

Create a Shipment Receipt

Attributes

tracking_code class-attribute instance-attribute

tracking_code: Optional[str] = None

The tracking code for this receipt.

carrier_name class-attribute instance-attribute

carrier_name: Optional[str] = None

The carrier name for this receipt.

send_bcc class-attribute instance-attribute

send_bcc: Optional[bool] = None

If true, the shipping notification will be sent to the seller as well

ShopReceiptTransactions dataclass

ShopReceiptTransactions(count: Optional[int] = None, results: Optional[List[ShopReceiptTransaction]] = None)

Response for Retrieve a listing's transactions

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of shop receipt transaction resources found.

results class-attribute instance-attribute

results: Optional[List[ShopReceiptTransaction]] = None

The shop receipt transaction resources found.

ShopReceiptTransaction dataclass

ShopReceiptTransaction(transaction_id: Optional[int] = None, title: Optional[str] = None, description: Optional[str] = None, seller_user_id: Optional[int] = None, buyer_user_id: Optional[int] = None, create_timestamp: Optional[int] = None, paid_timestamp: Optional[int] = None, shipped_timestamp: Optional[int] = None, quantity: Optional[int] = None, listing_image_id: Optional[int] = None, receipt_id: Optional[int] = None, is_digital: Optional[bool] = None, file_data: Optional[str] = None, listing_id: Optional[int] = None, transaction_type: Optional[str] = None, product_id: Optional[int] = None, price: Optional[Money] = None, shipping_cost: Optional[Money] = None)

Response for Get a transaction

Attributes

transaction_id class-attribute instance-attribute

transaction_id: Optional[int] = None

The unique numeric ID for a transaction.

title class-attribute instance-attribute

title: Optional[str] = None

The title string of the listing purchased in this transaction.

description class-attribute instance-attribute

description: Optional[str] = None

The description string of the listing purchased in this transaction.

seller_user_id class-attribute instance-attribute

seller_user_id: Optional[int] = None

The numeric user ID for the seller in this transaction.

buyer_user_id class-attribute instance-attribute

buyer_user_id: Optional[int] = None

The numeric user ID for the buyer in this transaction.

create_timestamp class-attribute instance-attribute

create_timestamp: Optional[int] = None

The transaction's creation date and time, in epoch seconds.

paid_timestamp class-attribute instance-attribute

paid_timestamp: Optional[int] = None

The transaction's paid date and time, in epoch seconds.

shipped_timestamp class-attribute instance-attribute

shipped_timestamp: Optional[int] = None

The transaction's shipping date and time, in epoch seconds.

quantity class-attribute instance-attribute

quantity: Optional[int] = None

The numeric quantity of products purchased in this transaction.

listing_image_id class-attribute instance-attribute

listing_image_id: Optional[int] = None

The numeric ID of the primary listing image for this transaction.

receipt_id class-attribute instance-attribute

receipt_id: Optional[int] = None

The numeric ID for the receipt associated to this transaction.

is_digital class-attribute instance-attribute

is_digital: Optional[bool] = None

When true, the transaction recorded the purchase of a digital listing.

file_data class-attribute instance-attribute

file_data: Optional[str] = None

A string describing the files purchased in this transaction.

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The numeric ID for the listing associated to this transaction.

transaction_type class-attribute instance-attribute

transaction_type: Optional[str] = None

The type string for the transaction, usually listing

product_id class-attribute instance-attribute

product_id: Optional[int] = None

The numeric ID for a specific product purchased from a listing.

TransactionReviews dataclass

TransactionReviews(count: Optional[int] = None, results: Optional[List[TransactionReview]] = None)

Response for Get reviews

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of TransactionReview resources found.

results class-attribute instance-attribute

results: Optional[List[TransactionReview]] = None

The TransactionReview resources found.

ShippingCarriers dataclass

ShippingCarriers(count: Optional[int] = None, results: Optional[List[ShippingCarrier]] = None)

Response for Get shipping carriers

ShopShippingProfile dataclass

ShopShippingProfile(shipping_profile_id: Optional[int] = None, title: Optional[str] = None, user_id: Optional[int] = None, min_processing_days: Optional[int] = None, max_processing_days: Optional[int] = None, processing_days_display_label: Optional[str] = None, origin_country_iso: Optional[str] = None, is_deleted: Optional[bool] = None, shipping_profile_destinations: Optional[List[ShopShippingProfileDestination]] = None, shipping_profile_upgrades: Optional[List[ShopShippingProfileUpgrade]] = None, origin_postal_code: Optional[str] = None, profile_type: Optional[ProfileType] = None)

Response for Get shipping profiles

Attributes

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the shipping profile.

title class-attribute instance-attribute

title: Optional[str] = None

The name string of this shipping profile.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric ID for the user who owns the shipping profile.

min_processing_days class-attribute instance-attribute

min_processing_days: Optional[int] = None

The minimum number of days for processing the listing.

max_processing_days class-attribute instance-attribute

max_processing_days: Optional[int] = None

The maximum number of days for processing the listing.

processing_days_display_label class-attribute instance-attribute

processing_days_display_label: Optional[str] = None

Translated display label string for processing days.

origin_country_iso class-attribute instance-attribute

origin_country_iso: Optional[str] = None

The ISO code of the country from which the listing ships.

is_deleted class-attribute instance-attribute

is_deleted: Optional[bool] = None

When true, someone deleted this shipping profile.

shipping_profile_destinations class-attribute instance-attribute

shipping_profile_destinations: Optional[List[ShopShippingProfileDestination]] = None

A list of shipping profile destinations available for this shipping profile.

shipping_profile_upgrades class-attribute instance-attribute

shipping_profile_upgrades: Optional[List[ShopShippingProfileUpgrade]] = None

A list of shipping profile upgrades available for this shipping profile.

origin_postal_code class-attribute instance-attribute

origin_postal_code: Optional[str] = None

The postal code string (not necessarily a number) for the location from which the listing ships.

ShippingCreateProfileInput dataclass

ShippingCreateProfileInput(title: Optional[str] = None, origin_country_iso: Optional[str] = None, primary_cost: Optional[float] = None, secondary_cost: Optional[float] = None, min_processing_time: Optional[int] = None, max_processing_time: Optional[int] = None, processing_time_unit: Optional[str] = None, destination_country_iso: Optional[str] = None, destination_region: Optional[str] = None, origin_postal_code: Optional[str] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Create a shipping profile

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

The name string of this shipping profile.

origin_country_iso class-attribute instance-attribute

origin_country_iso: Optional[str] = None

The ISO code of the country from which the listing ships.

primary_cost class-attribute instance-attribute

primary_cost: Optional[float] = None

The cost of shipping to this country/region alone, measured in the store's default currency.

secondary_cost class-attribute instance-attribute

secondary_cost: Optional[float] = None

The cost of shipping to this country/region with another item, measured in the store's default currency.

min_processing_time class-attribute instance-attribute

min_processing_time: Optional[int] = None

The minimum time required to process to ship listings with this shipping profile.

max_processing_time class-attribute instance-attribute

max_processing_time: Optional[int] = None

The maximum processing time the listing needs to ship.

processing_time_unit class-attribute instance-attribute

processing_time_unit: Optional[str] = None

The unit used to represent how long a processing time is. A week is equivalent to 5 business days.

destination_country_iso class-attribute instance-attribute

destination_country_iso: Optional[str] = None

The ISO code of the country to which the listing ships. If null, request sets destination to destination region.

destination_region class-attribute instance-attribute

destination_region: Optional[str] = None

The code of the region to which the listing ships. A region represents a set of countries. Supported regions are Europe Union and Non-Europe Union (countries in Europe not in EU). If none, request sets destination to destination country ISO, or everywhere if destination country ISO is also null.

origin_postal_code class-attribute instance-attribute

origin_postal_code: Optional[str] = None

The postal code string (not necessarily a number) for the location from which the listing ships.

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

The unique ID of a supported shipping carrier, which is used to calculate an estimated delivery date.

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

ShippingUpdateProfileInput dataclass

ShippingUpdateProfileInput(title: Optional[str] = None, origin_country_iso: Optional[str] = None, min_processing_time: Optional[int] = None, max_processing_time: Optional[int] = None, processing_time_unit: Optional[str] = None, origin_postal_code: Optional[str] = None)

Update a shipping profile

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

The name string of this shipping profile.

origin_country_iso class-attribute instance-attribute

origin_country_iso: Optional[str] = None

The ISO code of the country from which the listing ships.

min_processing_time class-attribute instance-attribute

min_processing_time: Optional[int] = None

The minimum time required to process to ship listings with this shipping profile.

max_processing_time class-attribute instance-attribute

max_processing_time: Optional[int] = None

The maximum processing time the listing needs to ship.

processing_time_unit class-attribute instance-attribute

processing_time_unit: Optional[str] = None

The unit used to represent how long a processing time is. A week is equivalent to 5 business days. If none is provided, the unit is set to business_days.

origin_postal_code class-attribute instance-attribute

origin_postal_code: Optional[str] = None

The postal code string (not necessarily a number) for the location from which the listing ships.

ShopShippingProfileDestinations dataclass

ShopShippingProfileDestinations(count: Optional[int] = None, results: Optional[List[ShopShippingProfileDestination]] = None)

Response for Get profile destinations by shipping profile

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[ShopShippingProfileDestination]] = None

The list of requested resources.

ShippingCreateDestinationInput dataclass

ShippingCreateDestinationInput(primary_cost: Optional[float] = None, secondary_cost: Optional[str] = None, destination_country_iso: Optional[str] = None, destination_region: Optional[str] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Create a shipping profile destination

Attributes

primary_cost class-attribute instance-attribute

primary_cost: Optional[float] = None

The cost of shipping to this country/region alone, measured in the store's default currency.

secondary_cost class-attribute instance-attribute

secondary_cost: Optional[str] = None

The cost of shipping to this country/region with another item, measured in the store's default currency.

destination_country_iso class-attribute instance-attribute

destination_country_iso: Optional[str] = None

destination_country_iso

destination_region class-attribute instance-attribute

destination_region: Optional[str] = None

destination_region

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

shipping_carrier_id

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

mail_class

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

min_delivery_days

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

max_delivery_days

ShopShippingProfileDestination dataclass

ShopShippingProfileDestination(shipping_profile_destination_id: Optional[int] = None, shipping_profile_id: Optional[int] = None, origin_country_iso: Optional[str] = None, destination_country_iso: Optional[str] = None, destination_region: Optional[DestinationRegion] = None, primary_cost: Optional[Money] = None, secondary_cost: Optional[Money] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Response for Create a shipping profile destination

Attributes

shipping_profile_destination_id class-attribute instance-attribute

shipping_profile_destination_id: Optional[int] = None

The numeric ID of the shipping profile destination in the shipping profile associated with the listing.

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the shipping profile.

origin_country_iso class-attribute instance-attribute

origin_country_iso: Optional[str] = None

The ISO code of the country from which the listing ships.

destination_country_iso class-attribute instance-attribute

destination_country_iso: Optional[str] = None

The ISO code of the country to which the listing ships. If null, request sets destination to destination_region

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

ShippingUpdateProfileDestinationInput dataclass

ShippingUpdateProfileDestinationInput(primary_cost: Optional[str] = None, secondary_cost: Optional[str] = None, destination_country_iso: Optional[str] = None, destination_region: Optional[str] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Update a shipping profile destination

Attributes

primary_cost class-attribute instance-attribute

primary_cost: Optional[str] = None

primary_cost

secondary_cost class-attribute instance-attribute

secondary_cost: Optional[str] = None

secondary_cost

destination_country_iso class-attribute instance-attribute

destination_country_iso: Optional[str] = None

destination_country_iso

destination_region class-attribute instance-attribute

destination_region: Optional[str] = None

destination_region

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

shipping_carrier_id

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

mail_class

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

min_delivery_days

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

max_delivery_days

ShopShippingProfileUpgrades dataclass

ShopShippingProfileUpgrades(count: Optional[int] = None, results: Optional[List[ShopShippingProfileUpgrade]] = None)

Response for Get shipping profile upgrades

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[ShopShippingProfileUpgrade]] = None

The list of requested resources.

ShippingCreateUpgradeInput dataclass

ShippingCreateUpgradeInput(type_: Optional[str] = None, upgrade_name: Optional[str] = None, price: Optional[float] = None, secondary_price: Optional[float] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Create a shipping profile upgrade

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type of the shipping upgrade. Domestic (0) or international (1).

upgrade_name class-attribute instance-attribute

upgrade_name: Optional[str] = None

Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.

price class-attribute instance-attribute

price: Optional[float] = None

Additional cost of adding the shipping upgrade.

secondary_price class-attribute instance-attribute

secondary_price: Optional[float] = None

Additional cost of adding the shipping upgrade for each additional item.

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

min_delivery_days

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

ShopShippingProfileUpgrade dataclass

ShopShippingProfileUpgrade(shipping_profile_id: Optional[int] = None, upgrade_id: Optional[int] = None, upgrade_name: Optional[str] = None, type_: Optional[Type] = None, rank: Optional[int] = None, language: Optional[str] = None, price: Optional[Money] = None, secondary_price: Optional[Money] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Response for Create a shipping profile upgrade

Attributes

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the base shipping profile.

upgrade_id class-attribute instance-attribute

upgrade_id: Optional[int] = None

The numeric ID that is associated with a shipping upgrade

upgrade_name class-attribute instance-attribute

upgrade_name: Optional[str] = None

Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.

rank class-attribute instance-attribute

rank: Optional[int] = None

The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.

language class-attribute instance-attribute

language: Optional[str] = None

The IETF language tag for the language of the shipping profile. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

ShippingUpdateProfileUpgradeInput dataclass

ShippingUpdateProfileUpgradeInput(type_: Optional[str] = None, upgrade_name: Optional[str] = None, price: Optional[float] = None, secondary_price: Optional[float] = None, shipping_carrier_id: Optional[int] = None, mail_class: Optional[str] = None, min_delivery_days: Optional[int] = None, max_delivery_days: Optional[int] = None)

Update a shipping profile upgrade

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type of the shipping upgrade. Domestic (0) or international (1).

upgrade_name class-attribute instance-attribute

upgrade_name: Optional[str] = None

Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.

price class-attribute instance-attribute

price: Optional[float] = None

Additional cost of adding the shipping upgrade.

secondary_price class-attribute instance-attribute

secondary_price: Optional[float] = None

Additional cost of adding the shipping upgrade for each additional item.

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.

mail_class class-attribute instance-attribute

mail_class: Optional[str] = None

The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.

min_delivery_days class-attribute instance-attribute

min_delivery_days: Optional[int] = None

min_delivery_days

max_delivery_days class-attribute instance-attribute

max_delivery_days: Optional[int] = None

The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.

ShopUpdateInput dataclass

ShopUpdateInput(title: Optional[str] = None, announcement: Optional[str] = None, sale_message: Optional[str] = None, digital_sale_message: Optional[str] = None)

Update a shop

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

A brief heading string for the shop's main page.

announcement class-attribute instance-attribute

announcement: Optional[str] = None

An announcement string to buyers that displays on the shop's homepage.

sale_message class-attribute instance-attribute

sale_message: Optional[str] = None

A message string sent to users who complete a purchase from this shop.

digital_sale_message class-attribute instance-attribute

digital_sale_message: Optional[str] = None

A message string sent to users who purchase a digital item from this shop.

Shop dataclass

Shop(shop_id: Optional[int] = None, user_id: Optional[int] = None, shop_name: Optional[str] = None, create_date: Optional[int] = None, title: Optional[str] = None, announcement: Optional[str] = None, currency_code: Optional[str] = None, is_vacation: Optional[bool] = None, vacation_message: Optional[str] = None, sale_message: Optional[str] = None, digital_sale_message: Optional[str] = None, update_date: Optional[int] = None, listing_active_count: Optional[int] = None, digital_listing_count: Optional[int] = None, login_name: Optional[str] = None, accepts_custom_requests: Optional[bool] = None, policy_welcome: Optional[str] = None, policy_payment: Optional[str] = None, policy_shipping: Optional[str] = None, policy_refunds: Optional[str] = None, policy_additional: Optional[str] = None, policy_seller_info: Optional[str] = None, policy_update_date: Optional[int] = None, policy_has_private_receipt_info: Optional[bool] = None, has_unstructured_policies: Optional[bool] = None, policy_privacy: Optional[str] = None, vacation_autoreply: Optional[str] = None, url: Optional[str] = None, image_url760x100: Optional[str] = None, num_favorers: Optional[int] = None, languages: Optional[List[str]] = None, icon_url_fullxfull: Optional[str] = None, is_using_structured_policies: Optional[bool] = None, has_onboarded_structured_policies: Optional[bool] = None, include_dispute_form_link: Optional[bool] = None, is_direct_checkout_onboarded: Optional[bool] = None, is_calculated_eligible: Optional[bool] = None, is_opted_in_to_buyer_promise: Optional[bool] = None, is_shop_us_based: Optional[bool] = None, transaction_sold_count: Optional[int] = None, shipping_from_country_iso: Optional[str] = None, shop_location_country_iso: Optional[str] = None, review_count: Optional[int] = None, review_average: Optional[float] = None)

Response for Update a shop

Attributes

shop_id class-attribute instance-attribute

shop_id: Optional[int] = None

The unique positive non-zero numeric ID for an Etsy Shop.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric user ID of the user who owns this shop.

shop_name class-attribute instance-attribute

shop_name: Optional[str] = None

The shop's name string.

create_date class-attribute instance-attribute

create_date: Optional[int] = None

The date and time this shop was created, in epoch seconds.

title class-attribute instance-attribute

title: Optional[str] = None

A brief heading string for the shop's main page.

announcement class-attribute instance-attribute

announcement: Optional[str] = None

An announcement string to buyers that displays on the shop's homepage.

currency_code class-attribute instance-attribute

currency_code: Optional[str] = None

The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.

is_vacation class-attribute instance-attribute

is_vacation: Optional[bool] = None

When true, this shop is not accepting purchases.

vacation_message class-attribute instance-attribute

vacation_message: Optional[str] = None

The shop's message string displayed when is_vacation is true.

sale_message class-attribute instance-attribute

sale_message: Optional[str] = None

A message string sent to users who complete a purchase from this shop.

digital_sale_message class-attribute instance-attribute

digital_sale_message: Optional[str] = None

A message string sent to users who purchase a digital item from this shop.

update_date class-attribute instance-attribute

update_date: Optional[int] = None

The date and time of the last update to the shop, in epoch seconds.

listing_active_count class-attribute instance-attribute

listing_active_count: Optional[int] = None

The number of active listings in the shop.

digital_listing_count class-attribute instance-attribute

digital_listing_count: Optional[int] = None

The number of digital listings in the shop.

login_name class-attribute instance-attribute

login_name: Optional[str] = None

The shop owner's login name string.

accepts_custom_requests class-attribute instance-attribute

accepts_custom_requests: Optional[bool] = None

When true, the shop accepts customization requests.

policy_welcome class-attribute instance-attribute

policy_welcome: Optional[str] = None

The shop's policy welcome string (may be blank).

policy_payment class-attribute instance-attribute

policy_payment: Optional[str] = None

The shop's payment policy string (may be blank).

policy_shipping class-attribute instance-attribute

policy_shipping: Optional[str] = None

The shop's shipping policy string (may be blank).

policy_refunds class-attribute instance-attribute

policy_refunds: Optional[str] = None

The shop's refund policy string (may be blank).

policy_additional class-attribute instance-attribute

policy_additional: Optional[str] = None

The shop's additional policies string (may be blank).

policy_seller_info class-attribute instance-attribute

policy_seller_info: Optional[str] = None

The shop's seller infomation string (may be blank).

policy_update_date class-attribute instance-attribute

policy_update_date: Optional[int] = None

The date and time of the last update to the shop's policies, in epoch seconds.

policy_has_private_receipt_info class-attribute instance-attribute

policy_has_private_receipt_info: Optional[bool] = None

When true, EU receipts display private info.

has_unstructured_policies class-attribute instance-attribute

has_unstructured_policies: Optional[bool] = None

When true, the shop displays additional unstructured policy fields.

policy_privacy class-attribute instance-attribute

policy_privacy: Optional[str] = None

The shop's privacy policy string (may be blank).

vacation_autoreply class-attribute instance-attribute

vacation_autoreply: Optional[str] = None

The shop's automatic reply string displayed in new conversations when is_vacation is true.

url class-attribute instance-attribute

url: Optional[str] = None

The URL string for this shop.

image_url760x100 class-attribute instance-attribute

image_url760x100: Optional[str] = field(default=None, metadata={'wire_name': 'image_url_760x100'})

The URL string for this shop's banner image.

num_favorers class-attribute instance-attribute

num_favorers: Optional[int] = None

The number of users who marked this shop a favorite.

languages class-attribute instance-attribute

languages: Optional[List[str]] = None

A list of language strings for the shop's enrolled languages.

icon_url_fullxfull class-attribute instance-attribute

icon_url_fullxfull: Optional[str] = None

The URL string for this shop's icon image.

is_using_structured_policies class-attribute instance-attribute

is_using_structured_policies: Optional[bool] = None

When true, the shop accepted using structured policies.

has_onboarded_structured_policies class-attribute instance-attribute

has_onboarded_structured_policies: Optional[bool] = None

When true, the shop accepted OR declined after viewing structured policies onboarding.

include_dispute_form_link class-attribute instance-attribute

include_dispute_form_link: Optional[bool] = None

When true, this shop's policies include a link to an EU online dispute form.

is_direct_checkout_onboarded class-attribute instance-attribute

is_direct_checkout_onboarded: Optional[bool] = None

When true, the shop has onboarded onto Etsy Payments.

is_calculated_eligible class-attribute instance-attribute

is_calculated_eligible: Optional[bool] = None

When true, the shop is elegible for calculated shipping profiles. (Only available in the US and Canada)

is_opted_in_to_buyer_promise class-attribute instance-attribute

is_opted_in_to_buyer_promise: Optional[bool] = None

When true, the shop opted in to buyer promise.

is_shop_us_based class-attribute instance-attribute

is_shop_us_based: Optional[bool] = None

When true, the shop is based in the US.

transaction_sold_count class-attribute instance-attribute

transaction_sold_count: Optional[int] = None

The total number of sales transactions for this shop

shipping_from_country_iso class-attribute instance-attribute

shipping_from_country_iso: Optional[str] = None

The country iso the shop is shipping from.

shop_location_country_iso class-attribute instance-attribute

shop_location_country_iso: Optional[str] = None

The country iso where the shop is located.

review_count class-attribute instance-attribute

review_count: Optional[int] = None

Number of reviews of shop listings in the past year.

review_average class-attribute instance-attribute

review_average: Optional[float] = None

Average rating based on reviews of shop listings in the past year.

Shops dataclass

Shops(count: Optional[int] = None, results: Optional[List[Shop]] = None)

Response for Search shops

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The total number of Shops

results class-attribute instance-attribute

results: Optional[List[Shop]] = None

The Shop resources.

ShopSections dataclass

ShopSections(count: Optional[int] = None, results: Optional[List[ShopSection]] = None)

Response for Get shop sections

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[ShopSection]] = None

The list of requested resources.

ShopCreateSectionInput dataclass

ShopCreateSectionInput(title: Optional[str] = None)

Create a shop section

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

The title string for a shop section.

ShopSection dataclass

ShopSection(shop_section_id: Optional[int] = None, title: Optional[str] = None, rank: Optional[int] = None, user_id: Optional[int] = None, active_listing_count: Optional[int] = None)

Response for Create a shop section

Attributes

shop_section_id class-attribute instance-attribute

shop_section_id: Optional[int] = None

The numeric ID of a section in a specific Etsy shop.

title class-attribute instance-attribute

title: Optional[str] = None

The title string for a shop section.

rank class-attribute instance-attribute

rank: Optional[int] = None

The positive non-zero numeric position of this section in the section display order for a shop, with rank 1 sections appearing first.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric ID of the user who owns this shop section.

active_listing_count class-attribute instance-attribute

active_listing_count: Optional[int] = None

The number of active listings in one section of a specific Etsy shop.

User dataclass

User(user_id: Optional[int] = None, login_name: Optional[str] = None, primary_email: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, create_timestamp: Optional[int] = None, referred_by_user_id: Optional[int] = None, use_new_inventory_endpoints: Optional[bool] = None, is_seller: Optional[bool] = None, bio: Optional[str] = None, gender: Optional[str] = None, birth_month: Optional[str] = None, birth_day: Optional[str] = None, transaction_buy_count: Optional[int] = None, transaction_sold_count: Optional[int] = None)

Response for Get user

Attributes

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric ID of a user. This number is also a valid shop ID for the user's shop.

login_name class-attribute instance-attribute

login_name: Optional[str] = None

The user's login name string.

primary_email class-attribute instance-attribute

primary_email: Optional[str] = None

An email address string for the user's primary email address.

first_name class-attribute instance-attribute

first_name: Optional[str] = None

The user's first name.

last_name class-attribute instance-attribute

last_name: Optional[str] = None

The user's last name.

create_timestamp class-attribute instance-attribute

create_timestamp: Optional[int] = None

The date and time the user created their account, in epoch seconds.

referred_by_user_id class-attribute instance-attribute

referred_by_user_id: Optional[int] = None

The numeric ID of the user who referred this user.

use_new_inventory_endpoints class-attribute instance-attribute

use_new_inventory_endpoints: Optional[bool] = None

Deprecated. Always true.

is_seller class-attribute instance-attribute

is_seller: Optional[bool] = None

True if the user is seller.

bio class-attribute instance-attribute

bio: Optional[str] = None

The user's biography.

gender class-attribute instance-attribute

gender: Optional[str] = None

The user's gender.

birth_month class-attribute instance-attribute

birth_month: Optional[str] = None

The user's month of birth.

birth_day class-attribute instance-attribute

birth_day: Optional[str] = None

The user's day of birth.

transaction_buy_count class-attribute instance-attribute

transaction_buy_count: Optional[int] = None

The number of transactions where the user has bought.

transaction_sold_count class-attribute instance-attribute

transaction_sold_count: Optional[int] = None

The number of transactions where the user has sold.

UserAddress dataclass

UserAddress(user_address_id: Optional[int] = None, user_id: Optional[int] = None, name: Optional[str] = None, first_line: Optional[str] = None, second_line: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, zip: Optional[str] = None, iso_country_code: Optional[str] = None, country_name: Optional[str] = None, is_default_shipping_address: Optional[bool] = None)

Response for Get user's address

Attributes

user_address_id class-attribute instance-attribute

user_address_id: Optional[int] = None

The numeric ID of the user's address.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The user's numeric ID.

name class-attribute instance-attribute

name: Optional[str] = None

The user's name for this address.

first_line class-attribute instance-attribute

first_line: Optional[str] = None

The first line of the user's address.

second_line class-attribute instance-attribute

second_line: Optional[str] = None

The second line of the user's address.

city class-attribute instance-attribute

city: Optional[str] = None

The city field of the user's address.

state class-attribute instance-attribute

state: Optional[str] = None

The state field of the user's address.

zip class-attribute instance-attribute

zip: Optional[str] = None

The zip code field of the user's address.

iso_country_code class-attribute instance-attribute

iso_country_code: Optional[str] = None

The ISO code of the country in this address.

country_name class-attribute instance-attribute

country_name: Optional[str] = None

The name of the user's country.

is_default_shipping_address class-attribute instance-attribute

is_default_shipping_address: Optional[bool] = None

Is this the user's default shipping address.

UserAddresses dataclass

UserAddresses(count: Optional[int] = None, results: Optional[List[UserAddress]] = None)

Response for Get user addresses

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of UserAddress records being returned.

results class-attribute instance-attribute

results: Optional[List[UserAddress]] = None

An array of UserAddress resources.

SellerTaxonomyNodes dataclass

SellerTaxonomyNodes(count: Optional[int] = None, results: Optional[List[SellerTaxonomyNode]] = None)

Response for Get seller taxonomy nodes

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[SellerTaxonomyNode]] = None

The list of requested resources.

TaxonomyNodeProperties dataclass

TaxonomyNodeProperties(count: Optional[int] = None, results: Optional[List[TaxonomyNodeProperty]] = None)

Response for Get product properties by taxonomy ID

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[TaxonomyNodeProperty]] = None

The list of requested resources.

ShopListings dataclass

ShopListings(count: Optional[int] = None, results: Optional[List[ShopListing]] = None)

Response for Get listings by shop

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of shop listing resources found.

results class-attribute instance-attribute

results: Optional[List[ShopListing]] = None

The shop listing resources found.

ListingCreateInput dataclass

ListingCreateInput(quantity: Optional[int] = None, title: Optional[str] = None, description: Optional[str] = None, price: Optional[float] = None, who_made: Optional[str] = None, when_made: Optional[str] = None, taxonomy_id: Optional[int] = None, shipping_profile_id: Optional[int] = None, materials: Optional[str] = None, shop_section_id: Optional[int] = None, processing_min: Optional[int] = None, processing_max: Optional[int] = None, tags: Optional[str] = None, recipient: Optional[str] = None, occasion: Optional[str] = None, styles: Optional[str] = None, item_weight: Optional[float] = None, item_length: Optional[int] = None, item_width: Optional[float] = None, item_height: Optional[float] = None, item_weight_unit: Optional[str] = None, item_dimensions_unit: Optional[str] = None, is_personalizable: Optional[bool] = None, image_ids: Optional[str] = None, is_supply: Optional[bool] = None, is_customizable: Optional[bool] = None, is_taxable: Optional[bool] = None)

Create a draft listing

Attributes

quantity class-attribute instance-attribute

quantity: Optional[int] = None

The positive non-zero number of products available for purchase in the listing.

title class-attribute instance-attribute

title: Optional[str] = None

The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each.

description class-attribute instance-attribute

description: Optional[str] = None

A description string of the product for sale in the listing.

price class-attribute instance-attribute

price: Optional[float] = None

The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.

who_made class-attribute instance-attribute

who_made: Optional[str] = None

An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.

when_made class-attribute instance-attribute

when_made: Optional[str] = None

A string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.

taxonomy_id class-attribute instance-attribute

taxonomy_id: Optional[int] = None

The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop.

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the shipping profile associated with the listing.

materials class-attribute instance-attribute

materials: Optional[str] = None

A array of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

shop_section_id class-attribute instance-attribute

shop_section_id: Optional[int] = None

The numeric ID of the shop section for this listing.

processing_min class-attribute instance-attribute

processing_min: Optional[int] = None

The minimum number of days required to process this listing.

processing_max class-attribute instance-attribute

processing_max: Optional[int] = None

The maximum number of days required to process this listing.

tags class-attribute instance-attribute

tags: Optional[str] = None

An array of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

recipient class-attribute instance-attribute

recipient: Optional[str] = None

A string indicating a person for whom this product would make an appropriate gift.

occasion class-attribute instance-attribute

occasion: Optional[str] = None

A string indicating an occassion for which this product would make an appropriate gift.

styles class-attribute instance-attribute

styles: Optional[str] = None

An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

item_weight class-attribute instance-attribute

item_weight: Optional[float] = None

The numeric weight of the product measured in units set in item weight unit.

item_length class-attribute instance-attribute

item_length: Optional[int] = None

The numeric length of the product measured in units set in item dimensions unit.

item_width class-attribute instance-attribute

item_width: Optional[float] = None

The numeric width of the product measured in units set in 'item dimensions unit'.

item_height class-attribute instance-attribute

item_height: Optional[float] = None

The numeric height of the product measured in units set in 'item dimensions unit'.

item_weight_unit class-attribute instance-attribute

item_weight_unit: Optional[str] = None

A string defining the units used to measure the weight of the product.

item_dimensions_unit class-attribute instance-attribute

item_dimensions_unit: Optional[str] = None

A string defining the units used to measure the dimensions of the product.

is_personalizable class-attribute instance-attribute

is_personalizable: Optional[bool] = None

When true, this listing is personalizable.

image_ids class-attribute instance-attribute

image_ids: Optional[str] = None

An array of numeric image IDs of the images in a listing, which can include up to 10 images.

is_supply class-attribute instance-attribute

is_supply: Optional[bool] = None

When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who made' and 'when made'.

is_customizable class-attribute instance-attribute

is_customizable: Optional[bool] = None

When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.

is_taxable class-attribute instance-attribute

is_taxable: Optional[bool] = None

When true, applicable shop tax rates apply to this listing at checkout.

ShopListing dataclass

ShopListing(listing_id: Optional[int] = None, user_id: Optional[int] = None, shop_id: Optional[int] = None, title: Optional[str] = None, description: Optional[str] = None, state: Optional[State] = None, creation_timestamp: Optional[int] = None, ending_timestamp: Optional[int] = None, original_creation_timestamp: Optional[int] = None, last_modified_timestamp: Optional[int] = None, state_timestamp: Optional[int] = None, quantity: Optional[int] = None, shop_section_id: Optional[int] = None, featured_rank: Optional[int] = None, url: Optional[str] = None, num_favorers: Optional[int] = None, non_taxable: Optional[bool] = None, is_customizable: Optional[bool] = None, is_personalizable: Optional[bool] = None, personalization_is_required: Optional[bool] = None, personalization_char_count_max: Optional[int] = None, personalization_instructions: Optional[str] = None, listing_type: Optional[bool] = None, tags: Optional[List[str]] = None, materials: Optional[List[str]] = None, shipping_profile_id: Optional[int] = None, processing_min: Optional[int] = None, processing_max: Optional[int] = None, who_made: Optional[WhoMade] = None, when_made: Optional[WhenMade] = None, is_supply: Optional[bool] = None, item_weight: Optional[float] = None, item_weight_unit: Optional[ItemWeightUnit] = None, item_length: Optional[float] = None, item_width: Optional[float] = None, item_height: Optional[float] = None, item_dimensions_unit: Optional[ItemDimensionsUnit] = None, is_private: Optional[bool] = None, recipient: Optional[Recipient] = None, occasion: Optional[Occasion] = None, style: Optional[List[str]] = None, file_data: Optional[str] = None, has_variations: Optional[bool] = None, should_auto_renew: Optional[bool] = None, language: Optional[str] = None, price: Optional[Money] = None, taxonomy_id: Optional[int] = None)

Response for Create a draft listing

Attributes

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The numeric ID for the listing associated to this transaction.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric ID for the user posting the listing.

shop_id class-attribute instance-attribute

shop_id: Optional[int] = None

The unique positive non-zero numeric ID for an Etsy Shop.

title class-attribute instance-attribute

title: Optional[str] = None

The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each.

description class-attribute instance-attribute

description: Optional[str] = None

A description string of the product for sale in the listing.

creation_timestamp class-attribute instance-attribute

creation_timestamp: Optional[int] = None

The listing's creation time, in epoch seconds.

ending_timestamp class-attribute instance-attribute

ending_timestamp: Optional[int] = None

The listing's expiration time, in epoch seconds.

original_creation_timestamp class-attribute instance-attribute

original_creation_timestamp: Optional[int] = None

The listing's creation time, in epoch seconds.

last_modified_timestamp class-attribute instance-attribute

last_modified_timestamp: Optional[int] = None

The time of the last update to the listing, in epoch seconds.

state_timestamp class-attribute instance-attribute

state_timestamp: Optional[int] = None

The date and time of the last state change of this listing.

quantity class-attribute instance-attribute

quantity: Optional[int] = None

The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the get listing inventory endpoint.

shop_section_id class-attribute instance-attribute

shop_section_id: Optional[int] = None

The numeric ID of a section in a specific Etsy shop.

featured_rank class-attribute instance-attribute

featured_rank: Optional[int] = None

The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page.

url class-attribute instance-attribute

url: Optional[str] = None

The full URL to the listing's page on Etsy.

num_favorers class-attribute instance-attribute

num_favorers: Optional[int] = None

The number of users who marked this listing a favorite.

non_taxable class-attribute instance-attribute

non_taxable: Optional[bool] = None

When true, applicable shop tax rates do not apply to this listing at checkout.

is_customizable class-attribute instance-attribute

is_customizable: Optional[bool] = None

When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.

is_personalizable class-attribute instance-attribute

is_personalizable: Optional[bool] = None

When true, this listing is personalizable. The default value is null.

personalization_is_required class-attribute instance-attribute

personalization_is_required: Optional[bool] = None

When true, this listing requires personalization. The default value is null.

personalization_char_count_max class-attribute instance-attribute

personalization_char_count_max: Optional[int] = None

This an integer value representing the maximum length for the personalization message entered by the buyer.

personalization_instructions class-attribute instance-attribute

personalization_instructions: Optional[str] = None

When true, this listing requires personalization. The default value is null.

listing_type class-attribute instance-attribute

listing_type: Optional[bool] = None

An enumerated type string that indicates whether the listing is physical or a digital download.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

A list of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u) Default value is null.

materials class-attribute instance-attribute

materials: Optional[List[str]] = None

A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the shipping profile associated with the listing.

processing_min class-attribute instance-attribute

processing_min: Optional[int] = None

The minimum number of days required to process this listing. Default value is null.

processing_max class-attribute instance-attribute

processing_max: Optional[int] = None

The maximum number of days required to process this listing. Default value is null.

is_supply class-attribute instance-attribute

is_supply: Optional[bool] = None

When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'.

item_weight class-attribute instance-attribute

item_weight: Optional[float] = None

The numeric weight of the product measured in units set in item weight unit. Default value is null. If set, the value must be greater than 0.

item_length class-attribute instance-attribute

item_length: Optional[float] = None

The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

item_width class-attribute instance-attribute

item_width: Optional[float] = None

The numeric width of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

item_height class-attribute instance-attribute

item_height: Optional[float] = None

The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

is_private class-attribute instance-attribute

is_private: Optional[bool] = None

When true, this is a private listing intendend for a specific buyer and hidden from shop view.

style class-attribute instance-attribute

style: Optional[List[str]] = None

An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.

file_data class-attribute instance-attribute

file_data: Optional[str] = None

A string describing the files attached to a digital listing.

has_variations class-attribute instance-attribute

has_variations: Optional[bool] = None

When true, the listing has variations.

should_auto_renew class-attribute instance-attribute

should_auto_renew: Optional[bool] = None

When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but the renewal period starts immidiately rather than extending the listing's expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill.

language class-attribute instance-attribute

language: Optional[str] = None

The IETF language tag for the default language of the listing. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

taxonomy_id class-attribute instance-attribute

taxonomy_id: Optional[int] = None

The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. See seller taxonomy for more information.

ShopListingsWithAssociations dataclass

ShopListingsWithAssociations(count: Optional[int] = None, results: Optional[List[ShopListing]] = None)

Response for Get listings by ID

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of shop listing resources found.

results class-attribute instance-attribute

results: Optional[List[ShopListing]] = None

The shop listing resources found.

ListingUpdatePropertyInput dataclass

ListingUpdatePropertyInput(value_ids: Optional[int] = None, values: Optional[str] = None, scale_id: Optional[int] = None)

Update a listing property

Attributes

value_ids class-attribute instance-attribute

value_ids: Optional[int] = None

The numeric ID of a single Etsy.com measurement scale.

values class-attribute instance-attribute

values: Optional[str] = None

An array of value strings for multiple Etsy listing property values.

scale_id class-attribute instance-attribute

scale_id: Optional[int] = None

The numeric ID of a single Etsy.com measurement scale.

ListingPropertyValue dataclass

ListingPropertyValue(property_id: Optional[int] = None, property_name: Optional[str] = None, scale_id: Optional[int] = None, scale_name: Optional[str] = None, value_ids: Optional[List[int]] = None, values: Optional[List[str]] = None)

Response for Update a listing property

Attributes

property_id class-attribute instance-attribute

property_id: Optional[int] = None

The numeric ID of the Property.

property_name class-attribute instance-attribute

property_name: Optional[str] = None

The name of the Property.

scale_id class-attribute instance-attribute

scale_id: Optional[int] = None

The numeric ID of the scale (if any).

scale_name class-attribute instance-attribute

scale_name: Optional[str] = None

The label used to describe the chosen scale (if any).

value_ids class-attribute instance-attribute

value_ids: Optional[List[int]] = None

The numeric IDs of the property values

values class-attribute instance-attribute

values: Optional[List[str]] = None

The property values

ListingPropertyValues dataclass

ListingPropertyValues(count: Optional[int] = None, results: Optional[List[ListingPropertyValue]] = None)

Response for Get a listing's properties

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of shop listing resources found.

results class-attribute instance-attribute

results: Optional[List[ListingPropertyValue]] = None

The shop listing resources found.

ListingUpdateInput dataclass

ListingUpdateInput(quantity: Optional[int] = None, title: Optional[str] = None, description: Optional[str] = None, price: Optional[float] = None, who_made: Optional[str] = None, when_made: Optional[str] = None, taxonomy_id: Optional[int] = None, shipping_profile_id: Optional[int] = None, materials: Optional[str] = None, shop_section_id: Optional[int] = None, processing_min: Optional[int] = None, processing_max: Optional[int] = None, tags: Optional[str] = None, recipient: Optional[str] = None, occasion: Optional[str] = None, styles: Optional[str] = None, item_weight: Optional[float] = None, item_length: Optional[int] = None, item_width: Optional[float] = None, item_height: Optional[float] = None, item_weight_unit: Optional[str] = None, item_dimensions_unit: Optional[str] = None, is_personalizable: Optional[bool] = None, image_ids: Optional[str] = None, is_supply: Optional[bool] = None, is_customizable: Optional[bool] = None, is_taxable: Optional[bool] = None, featured_rank: Optional[int] = None, should_auto_renew: Optional[bool] = None, type_: Optional[str] = None, channels: Optional[str] = None)

Update a listing

Attributes

quantity class-attribute instance-attribute

quantity: Optional[int] = None

The positive non-zero number of products available for purchase in the listing.

title class-attribute instance-attribute

title: Optional[str] = None

The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each.

description class-attribute instance-attribute

description: Optional[str] = None

A description string of the product for sale in the listing.

price class-attribute instance-attribute

price: Optional[float] = None

The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.

who_made class-attribute instance-attribute

who_made: Optional[str] = None

An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.

when_made class-attribute instance-attribute

when_made: Optional[str] = None

A string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.

taxonomy_id class-attribute instance-attribute

taxonomy_id: Optional[int] = None

The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop.

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the shipping profile associated with the listing.

materials class-attribute instance-attribute

materials: Optional[str] = None

A array of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

shop_section_id class-attribute instance-attribute

shop_section_id: Optional[int] = None

The numeric ID of the shop section for this listing.

processing_min class-attribute instance-attribute

processing_min: Optional[int] = None

The minimum number of days required to process this listing.

processing_max class-attribute instance-attribute

processing_max: Optional[int] = None

The maximum number of days required to process this listing.

tags class-attribute instance-attribute

tags: Optional[str] = None

An array of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

recipient class-attribute instance-attribute

recipient: Optional[str] = None

A string indicating a person for whom this product would make an appropriate gift.

occasion class-attribute instance-attribute

occasion: Optional[str] = None

A string indicating an occassion for which this product would make an appropriate gift.

styles class-attribute instance-attribute

styles: Optional[str] = None

An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

item_weight class-attribute instance-attribute

item_weight: Optional[float] = None

The numeric weight of the product measured in units set in item weight unit.

item_length class-attribute instance-attribute

item_length: Optional[int] = None

The numeric length of the product measured in units set in item dimensions unit.

item_width class-attribute instance-attribute

item_width: Optional[float] = None

The numeric width of the product measured in units set in 'item dimensions unit'.

item_height class-attribute instance-attribute

item_height: Optional[float] = None

The numeric height of the product measured in units set in 'item dimensions unit'.

item_weight_unit class-attribute instance-attribute

item_weight_unit: Optional[str] = None

A string defining the units used to measure the weight of the product.

item_dimensions_unit class-attribute instance-attribute

item_dimensions_unit: Optional[str] = None

A string defining the units used to measure the dimensions of the product.

is_personalizable class-attribute instance-attribute

is_personalizable: Optional[bool] = None

When true, this listing is personalizable.

image_ids class-attribute instance-attribute

image_ids: Optional[str] = None

An array of numeric image IDs of the images in a listing, which can include up to 10 images.

is_supply class-attribute instance-attribute

is_supply: Optional[bool] = None

When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who made' and 'when made'.

is_customizable class-attribute instance-attribute

is_customizable: Optional[bool] = None

When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.

is_taxable class-attribute instance-attribute

is_taxable: Optional[bool] = None

When true, applicable shop tax rates apply to this listing at checkout.

featured_rank class-attribute instance-attribute

featured_rank: Optional[int] = None

The positive non-zero numeric position in the featured listings of the shop with rank 1 listings appearing in the left-most position in featured listing on a shop's home page.

should_auto_renew class-attribute instance-attribute

should_auto_renew: Optional[bool] = None

When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but the renewal period starts immidiately rather than extending the listing's expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Indicates whether the listing is physical or a digital download.

channels class-attribute instance-attribute

channels: Optional[str] = None

An array of enumerated channel ID strings. A channel is a venue for sellers to reach buyers in order to make sales.

ShopListingFile dataclass

ShopListingFile(listing_file_id: Optional[int] = None, listing_id: Optional[int] = None, rank: Optional[int] = None, filename: Optional[str] = None, filesize: Optional[str] = None, size_bytes: Optional[int] = None, filetype: Optional[str] = None, create_timestamp: Optional[int] = None)

Response for Get a file from a listing

Attributes

listing_file_id class-attribute instance-attribute

listing_file_id: Optional[int] = None

The unique numeric ID of a file associated with a digital listing.

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The numeric ID for the listing associated to this transaction.

rank class-attribute instance-attribute

rank: Optional[int] = None

The numeric index of the display order position of this file in the listing, starting at 1.

filename class-attribute instance-attribute

filename: Optional[str] = None

The file name string for a file associated with a digital listing.

filesize class-attribute instance-attribute

filesize: Optional[str] = None

A human-readable format size string for the size of a file.

size_bytes class-attribute instance-attribute

size_bytes: Optional[int] = None

A number indicating the size of a file, measured in bytes.

filetype class-attribute instance-attribute

filetype: Optional[str] = None

A type string indicating a file's MIME type.

create_timestamp class-attribute instance-attribute

create_timestamp: Optional[int] = None

The unique numeric timestamp of a file associated with a digital listing.

ShopListingFiles dataclass

ShopListingFiles(count: Optional[int] = None, results: Optional[List[ShopListingFile]] = None)

Response for Get all listing files

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of ShopListingFiles being returned..

results class-attribute instance-attribute

results: Optional[List[ShopListingFile]] = None

An array of ShopListingFile resources.

ListingUploadInput dataclass

ListingUploadInput(listing_file_id: Optional[int] = None, file: Optional[str] = None, name: Optional[str] = None, rank: Optional[int] = None)

Upload a listing file

Attributes

listing_file_id class-attribute instance-attribute

listing_file_id: Optional[int] = None

The unique numeric ID of a file associated with a digital listing.

file class-attribute instance-attribute

file: Optional[str] = None

A binary file to upload.

name class-attribute instance-attribute

name: Optional[str] = None

The file name string of a file to upload

rank class-attribute instance-attribute

rank: Optional[int] = None

The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.

ListingImage dataclass

ListingImage(listing_id: Optional[int] = None, listing_image_id: Optional[int] = None, hex_code: Optional[str] = None, red: Optional[int] = None, green: Optional[int] = None, blue: Optional[int] = None, hue: Optional[int] = None, saturation: Optional[int] = None, brightness: Optional[int] = None, is_black_and_white: Optional[bool] = None, creation_tsz: Optional[int] = None, rank: Optional[int] = None, url75x75: Optional[str] = None, url170x135: Optional[str] = None, url570x_n: Optional[str] = None, url_fullxfull: Optional[str] = None, full_height: Optional[int] = None, full_width: Optional[int] = None)

Response for Get a listing image

Attributes

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The numeric ID for the listing associated to this transaction.

listing_image_id class-attribute instance-attribute

listing_image_id: Optional[int] = None

The numeric ID of the primary listing image for this transaction.

hex_code class-attribute instance-attribute

hex_code: Optional[str] = None

The webhex string for the image's average color, in webhex notation.

red class-attribute instance-attribute

red: Optional[int] = None

The numeric red value equal to the image's average red value, from 0-255 (RGB color).

green class-attribute instance-attribute

green: Optional[int] = None

The numeric red value equal to the image's average red value, from 0-255 (RGB color).

blue class-attribute instance-attribute

blue: Optional[int] = None

The numeric red value equal to the image's average red value, from 0-255 (RGB color).

hue class-attribute instance-attribute

hue: Optional[int] = None

The numeric hue equal to the image's average hue, from 0-360 (HSV color).

saturation class-attribute instance-attribute

saturation: Optional[int] = None

The numeric saturation equal to the image's average saturation, from 0-100 (HSV color).

brightness class-attribute instance-attribute

brightness: Optional[int] = None

The numeric brightness equal to the image's average brightness, from 0-100 (HSV color).

is_black_and_white class-attribute instance-attribute

is_black_and_white: Optional[bool] = None

When true, the image is in black & white.

creation_tsz class-attribute instance-attribute

creation_tsz: Optional[int] = None

The listing image's creation time, in epoch seconds.

rank class-attribute instance-attribute

rank: Optional[int] = None

The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.

url75x75 class-attribute instance-attribute

url75x75: Optional[str] = field(default=None, metadata={'wire_name': 'url_75x75'})

The url string for a 75x75 pixel thumbnail of the image.

url170x135 class-attribute instance-attribute

url170x135: Optional[str] = field(default=None, metadata={'wire_name': 'url_170x135'})

The url string for a 170x135 pixel thumbnail of the image.

url570x_n class-attribute instance-attribute

url570x_n: Optional[str] = field(default=None, metadata={'wire_name': 'url_570xN'})

The url string for a thumbnail of the image, no more than 570 pixels wide with variable height.

url_fullxfull class-attribute instance-attribute

url_fullxfull: Optional[str] = None

The url string for the full-size image, up to 3000 pixels in each dimension.

full_height class-attribute instance-attribute

full_height: Optional[int] = None

The numeric height, measured in pixels, of the full-sized image referenced in url_fullxfull.

full_width class-attribute instance-attribute

full_width: Optional[int] = None

The numeric width, measured in pixels, of the full-sized image referenced in url_fullxfull.

ListingImages dataclass

ListingImages(count: Optional[int] = None, results: Optional[List[ListingImage]] = None)

Response for Get a listing's images

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[ListingImage]] = None

The list of requested resources.

ListingUploadImageInput dataclass

ListingUploadImageInput(image: Optional[str] = None, listing_image_id: Optional[int] = None, rank: Optional[int] = None, overwrite: Optional[bool] = None, is_watermarked: Optional[bool] = None)

Upload a listing image

Attributes

image class-attribute instance-attribute

image: Optional[str] = None

The file name string of a file to upload.

listing_image_id class-attribute instance-attribute

listing_image_id: Optional[int] = None

The numeric ID of the primary listing image for this transaction.

rank class-attribute instance-attribute

rank: Optional[int] = None

The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.

overwrite class-attribute instance-attribute

overwrite: Optional[bool] = None

When true, this request replaces the existing image at a given rank.

is_watermarked class-attribute instance-attribute

is_watermarked: Optional[bool] = None

When true, indicates that the uploaded image has a watermark.

ListingInventoryWithAssociations dataclass

ListingInventoryWithAssociations(products: Optional[List[ListingInventoryProduct]] = None, price_on_property: Optional[List[int]] = None, quantity_on_property: Optional[List[int]] = None, sku_on_property: Optional[List[int]] = None, listing: Optional[ShopListing] = None)

Response for Get a listing's inventory

Attributes

products class-attribute instance-attribute

products: Optional[List[ListingInventoryProduct]] = None

A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.

price_on_property class-attribute instance-attribute

price_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size.

quantity_on_property class-attribute instance-attribute

quantity_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color.

sku_on_property class-attribute instance-attribute

sku_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for different colored products in the same listing, then this array contains the property ID for color.

ListingUpdateInventoryInput dataclass

ListingUpdateInventoryInput(products: Optional[str] = None, price_on_property: Optional[str] = None, quantity_on_property: Optional[str] = None, sku_on_property: Optional[str] = None)

Update a listing's inventory

Attributes

products class-attribute instance-attribute

products: Optional[str] = None

A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.

price_on_property class-attribute instance-attribute

price_on_property: Optional[str] = None

An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size.

quantity_on_property class-attribute instance-attribute

quantity_on_property: Optional[str] = None

An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color.

sku_on_property class-attribute instance-attribute

sku_on_property: Optional[str] = None

An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for different colored products in the same listing, then this array contains the property ID for color.

ListingInventory dataclass

ListingInventory(products: Optional[List[ListingInventoryProduct]] = None, price_on_property: Optional[List[int]] = None, quantity_on_property: Optional[List[int]] = None, sku_on_property: Optional[List[int]] = None)

Response for Update a listing's inventory

Attributes

products class-attribute instance-attribute

products: Optional[List[ListingInventoryProduct]] = None

A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.

price_on_property class-attribute instance-attribute

price_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size.

quantity_on_property class-attribute instance-attribute

quantity_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color.

sku_on_property class-attribute instance-attribute

sku_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for different colored products in the same listing, then this array contains the property ID for color.

ListingInventoryProductOffering dataclass

ListingInventoryProductOffering(offering_id: Optional[int] = None, quantity: Optional[int] = None, is_enabled: Optional[bool] = None, is_deleted: Optional[bool] = None, price: Optional[Money] = None)

Response for Get a listing's offering

Attributes

offering_id class-attribute instance-attribute

offering_id: Optional[int] = None

The ID for the product offering

quantity class-attribute instance-attribute

quantity: Optional[int] = None

The quantity the product offering

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = None

Whether or not the offering can be shown to buyers.

is_deleted class-attribute instance-attribute

is_deleted: Optional[bool] = None

Whether or not the offering has been deleted.

ListingInventoryProduct dataclass

ListingInventoryProduct(product_id: Optional[int] = None, sku: Optional[str] = None, is_deleted: Optional[bool] = None, offerings: Optional[List[ListingInventoryProductOffering]] = None, property_values: Optional[List[ListingPropertyValue]] = None)

Response for Get a listing's product

Attributes

product_id class-attribute instance-attribute

product_id: Optional[int] = None

The numeric ID for a specific product purchased from a listing.

sku class-attribute instance-attribute

sku: Optional[str] = None

The SKU string for the product

is_deleted class-attribute instance-attribute

is_deleted: Optional[bool] = None

When true, someone deleted this product.

offerings class-attribute instance-attribute

offerings: Optional[List[ListingInventoryProductOffering]] = None

A list of product offering entries for this product.

property_values class-attribute instance-attribute

property_values: Optional[List[ListingPropertyValue]] = None

A list of property value entries for this product.

ListingTranslation dataclass

ListingTranslation(listing_id: Optional[int] = None, language: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[str]] = None)

Response for Get a listing's translation

Attributes

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The numeric ID for the Listing.

language class-attribute instance-attribute

language: Optional[str] = None

The IETF language tag (e.g. 'fr') for the language of this translation.

title class-attribute instance-attribute

title: Optional[str] = None

The title of the Listing of this Translation.

description class-attribute instance-attribute

description: Optional[str] = None

The description of the Listing of this Translation.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

The tags of the Listing of this Translation.

ListingCreateTranslationInput dataclass

ListingCreateTranslationInput(title: Optional[str] = None, description: Optional[str] = None, tags: Optional[str] = None)

Create a listing translation

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

The title of the Listing of this Translation.

description class-attribute instance-attribute

description: Optional[str] = None

The description of the Listing of this Translation.

tags class-attribute instance-attribute

tags: Optional[str] = None

The tags of the Listing of this Translation.

ListingUpdateTranslationInput dataclass

ListingUpdateTranslationInput(title: Optional[str] = None, description: Optional[str] = None, tags: Optional[str] = None)

Update a listing translation

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

The title of the Listing of this Translation.

description class-attribute instance-attribute

description: Optional[str] = None

The description of the Listing of this Translation.

tags class-attribute instance-attribute

tags: Optional[str] = None

The tags of the Listing of this Translation.

ListingVariationImages dataclass

ListingVariationImages(count: Optional[int] = None, results: Optional[List[ListingVariationImage]] = None)

Response for Get listing's variation images

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The count of variation images.

results class-attribute instance-attribute

results: Optional[List[ListingVariationImage]] = None

The variation images results.

ListingUpdateVariationInput dataclass

ListingUpdateVariationInput(variation_images: Optional[str] = None)

Update a listing's variation images

Attributes

variation_images class-attribute instance-attribute

variation_images: Optional[str] = None

A array of variation image data.

Money dataclass

Money(amount: Optional[int] = None, divisor: Optional[int] = None, currency_code: Optional[str] = None)

Definition: Money

Attributes

amount class-attribute instance-attribute

amount: Optional[int] = None

The amount of represented by this data.

divisor class-attribute instance-attribute

divisor: Optional[int] = None

The divisor to render the amount.

currency_code class-attribute instance-attribute

currency_code: Optional[str] = None

The ISO currency code for this data.

ErrorSchema dataclass

ErrorSchema(error: Optional[str] = None)

Definition: ErrorSchema

Attributes

error class-attribute instance-attribute

error: Optional[str] = None

The error code.

ShopListingWithAssociations dataclass

ShopListingWithAssociations(listing_id: Optional[int] = None, user_id: Optional[int] = None, shop_id: Optional[int] = None, title: Optional[str] = None, description: Optional[str] = None, state: Optional[State] = None, creation_timestamp: Optional[int] = None, ending_timestamp: Optional[int] = None, original_creation_timestamp: Optional[int] = None, last_modified_timestamp: Optional[int] = None, state_timestamp: Optional[int] = None, quantity: Optional[int] = None, shop_section_id: Optional[int] = None, featured_rank: Optional[int] = None, url: Optional[str] = None, num_favorers: Optional[int] = None, non_taxable: Optional[bool] = None, is_customizable: Optional[bool] = None, is_personalizable: Optional[bool] = None, personalization_is_required: Optional[bool] = None, personalization_char_count_max: Optional[int] = None, personalization_instructions: Optional[str] = None, listing_type: Optional[bool] = None, tags: Optional[List[str]] = None, materials: Optional[List[str]] = None, shipping_profile_id: Optional[int] = None, processing_min: Optional[int] = None, processing_max: Optional[int] = None, who_made: Optional[WhoMade] = None, when_made: Optional[WhenMade] = None, is_supply: Optional[bool] = None, item_weight: Optional[float] = None, item_weight_unit: Optional[ItemWeightUnit] = None, item_length: Optional[float] = None, item_width: Optional[float] = None, item_height: Optional[float] = None, item_dimensions_unit: Optional[ItemDimensionsUnit] = None, is_private: Optional[bool] = None, recipient: Optional[Recipient] = None, occasion: Optional[Occasion] = None, style: Optional[List[str]] = None, file_data: Optional[str] = None, has_variations: Optional[bool] = None, should_auto_renew: Optional[bool] = None, language: Optional[str] = None, price: Optional[Money] = None, taxonomy_id: Optional[int] = None, user: Optional[User] = None, shop: Optional[Shop] = None, images: Optional[List[ListingImage]] = None, production_partners: Optional[List[ShopProductionPartner]] = None)

Definition: ShopListingWithAssociations

Attributes

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The numeric ID for the listing associated to this transaction.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric ID for the user posting the listing.

shop_id class-attribute instance-attribute

shop_id: Optional[int] = None

The unique positive non-zero numeric ID for an Etsy Shop.

title class-attribute instance-attribute

title: Optional[str] = None

The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each.

description class-attribute instance-attribute

description: Optional[str] = None

A description string of the product for sale in the listing.

creation_timestamp class-attribute instance-attribute

creation_timestamp: Optional[int] = None

The listing's creation time, in epoch seconds.

ending_timestamp class-attribute instance-attribute

ending_timestamp: Optional[int] = None

The listing's expiration time, in epoch seconds.

original_creation_timestamp class-attribute instance-attribute

original_creation_timestamp: Optional[int] = None

The listing's creation time, in epoch seconds.

last_modified_timestamp class-attribute instance-attribute

last_modified_timestamp: Optional[int] = None

The time of the last update to the listing, in epoch seconds.

state_timestamp class-attribute instance-attribute

state_timestamp: Optional[int] = None

The date and time of the last state change of this listing.

quantity class-attribute instance-attribute

quantity: Optional[int] = None

The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the get listing inventory endpoint.

shop_section_id class-attribute instance-attribute

shop_section_id: Optional[int] = None

The numeric ID of a section in a specific Etsy shop.

featured_rank class-attribute instance-attribute

featured_rank: Optional[int] = None

The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page.

url class-attribute instance-attribute

url: Optional[str] = None

The full URL to the listing's page on Etsy.

num_favorers class-attribute instance-attribute

num_favorers: Optional[int] = None

The number of users who marked this listing a favorite.

non_taxable class-attribute instance-attribute

non_taxable: Optional[bool] = None

When true, applicable shop tax rates do not apply to this listing at checkout.

is_customizable class-attribute instance-attribute

is_customizable: Optional[bool] = None

When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.

is_personalizable class-attribute instance-attribute

is_personalizable: Optional[bool] = None

When true, this listing is personalizable. The default value is null.

personalization_is_required class-attribute instance-attribute

personalization_is_required: Optional[bool] = None

When true, this listing requires personalization. The default value is null.

personalization_char_count_max class-attribute instance-attribute

personalization_char_count_max: Optional[int] = None

This an integer value representing the maximum length for the personalization message entered by the buyer.

personalization_instructions class-attribute instance-attribute

personalization_instructions: Optional[str] = None

When true, this listing requires personalization. The default value is null.

listing_type class-attribute instance-attribute

listing_type: Optional[bool] = None

An enumerated type string that indicates whether the listing is physical or a digital download.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

A list of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u) Default value is null.

materials class-attribute instance-attribute

materials: Optional[List[str]] = None

A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.

shipping_profile_id class-attribute instance-attribute

shipping_profile_id: Optional[int] = None

The numeric ID of the shipping profile associated with the listing.

processing_min class-attribute instance-attribute

processing_min: Optional[int] = None

The minimum number of days required to process this listing. Default value is null.

processing_max class-attribute instance-attribute

processing_max: Optional[int] = None

The maximum number of days required to process this listing. Default value is null.

is_supply class-attribute instance-attribute

is_supply: Optional[bool] = None

When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'.

item_weight class-attribute instance-attribute

item_weight: Optional[float] = None

The numeric weight of the product measured in units set in item weight unit. Default value is null. If set, the value must be greater than 0.

item_length class-attribute instance-attribute

item_length: Optional[float] = None

The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

item_width class-attribute instance-attribute

item_width: Optional[float] = None

The numeric width of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

item_height class-attribute instance-attribute

item_height: Optional[float] = None

The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

is_private class-attribute instance-attribute

is_private: Optional[bool] = None

When true, this is a private listing intendend for a specific buyer and hidden from shop view.

style class-attribute instance-attribute

style: Optional[List[str]] = None

An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.

file_data class-attribute instance-attribute

file_data: Optional[str] = None

A string describing the files attached to a digital listing.

has_variations class-attribute instance-attribute

has_variations: Optional[bool] = None

When true, the listing has variations.

should_auto_renew class-attribute instance-attribute

should_auto_renew: Optional[bool] = None

When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but the renewal period starts immidiately rather than extending the listing's expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill.

language class-attribute instance-attribute

language: Optional[str] = None

The IETF language tag for the default language of the listing. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

taxonomy_id class-attribute instance-attribute

taxonomy_id: Optional[int] = None

The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. See seller taxonomy for more information.

images class-attribute instance-attribute

images: Optional[List[ListingImage]] = None

Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image

production_partners class-attribute instance-attribute

production_partners: Optional[List[ShopProductionPartner]] = None

Represents a list of production partners for a shop.

ShopProductionPartner dataclass

ShopProductionPartner(production_partner_id: Optional[int] = None, partner_name: Optional[str] = None, location: Optional[str] = None)

Definition: ShopProductionPartner

Attributes

production_partner_id class-attribute instance-attribute

production_partner_id: Optional[int] = None

The numeric ID of a production partner.

partner_name class-attribute instance-attribute

partner_name: Optional[str] = None

The name or title of the production partner.

location class-attribute instance-attribute

location: Optional[str] = None

A string representing the production partner location.

ListingVariationImage dataclass

ListingVariationImage(property_id: Optional[int] = None, value_id: Optional[int] = None, image_id: Optional[int] = None)

Definition: ListingVariationImage

Attributes

property_id class-attribute instance-attribute

property_id: Optional[int] = None

The numeric ID of the Property.

value_id class-attribute instance-attribute

value_id: Optional[int] = None

The numeric ID of the Value.

image_id class-attribute instance-attribute

image_id: Optional[int] = None

The numeric ID of the Image.

PaymentAccountLedgerEntry dataclass

PaymentAccountLedgerEntry(entry_id: Optional[int] = None, ledger_id: Optional[int] = None, sequence_number: Optional[int] = None, amount: Optional[int] = None, currency: Optional[str] = None, description: Optional[str] = None, balance: Optional[int] = None, create_date: Optional[int] = None)

Definition: PaymentAccountLedgerEntry

Attributes

entry_id class-attribute instance-attribute

entry_id: Optional[int] = None

The ledger entry's numeric ID.

ledger_id class-attribute instance-attribute

ledger_id: Optional[int] = None

The ledger's numeric ID.

sequence_number class-attribute instance-attribute

sequence_number: Optional[int] = None

The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry.

amount class-attribute instance-attribute

amount: Optional[int] = None

The amount of money credited to the ledger.

currency class-attribute instance-attribute

currency: Optional[str] = None

The currency of the entry on the ledger.

description class-attribute instance-attribute

description: Optional[str] = None

Details what kind of ledger entry this is: a payment, refund, reversal of a failed refund, disbursement, returned disbursement, recoupment, miscellaneous credit, miscellaneous debit, or bill payment.

balance class-attribute instance-attribute

balance: Optional[int] = None

The amount of money in the shop's ledger the moment after this entry was applied.

create_date class-attribute instance-attribute

create_date: Optional[int] = None

The date and time the ledger entry was created in Epoch seconds..

Payment dataclass

Payment(payment_id: Optional[int] = None, buyer_user_id: Optional[int] = None, shop_id: Optional[int] = None, receipt_id: Optional[int] = None, amount_gross: Optional[Money] = None, amount_fees: Optional[Money] = None, amount_net: Optional[Money] = None, posted_gross: Optional[Money] = None, posted_fees: Optional[Money] = None, posted_net: Optional[Money] = None, adjusted_gross: Optional[Money] = None, adjusted_fees: Optional[Money] = None, adjusted_net: Optional[Money] = None, currency: Optional[str] = None, shop_currency: Optional[str] = None, buyer_currency: Optional[str] = None, shipping_user_id: Optional[int] = None, shipping_address_id: Optional[int] = None, billing_address_id: Optional[int] = None, status: Optional[str] = None, shipped_timestamp: Optional[int] = None, create_timestamp: Optional[int] = None, update_timestamp: Optional[int] = None, payment_adjustments: Optional[List[PaymentAdjustment]] = None)

Definition: Payment

Attributes

payment_id class-attribute instance-attribute

payment_id: Optional[int] = None

A unique numeric ID for a payment to a specific Etsy shop.

buyer_user_id class-attribute instance-attribute

buyer_user_id: Optional[int] = None

The numeric ID for the user who paid the purchase.

shop_id class-attribute instance-attribute

shop_id: Optional[int] = None

The unique positive non-zero numeric ID for an Etsy Shop.

receipt_id class-attribute instance-attribute

receipt_id: Optional[int] = None

The numeric ID for the receipt associated to this transaction.

currency class-attribute instance-attribute

currency: Optional[str] = None

The ISO (alphabetic) code string for the payment's currency.

shop_currency class-attribute instance-attribute

shop_currency: Optional[str] = None

The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.

buyer_currency class-attribute instance-attribute

buyer_currency: Optional[str] = None

The currency string of the buyer.

shipping_user_id class-attribute instance-attribute

shipping_user_id: Optional[int] = None

The numeric ID of the user to which the seller ships the order.

shipping_address_id class-attribute instance-attribute

shipping_address_id: Optional[int] = None

The numeric id identifying the shipping address.

billing_address_id class-attribute instance-attribute

billing_address_id: Optional[int] = None

The numeric ID identifying the billing address of the buyer.

status class-attribute instance-attribute

status: Optional[str] = None

A string indicating the current status of the payment, most commonly settled or authed.

shipped_timestamp class-attribute instance-attribute

shipped_timestamp: Optional[int] = None

The transaction's shipping date and time, in epoch seconds.

create_timestamp class-attribute instance-attribute

create_timestamp: Optional[int] = None

The transaction's creation date and time, in epoch seconds.

update_timestamp class-attribute instance-attribute

update_timestamp: Optional[int] = None

The date and time of the last change to the payment adjustment in epoch seconds.

payment_adjustments class-attribute instance-attribute

payment_adjustments: Optional[List[PaymentAdjustment]] = None

List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.

PaymentAdjustment dataclass

PaymentAdjustment(payment_adjustment_id: Optional[int] = None, payment_id: Optional[int] = None, status: Optional[str] = None, is_success: Optional[bool] = None, user_id: Optional[int] = None, reason_code: Optional[str] = None, total_adjustment_amount: Optional[int] = None, shop_total_adjustment_amount: Optional[int] = None, buyer_total_adjustment_amount: Optional[int] = None, total_fee_adjustment_amount: Optional[int] = None, create_timestamp: Optional[int] = None, update_timestamp: Optional[int] = None)

Definition: PaymentAdjustment

Attributes

payment_adjustment_id class-attribute instance-attribute

payment_adjustment_id: Optional[int] = None

The numeric ID for a payment adjustment.

payment_id class-attribute instance-attribute

payment_id: Optional[int] = None

A unique numeric ID for a payment to a specific Etsy shop.

status class-attribute instance-attribute

status: Optional[str] = None

The status string of the payment adjustment.

is_success class-attribute instance-attribute

is_success: Optional[bool] = None

When true, the payment adjustment was or is likely to complete successfully.

user_id class-attribute instance-attribute

user_id: Optional[int] = None

The numeric ID for the user (seller) fulfilling the purchase.

reason_code class-attribute instance-attribute

reason_code: Optional[str] = None

A human-readable string describing the reason for the refund.

total_adjustment_amount class-attribute instance-attribute

total_adjustment_amount: Optional[int] = None

The total numeric amount of the refund in the payment currency.

shop_total_adjustment_amount class-attribute instance-attribute

shop_total_adjustment_amount: Optional[int] = None

The numeric amount of the refund in the shop currency.

buyer_total_adjustment_amount class-attribute instance-attribute

buyer_total_adjustment_amount: Optional[int] = None

The numeric amount of the refund in the buyer currency.

total_fee_adjustment_amount class-attribute instance-attribute

total_fee_adjustment_amount: Optional[int] = None

The numeric amount of card processing fees associated with a payment adjustment.

create_timestamp class-attribute instance-attribute

create_timestamp: Optional[int] = None

The transaction's creation date and time, in epoch seconds.

update_timestamp class-attribute instance-attribute

update_timestamp: Optional[int] = None

The date and time of the last change to the payment adjustment in epoch seconds.

ShopReceiptShipment dataclass

ShopReceiptShipment(receipt_shipping_id: Optional[int] = None, shipment_notification_timestamp: Optional[int] = None, carrier_name: Optional[str] = None, tracking_code: Optional[str] = None)

Definition: ShopReceiptShipment

Attributes

receipt_shipping_id class-attribute instance-attribute

receipt_shipping_id: Optional[int] = None

The unique numeric ID of a Shop Receipt Shipment record.

shipment_notification_timestamp class-attribute instance-attribute

shipment_notification_timestamp: Optional[int] = None

The time at which Etsy notified the buyer of the shipment event, in epoch seconds.

carrier_name class-attribute instance-attribute

carrier_name: Optional[str] = None

The name string for the carrier/company responsible for delivering the shipment.

tracking_code class-attribute instance-attribute

tracking_code: Optional[str] = None

The tracking code string provided by the carrier/company for the shipment.

TransactionReview dataclass

TransactionReview(shop_id: Optional[int] = None, listing_id: Optional[int] = None, buyer_user_id: Optional[int] = None, rating: Optional[int] = None, review: Optional[str] = None, language: Optional[str] = None, image_url_fullxfull: Optional[str] = None, create_timestamp: Optional[int] = None, update_timestamp: Optional[int] = None)

Definition: TransactionReview

Attributes

shop_id class-attribute instance-attribute

shop_id: Optional[int] = None

The shop's numeric ID.

listing_id class-attribute instance-attribute

listing_id: Optional[int] = None

The ID of the shop listing that the TransactionReview belongs to.

buyer_user_id class-attribute instance-attribute

buyer_user_id: Optional[int] = None

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 class-attribute instance-attribute

rating: Optional[int] = None

Rating value on scale from 1 to 5

review class-attribute instance-attribute

review: Optional[str] = None

A message left by the author, explaining the feedback.

language class-attribute instance-attribute

language: Optional[str] = None

The language of the TransactionReview

image_url_fullxfull class-attribute instance-attribute

image_url_fullxfull: Optional[str] = None

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 class-attribute instance-attribute

create_timestamp: Optional[int] = None

The date and time the TransactionReview was created in epoch seconds.

update_timestamp class-attribute instance-attribute

update_timestamp: Optional[int] = None

The date and time the TransactionReview was updated in epoch seconds.

SellerTaxonomyNode dataclass

SellerTaxonomyNode(id: Optional[int] = None, level: Optional[int] = None, name: Optional[str] = None, parent_id: Optional[int] = None, children: Optional[List[SellerTaxonomyNode]] = None, full_path_taxonomy_ids: Optional[List[int]] = None)

Definition: SellerTaxonomyNode

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the shoes taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than girls' shoes (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes shoes or girls' shoes support access to the EU shoe size scale with its associated property names and IDs for EU shoe sizes, such as property value_id:1394, and name:38.

level class-attribute instance-attribute

level: Optional[int] = None

The integer depth of this taxonomy node in the seller taxonomy tree, with roots at level 0.

name class-attribute instance-attribute

name: Optional[str] = None

The name string for this taxonomy node.

parent_id class-attribute instance-attribute

parent_id: Optional[int] = None

The numeric taxonomy ID of the parent of this node.

children class-attribute instance-attribute

children: Optional[List[SellerTaxonomyNode]] = None

An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxanomy tree.

full_path_taxonomy_ids class-attribute instance-attribute

full_path_taxonomy_ids: Optional[List[int]] = None

An array of taxonomy IDs including this node and all of its direct parents in the seller taxonomy tree up to a root node. They are listed in order from root to leaf.

TaxonomyNodeProperty dataclass

TaxonomyNodeProperty(property_id: Optional[int] = None, name: Optional[str] = None, display_name: Optional[str] = None, scales: Optional[List[TaxonomyPropertyScale]] = None, is_required: Optional[bool] = None, supports_attributes: Optional[bool] = None, supports_variations: Optional[bool] = None, is_multivalued: Optional[bool] = None, possible_values: Optional[List[TaxonomyPropertyValue]] = None, selected_values: Optional[List[TaxonomyPropertyValue]] = None)

Definition: TaxonomyNodeProperty

Attributes

property_id class-attribute instance-attribute

property_id: Optional[int] = None

The unique numeric ID of this product property.

name class-attribute instance-attribute

name: Optional[str] = None

The name string for this taxonomy node.

display_name class-attribute instance-attribute

display_name: Optional[str] = None

The human-readable product property name string.

scales class-attribute instance-attribute

scales: Optional[List[TaxonomyPropertyScale]] = None

A list of available scales.

is_required class-attribute instance-attribute

is_required: Optional[bool] = None

When true, listings assigned eligible taxonomy IDs require this property.

supports_attributes class-attribute instance-attribute

supports_attributes: Optional[bool] = None

When true, you can use this property in listing attributes.

supports_variations class-attribute instance-attribute

supports_variations: Optional[bool] = None

When true, you can use this property in listing variations.

is_multivalued class-attribute instance-attribute

is_multivalued: Optional[bool] = None

When true, you can assign multiple property values to this property

possible_values class-attribute instance-attribute

possible_values: Optional[List[TaxonomyPropertyValue]] = None

A list of supported property value strings for this property.

selected_values class-attribute instance-attribute

selected_values: Optional[List[TaxonomyPropertyValue]] = None

A list of property value strings automatically and always selected for the given property.

TaxonomyPropertyScale dataclass

TaxonomyPropertyScale(scale_id: Optional[int] = None, display_name: Optional[str] = None, description: Optional[str] = None)

Definition: TaxonomyPropertyScale

Attributes

scale_id class-attribute instance-attribute

scale_id: Optional[int] = None

The unique numeric ID of a scale.

display_name class-attribute instance-attribute

display_name: Optional[str] = None

The name string for a scale.

description class-attribute instance-attribute

description: Optional[str] = None

The description string for a scale.

TaxonomyPropertyValue dataclass

TaxonomyPropertyValue(value_id: Optional[int] = None, name: Optional[str] = None, scale_id: Optional[int] = None, equal_to: Optional[List[int]] = None)

Definition: TaxonomyPropertyValue

Attributes

value_id class-attribute instance-attribute

value_id: Optional[int] = None

The numeric ID of this property value.

name class-attribute instance-attribute

name: Optional[str] = None

The name string of this property value.

scale_id class-attribute instance-attribute

scale_id: Optional[int] = None

The numeric scale ID of the scale to which this property value belongs.

equal_to class-attribute instance-attribute

equal_to: Optional[List[int]] = None

A list of numeric property value IDs this property value is equal to (if any).

ShippingCarrier dataclass

ShippingCarrier(shipping_carrier_id: Optional[int] = None, name: Optional[str] = None, domestic_classes: Optional[List[ShippingCarrierMailClass]] = None, international_classes: Optional[List[ShippingCarrierMailClass]] = None)

Definition: ShippingCarrier

Attributes

shipping_carrier_id class-attribute instance-attribute

shipping_carrier_id: Optional[int] = None

The numeric ID of this shipping carrier.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this shipping carrier.

domestic_classes class-attribute instance-attribute

domestic_classes: Optional[List[ShippingCarrierMailClass]] = None

Set of domestic mail classes of this shipping carrier.

international_classes class-attribute instance-attribute

international_classes: Optional[List[ShippingCarrierMailClass]] = None

Set of international mail classes of this shipping carrier.

ShippingCarrierMailClass dataclass

ShippingCarrierMailClass(mail_class_key: Optional[str] = None, name: Optional[str] = None)

Definition: ShippingCarrierMailClass

Attributes

mail_class_key class-attribute instance-attribute

mail_class_key: Optional[str] = None

The unique identifier of this mail class.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this mail class.

ShopProductionPartners dataclass

ShopProductionPartners(count: Optional[int] = None, results: Optional[List[ShopProductionPartner]] = None)

Definition: ShopProductionPartners

Attributes

count class-attribute instance-attribute

count: Optional[int] = None

The number of results.

results class-attribute instance-attribute

results: Optional[List[ShopProductionPartner]] = None

The list of requested resources.

ShopShippingProfiles dataclass

ShopShippingProfiles(count: Optional[int] = None, results: Optional[List[ShopShippingProfile]] = None)

Definition: ShopShippingProfiles

Offering dataclass

Offering(price: Optional[float] = None, quantity: Optional[int] = None, is_enabled: Optional[bool] = None)

Definition: Offering

Attributes

price class-attribute instance-attribute

price: Optional[float] = None

The price of the product.

quantity class-attribute instance-attribute

quantity: Optional[int] = None

How many of this product are available?

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = None

True if the offering is shown to buyers

Product dataclass

Product(sku: Optional[str] = None, property_values: Optional[List[PropertyValue]] = None, offerings: Optional[List[Offering]] = None)

Definition: Product

Attributes

sku class-attribute instance-attribute

sku: Optional[str] = None

The SKU string for the product

property_values class-attribute instance-attribute

property_values: Optional[List[PropertyValue]] = None

A list of property value entries for this product.

offerings class-attribute instance-attribute

offerings: Optional[List[Offering]] = None

A list of product offering entries for this product.

PropertyValue dataclass

PropertyValue(property_id: Optional[int] = None, value_ids: Optional[List[int]] = None, scale_id: Optional[int] = None, property_name: Optional[str] = None, values: Optional[List[str]] = None)

Definition: PropertyValue

Attributes

property_id class-attribute instance-attribute

property_id: Optional[int] = None

The unique ID of an Etsy listing property.

value_ids class-attribute instance-attribute

value_ids: Optional[List[int]] = None

An array of unique IDs of multiple Etsy listing property values. For example, if your listing offers different sizes of a product, then the value ID list contains value IDs for each size.

scale_id class-attribute instance-attribute

scale_id: Optional[int] = None

The numeric ID of a single Etsy.com measurement scale. For example, for shoe size, there are three scale_ids available - UK, US/Canada, and EU, where US/Canada has scale_id 19.

property_name class-attribute instance-attribute

property_name: Optional[str] = None

The name of the property, in the requested locale language.

values class-attribute instance-attribute

values: Optional[List[str]] = None

A list of property value entries for this product.

ApplicationListingsInventoryRequest dataclass

ApplicationListingsInventoryRequest(products: Optional[List[Product]] = None, price_on_property: Optional[List[int]] = None, quantity_on_property: Optional[List[int]] = None, sku_on_property: Optional[List[int]] = None)

Definition: V3ApplicationListingsInventoryRequest

Attributes

products class-attribute instance-attribute

products: Optional[List[Product]] = None

A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.

price_on_property class-attribute instance-attribute

price_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size.

quantity_on_property class-attribute instance-attribute

quantity_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color.

sku_on_property class-attribute instance-attribute

sku_on_property: Optional[List[int]] = None

An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for different colored products in the same listing, then this array contains the property ID for color.

ApplicationShopsListingsVariationImagesRequest dataclass

ApplicationShopsListingsVariationImagesRequest(variation_images: Optional[List[VariationImage]] = None)

Definition: V3ApplicationShopsListingsVariationImagesRequest

Attributes

variation_images class-attribute instance-attribute

variation_images: Optional[List[VariationImage]] = None

A list of variation image data.

VariationImage dataclass

VariationImage(property_id: Optional[int] = None, value_id: Optional[int] = None, image_id: Optional[int] = None)

Definition: VariationImage

EtsyClient

EtsyClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for etsy connector.

Initialize a EtsyClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

ping_async async

ping_async() -> dict[str, Any] | None

Ping

Check to confirm connectivity to the Etsy API with an application.

payment_ledger_entries_async async

payment_ledger_entries_async(shop_id: int, min_created: int, max_created: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get a shop payment account ledger's entries

Retrieve the entries of a shop's payment account ledger.

payment_get_entry_id_async async

payment_get_entry_id_async(shop_id: int, ledger_entry_ids: str) -> dict[str, Any] | None

Get a payment from a payment account ledger entry ID

Get a Payment from a Payment Account Ledger Entry ID, if applicable.

payment_get_receipt_async async

payment_get_receipt_async(shop_id: int, receipt_id: str) -> dict[str, Any] | None

Get a payment from a specific receipt

Retrieves a payment from a specific receipt, identified by receipt ID, from a specific shop, identified by shop ID.

payments_get_async async

payments_get_async(shop_id: int, payment_ids: str) -> dict[str, Any] | None

Get a list of payments

Retrieves a list of payments from a shop identified by shop ID. You can also filter results using a list of payment IDs.

receipt_get_async async

receipt_get_async(shop_id: int, receipt_id: int) -> dict[str, Any] | None

Get a receipt

Retrieves a receipt, identified by a receipt ID, from an Etsy shop.

receipts_get_async async

receipts_get_async(shop_id: int, min_created: Optional[int] = None, max_created: Optional[int] = None, min_last_modified: Optional[int] = None, max_last_modified: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None, was_paid: Optional[bool] = None, was_shipped: Optional[bool] = None) -> dict[str, Any] | None

Get receipts

Requests the shop receipts from a specific shop, unfiltered or filtered by receipt ID range or offset, date, paid, and/or shipped purchases.

receipt_create_shipment_async async

receipt_create_shipment_async(input: ReceiptCreateShipmentInput, shop_id: int, receipt_id: int) -> dict[str, Any] | None

Create a Shipment Receipt

Submits tracking information for a shop receipt, which creates a shop receipt Shipment entry for the given receipt ID. Each time you successfully submit tracking info, Etsy sends a notification email to the buyer User. When send BCC is true, Etsy sends shipping notifications to the seller as well. When tracking code and carrier name aren't sent, the receipt is marked as shipped only.

transactions_listing_async async

transactions_listing_async(shop_id: int, listing_id: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Retrieve a listing's transactions

Retrieves the list of transactions associated with a listing.

transaction_receipt_async async

transaction_receipt_async(shop_id: int, receipt_id: int) -> dict[str, Any] | None

Get a receipt's transaction

Retrieves the list of transactions associated with a specific receipt.

transaction_get_async async

transaction_get_async(shop_id: int, transaction_id: int) -> dict[str, Any] | None

Get a transaction

Retrieves a transaction by transaction ID.

transaction_get_shop_async async

transaction_get_shop_async(shop_id: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get a shop's transaction

Retrieves the list of transactions associated with a shop.

reviews_get_async async

reviews_get_async(shop_id: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get reviews

Retrieves the reviews from a shop given its ID.

shipping_carriers_async async

shipping_carriers_async(origin_country_iso: str) -> dict[str, Any] | None

Get shipping carriers

Retrieves a list of available shipping carriers and the mail classes associated with them for a given country.

shipping_profiles_async async

shipping_profiles_async(shop_id: int) -> dict[str, Any] | None

Get shipping profiles

Retrieves a list of shipping profiles available in the specific Etsy shop identified by its shop ID.

shipping_create_profile_async async

shipping_create_profile_async(input: ShippingCreateProfileInput, shop_id: int) -> dict[str, Any] | None

Create a shipping profile

Creates a new shipping profile. You can pass a country ISO code or a region when creating a shipping profile, but not both. Only one is required. You must pass either a shipping carrier ID and mail class, or both min and max delivery days.

shipping_get_profile_async async

shipping_get_profile_async(shop_id: int, shipping_profile_id: int) -> None

Get a shipping profile

Retrieves a shipping profile referenced by shipping profile ID.

shipping_delete_profile_async async

shipping_delete_profile_async(shop_id: int, shipping_profile_id: int) -> dict[str, Any] | None

Delete a shipping profile

Deletes a shipping profile by given ID.

shipping_update_profile_async async

shipping_update_profile_async(input: ShippingUpdateProfileInput, shop_id: int, shipping_profile_id: int) -> dict[str, Any] | None

Update a shipping profile

Changes the settings in a shipping profile.

shipping_get_destinations_async async

shipping_get_destinations_async(shop_id: int, shipping_profile_id: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get profile destinations by shipping profile

Retrieves a list of shipping destination objects associated with a shipping profile.

shipping_create_destination_async async

shipping_create_destination_async(input: ShippingCreateDestinationInput, shop_id: int, shipping_profile_id: int) -> dict[str, Any] | None

Create a shipping profile destination

Creates a new shipping destination, which sets the shipping cost, carrier, and class for a destination in a shipping profile. This assigns costs using the currency of the associated shop. Set the destination using either destination country ISO or destination region; destination country ISO and destination region are mutually exclusive - set one or the other. Setting both triggers error 400. If the request sets neither destination country ISO nor destination region, the default destination is everywhere. You must also either assign both a shipping carrier ID and mail class or both min delivery days and max delivery days.

shipping_delete_profile_destination_async async

shipping_delete_profile_destination_async(shop_id: int, shipping_profile_id: int, shipping_profile_destination_id: int) -> None

Delete a shipping profile destination

Deletes a shipping destination and removes the destination option from every listing that uses the associated shipping profile. A shipping profile requires at least one shipping destination, so this endpoint cannot delete the final shipping destination for any shipping profile. To delete the final shipping destination from a shipping profile, you must delete the entire shipping profile.

shipping_update_profile_destination_async async

shipping_update_profile_destination_async(input: ShippingUpdateProfileDestinationInput, shop_id: int, shipping_profile_id: str, shipping_profile_destination_id: str) -> dict[str, Any] | None

Update a shipping profile destination

Updates an existing shipping destination, which can set or reassign the shipping cost, carrier, and class for a destination.

shipping_get_profile_upgrades_async async

shipping_get_profile_upgrades_async(shop_id: int, shipping_profile_id: int) -> dict[str, Any] | None

Get shipping profile upgrades

Retrieves the list of shipping profile upgrades assigned to a specific shipping profile.

shipping_create_upgrade_async async

shipping_create_upgrade_async(input: ShippingCreateUpgradeInput, shop_id: int, shipping_profile_id: int) -> dict[str, Any] | None

Create a shipping profile upgrade

Creates a new shipping profile upgrade, which can establish a price for a shipping option, such as an alternate carrier or faster delivery.

shipping_delete_profile_upgrade_async async

shipping_delete_profile_upgrade_async(shop_id: int, shipping_profile_id: int, upgrade_id: int) -> None

Delete a shipping profile upgrade

Deletes a shipping profile upgrade and removes the upgrade option from every listing that uses the associated shipping profile.

shipping_update_profile_upgrade_async async

shipping_update_profile_upgrade_async(input: ShippingUpdateProfileUpgradeInput, shop_id: int, shipping_profile_id: int, upgrade_id: int) -> dict[str, Any] | None

Update a shipping profile upgrade

Updates a shipping profile upgrade and updates any listings that use the shipping profile.

shop_update_async async

shop_update_async(input: ShopUpdateInput, shop_id: int) -> dict[str, Any] | None

Update a shop

Update a shop. Assumes that all string parameters are provided in the shop's primary language.

shop_get_by_owner_id_async async

shop_get_by_owner_id_async(user_id: str) -> dict[str, Any] | None

Get shop by owner ID

Retrieves the shop identified by the shop owner's user ID.

shop_search_async async

shop_search_async(shop_name: str, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Search shops

Returns a list of shops with the matching name.

shop_get_sections_async async

shop_get_sections_async(shop_id: int) -> dict[str, Any] | None

Get shop sections

Retrieves the list of shop sections in a specific shop identified by shop ID.

shop_create_section_async async

shop_create_section_async(input: ShopCreateSectionInput, shop_id: int) -> dict[str, Any] | None

Create a shop section

Creates a new section in a specific shop.

user_get_async async

user_get_async(user_id: int) -> dict[str, Any] | None

Get user

Returns user profile for the user identified by a user ID.

shop_get_section_async async

shop_get_section_async(shop_id: int, shop_section_id: int) -> dict[str, Any] | None

Get shop section

Retrieves a shop section, referenced by section ID and shop ID.

user_get_address_async async

user_get_address_async(user_address_id: int) -> dict[str, Any] | None

Get user's address

Retrieves the user's address. Development for this endpoint is in progress. It will only return a 501 response.

user_get_addresses_async async

user_get_addresses_async(limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get user addresses

Retrieve a list of user addresses.

listing_get_taxonomy_nodes_async async

listing_get_taxonomy_nodes_async() -> dict[str, Any] | None

Get seller taxonomy nodes

Retrieves the full hierarchy tree of seller taxonomy nodes.

listing_get_properties_by_taxonomy_async async

listing_get_properties_by_taxonomy_async(taxonomy_id: str) -> dict[str, Any] | None

Get product properties by taxonomy ID

Retrieves a list of product properties, with applicable scales and values, supported for a specific seller taxonomy ID.

listing_get_shop_async async

listing_get_shop_async(shop_id: int, state: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort_on: Optional[str] = None, sort_order: Optional[str] = None) -> dict[str, Any] | None

Get listings by shop

Returns listings that belong to a Shop. Listings can be filtered using the state parameter.

listing_create_async async

listing_create_async(input: ListingCreateInput, shop_id: int) -> dict[str, Any] | None

Create a draft listing

Creates a physical draft listing product in a shop on the Etsy channel.

listing_get_async async

listing_get_async(listing_id: int, includes: Optional[str] = None) -> None

Get a listing

Retrieves a listing record by listing ID.

listing_delete_async async

listing_delete_async(listing_id: int) -> None

Delete a listing

This action deletes a shop listing. A listing can be deleted only if the state is one of the following: SOLD_OUT, DRAFT, EXPIRED, INACTIVE, ACTIVE and is_available or ACTIVE and has seller flags: SUPRESSED (frozen), VACATION, CUSTOM_SHOPS (pattern), SELL_ON_FACEBOOK

listing_get_active_async async

listing_get_active_async(limit: Optional[int] = None, offset: Optional[int] = None, keywords: Optional[str] = None, sort_on: Optional[str] = None, sort_order: Optional[str] = None, min_price: Optional[float] = None, max_price: Optional[float] = None, taxonomy_id: Optional[int] = None, shop_location: Optional[str] = None) -> dict[str, Any] | None

Get active listings

A list of all active listings on Etsy paginated by their creation date. Without sort order listings will be returned newest-first by default.

listing_get_active_by_shop_async async

listing_get_active_by_shop_async(shop_id: int, limit: Optional[int] = None, offset: Optional[int] = None, keywords: Optional[str] = None) -> dict[str, Any] | None

Get active listings by shop

Retrieves a list of all active listings on Etsy in a specific shop, paginated by listing creation date.

listing_get_by_id_async async

listing_get_by_id_async(listing_ids: str, includes: Optional[str] = None) -> dict[str, Any] | None

Get listings by ID

Allows to query multiple listing IDs at once. Limit 100 IDs maximum per query.

listing_get_featured_async async

listing_get_featured_async(shop_id: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get featured listings by shop

Retrieves listings associated to a shop that are featured.

listing_delete_property_async async

listing_delete_property_async(shop_id: int, listing_id: int, property_id: int) -> None

Delete a listing property

Deletes a property from a listing.

listing_update_property_async async

listing_update_property_async(input: ListingUpdatePropertyInput, shop_id: int, listing_id: int, property_id: int) -> dict[str, Any] | None

Update a listing property

Updates or populates the properties list defining product offerings for a listing. Each offering requires both a value and a value ID that are valid for a scale ID assigned to the listing or that you assign to the listing with this request.

listing_get_property_async async

listing_get_property_async(listing_id: int, property_id: int) -> dict[str, Any] | None

Get a listing's property (Beta)

Retrieves a listing's property. Development for this endpoint is in progress. It will only return a 501 response.

listing_get_properties_async async

listing_get_properties_async(shop_id: int, listing_id: int) -> dict[str, Any] | None

Get a listing's properties

Returns a list of a listing's properties.

listing_update_async async

listing_update_async(input: ListingUpdateInput, shop_id: int, listing_id: int) -> dict[str, Any] | None

Update a listing

Updates a listing, identified by a listing ID, for a specific shop identified by a shop ID.

listing_get_by_receipt_async async

listing_get_by_receipt_async(shop_id: int, receipt_id: int, limit: Optional[int] = None, offset: Optional[int] = None) -> dict[str, Any] | None

Get listings by shop receipt

Gets all listings associated with a receipt.

listing_get_by_section_id_async async

listing_get_by_section_id_async(shop_id: int, shop_section_ids: str, limit: Optional[int] = None, offset: Optional[int] = None, sort_on: Optional[str] = None, sort_order: Optional[str] = None) -> dict[str, Any] | None

Get listings by shop section ID

Retrieves all the listings from the section of a specific shop.

listing_get_file_async async

listing_get_file_async(shop_id: int, listing_id: int, listing_file_id: int) -> dict[str, Any] | None

Get a file from a listing

Retrieves a single file associated with the given digital listing. Requesting a file from a physical listing returns an empty result.

listing_delete_file_async async

listing_delete_file_async(shop_id: int, listing_id: int, listing_file_id: int) -> None

Delete a file from listing

When you delete the final file for a digital listing, the listing converts into a physical listing. The response to a delete request returns a list of the remaining file records associated with the given listing.

listing_get_files_async async

listing_get_files_async(shop_id: int, listing_id: int) -> dict[str, Any] | None

Get all listing files

Retrieves all the files associated with the given digital listing. Requesting files from a physical listing returns an empty result.

listing_upload_async async

listing_upload_async(input: ListingUploadInput, shop_id: int, listing_id: int) -> dict[str, Any] | None

Upload a listing file

Uploads a new file for a digital listing, or associates an existing file with a specific listing. You must either provide the listing file ID of an existing file, or the name and binary file data for a file to upload. Associating an existing file to a physical listing converts the physical listing into a digital listing, which removes all shipping costs and any product and inventory variations.

listing_get_image_async async

listing_get_image_async(shop_id: int, listing_id: int, listing_image_id: int) -> dict[str, Any] | None

Get a listing image

Retrieves the references and metadata for a listing image with a specific image ID.

listing_delete_image_async async

listing_delete_image_async(shop_id: int, listing_id: int, listing_image_id: int) -> None

Delete a listing image

Deletes a listing image. A copy of the file remains on our servers, and so a deleted image may be re-associated with the listing without re-uploading the original image.

listing_get_images_async async

listing_get_images_async(shop_id: int, listing_id: int) -> dict[str, Any] | None

Get a listing's images

Retrieves all listing image resources for a listing with a specific listing ID.

listing_upload_image_async async

listing_upload_image_async(input: ListingUploadImageInput, shop_id: int, listing_id: int) -> dict[str, Any] | None

Upload a listing image

Uploads or assigns an image to a listing identified by a shop ID with a listing ID. To upload a new image, set the image file as the value for the image parameter. You can assign a previously deleted image to a listing using the deleted image's image ID in the listing image ID parameter. When a request contains both image and listing image ID parameter values, the endpoint uploads the image in the image parameter only.

listing_get_inventory_async async

listing_get_inventory_async(listing_id: int, includes: Optional[str] = None) -> dict[str, Any] | None

Get a listing's inventory

Retrieves the inventory record for a listing. Listings you did not edit using the Etsy.com inventory tools have no inventory records. This endpoint returns SKU data if you are the owner of the inventory records being fetched.

listing_update_inventory_async async

listing_update_inventory_async(input: ListingUpdateInventoryInput, listing_id: str) -> dict[str, Any] | None

Update a listing's inventory

Updates the inventory for a listing identified by a listing ID. The update fails if the supplied values for product SKU, offering quantity, and/or price are incompatible with values in on property fields. When setting a price, assign a float equal to amount divided by divisor as specified in the money resource.

listing_get_offering_async async

listing_get_offering_async(listing_id: int, product_id: int, product_offering_id: int) -> dict[str, Any] | None

Get a listing's offering

Get an offering for a listing.

listing_get_product_async async

listing_get_product_async(listing_id: int, product_id: int) -> dict[str, Any] | None

Get a listing's product

Retrieve a listing product by ID.

listing_get_translation_async async

listing_get_translation_async(shop_id: int, listing_id: int, language: str) -> dict[str, Any] | None

Get a listing's translation

Returns the translation for a listing in the given language.

listing_create_translation_async async

listing_create_translation_async(input: ListingCreateTranslationInput, shop_id: int, listing_id: int, language: str) -> dict[str, Any] | None

Create a listing translation

Creates a listing translation by listing ID and language.

listing_update_translation_async async

listing_update_translation_async(input: ListingUpdateTranslationInput, shop_id: int, listing_id: int, language: str) -> dict[str, Any] | None

Update a listing translation

Updates a listing translation by listing ID and language.

listing_get_variation_async async

listing_get_variation_async(shop_id: int, listing_id: int) -> dict[str, Any] | None

Get listing's variation images

Gets all variation images on a listing.

listing_update_variation_async async

listing_update_variation_async(input: ListingUpdateVariationInput, shop_id: int, listing_id: int) -> dict[str, Any] | None

Update a listing's variation images

Creates variation images on a listing.