EtsyClient
Attributes
module-attribute
module-attribute
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']
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']
module-attribute
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']
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']
Classes
dataclass
dataclass
PaymentAccountLedgerEntries(count: int, results: List[PaymentAccountLedgerEntry | Mapping[str, Any]])
Response for Get a shop payment account ledger's entries
dataclass
dataclass
ShopReceipt(receipt_id: int, receipt_type: int, seller_user_id: int, seller_email: str, buyer_user_id: int, buyer_email: str, name: str, first_line: str, second_line: str, city: str, state: str, zip: str, formatted_address: str, country_iso: str, payment_method: str, payment_email: str, message_from_seller: str, message_from_buyer: str, message_from_payment: str, is_paid: bool, is_shipped: bool, create_timestamp: int, update_timestamp: int, gift_message: str, grandtotal: Money | Mapping[str, Any], subtotal: Money | Mapping[str, Any], total_price: Money | Mapping[str, Any], total_shipping_cost: Money | Mapping[str, Any], total_tax_cost: Money | Mapping[str, Any], total_vat_cost: Money | Mapping[str, Any], discount_amt: Money | Mapping[str, Any], gift_wrap_price: Money | Mapping[str, Any], shipments: List[ShopReceiptShipment | Mapping[str, Any]])
Response for Get a receipt
Attributes
instance-attribute
The numeric ID for the receipt associated to this transaction.
instance-attribute
The numeric value for the Etsy channel that serviced the purchase: 0 for Etsy.com, 1 for a Pattern shop.
instance-attribute
The numeric ID for the user (seller) fulfilling the purchase.
instance-attribute
The email address string for the seller of the listing.
instance-attribute
The numeric ID for the user making the purchase.
instance-attribute
The email address string for the buyer of the listing.
instance-attribute
The first address line string for the recipient in the shipping address.
instance-attribute
The optional second address line string for the recipient in the shipping address.
instance-attribute
The zip code string (not necessarily a number) for the recipient in the shipping address.
instance-attribute
The formatted shipping address string for the recipient in the shipping address.
instance-attribute
The ISO-3166 alpha-2 country code string for the recipient in the shipping address.
instance-attribute
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).
instance-attribute
The email address string for the email address to which to send payment confirmation
instance-attribute
An optional message string from the seller.
instance-attribute
An optional message string from the buyer.
instance-attribute
The machine-generated acknowledgement string from the payment system.
instance-attribute
The receipt's creation time, in epoch seconds.
instance-attribute
The time of the last update to the receipt, in epoch seconds.
instance-attribute
A gift message string the buyer requests delivered with the product.
dataclass
dataclass
ReceiptCreateShipmentInput(*, tracking_code: Optional[str] = None, carrier_name: Optional[str] = None, send_bcc: Optional[bool] = None)
Create a Shipment Receipt
Attributes
class-attribute
instance-attribute
The tracking code for this receipt.
class-attribute
instance-attribute
The carrier name for this receipt.
dataclass
dataclass
ShopReceiptTransaction(transaction_id: int, title: str, description: str, seller_user_id: int, buyer_user_id: int, create_timestamp: int, paid_timestamp: int, shipped_timestamp: int, quantity: int, listing_image_id: int, receipt_id: int, is_digital: bool, file_data: str, listing_id: int, transaction_type: str, product_id: int, price: Money | Mapping[str, Any], shipping_cost: Money | Mapping[str, Any])
Response for Get a transaction
Attributes
instance-attribute
The description string of the listing purchased in this transaction.
instance-attribute
The numeric user ID for the seller in this transaction.
instance-attribute
The numeric user ID for the buyer in this transaction.
instance-attribute
The transaction's creation date and time, in epoch seconds.
instance-attribute
The transaction's paid date and time, in epoch seconds.
instance-attribute
The transaction's shipping date and time, in epoch seconds.
instance-attribute
The numeric quantity of products purchased in this transaction.
instance-attribute
The numeric ID of the primary listing image for this transaction.
instance-attribute
The numeric ID for the receipt associated to this transaction.
instance-attribute
When true, the transaction recorded the purchase of a digital listing.
instance-attribute
A string describing the files purchased in this transaction.
instance-attribute
The numeric ID for the listing associated to this transaction.
instance-attribute
The type string for the transaction, usually listing
dataclass
dataclass
Response for Get shipping carriers
dataclass
ShopShippingProfile(shipping_profile_id: int, title: str, user_id: int, min_processing_days: int, max_processing_days: int, processing_days_display_label: str, origin_country_iso: str, is_deleted: bool, shipping_profile_destinations: List[ShopShippingProfileDestination | Mapping[str, Any]], shipping_profile_upgrades: List[ShopShippingProfileUpgrade | Mapping[str, Any]], origin_postal_code: str, *, profile_type: Optional[ProfileType] = None)
Response for Get shipping profiles
Attributes
instance-attribute
The numeric ID of the shipping profile.
instance-attribute
The minimum number of days for processing the listing.
instance-attribute
The maximum number of days for processing the listing.
instance-attribute
Translated display label string for processing days.
instance-attribute
The ISO code of the country from which the listing ships.
instance-attribute
A list of shipping profile destinations available for this shipping profile.
instance-attribute
A list of shipping profile upgrades available for this shipping profile.
dataclass
ShippingCreateProfileInput(title: str, origin_country_iso: str, primary_cost: float, secondary_cost: float, min_processing_time: int, max_processing_time: int, *, 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
instance-attribute
The ISO code of the country from which the listing ships.
instance-attribute
The cost of shipping to this country/region alone, measured in the store's default currency.
instance-attribute
The cost of shipping to this country/region with another item, measured in the store's default currency.
instance-attribute
The minimum time required to process to ship listings with this shipping profile.
instance-attribute
The maximum processing time the listing needs to ship.
class-attribute
instance-attribute
The unit used to represent how long a processing time is. A week is equivalent to 5 business days.
class-attribute
instance-attribute
The ISO code of the country to which the listing ships. If null, request sets destination to destination region.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
The postal code string (not necessarily a number) for the location from which the listing ships.
class-attribute
instance-attribute
The unique ID of a supported shipping carrier, which is used to calculate an estimated delivery date.
class-attribute
instance-attribute
The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.
class-attribute
instance-attribute
The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.
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
class-attribute
instance-attribute
The name string of this shipping profile.
class-attribute
instance-attribute
The ISO code of the country from which the listing ships.
class-attribute
instance-attribute
The minimum time required to process to ship listings with this shipping profile.
class-attribute
instance-attribute
The maximum processing time the listing needs to ship.
class-attribute
instance-attribute
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.
dataclass
dataclass
ShippingCreateDestinationInput(primary_cost: float, secondary_cost: str, *, 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
instance-attribute
The cost of shipping to this country/region alone, measured in the store's default currency.
instance-attribute
The cost of shipping to this country/region with another item, measured in the store's default currency.
class-attribute
instance-attribute
destination_country_iso
class-attribute
instance-attribute
destination_region
class-attribute
instance-attribute
shipping_carrier_id
class-attribute
instance-attribute
mail_class
class-attribute
instance-attribute
min_delivery_days
dataclass
ShopShippingProfileDestination(shipping_profile_destination_id: int, shipping_profile_id: int, origin_country_iso: str, destination_country_iso: str, destination_region: DestinationRegion, primary_cost: Money | Mapping[str, Any], secondary_cost: Money | Mapping[str, Any], shipping_carrier_id: int, mail_class: str, min_delivery_days: int, max_delivery_days: int)
Response for Create a shipping profile destination
Attributes
instance-attribute
The numeric ID of the shipping profile destination in the shipping profile associated with the listing.
instance-attribute
The numeric ID of the shipping profile.
instance-attribute
The ISO code of the country from which the listing ships.
instance-attribute
The ISO code of the country to which the listing ships. If null, request sets destination to destination_region
instance-attribute
The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.
instance-attribute
The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.
instance-attribute
The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.
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
class-attribute
instance-attribute
primary_cost
class-attribute
instance-attribute
secondary_cost
class-attribute
instance-attribute
destination_country_iso
class-attribute
instance-attribute
destination_region
class-attribute
instance-attribute
shipping_carrier_id
class-attribute
instance-attribute
mail_class
class-attribute
instance-attribute
min_delivery_days
dataclass
dataclass
ShippingCreateUpgradeInput(type_: str, upgrade_name: str, price: float, secondary_price: float, *, 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
class-attribute
instance-attribute
The type of the shipping upgrade. Domestic (0) or international (1).
instance-attribute
Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.
instance-attribute
Additional cost of adding the shipping upgrade for each additional item.
class-attribute
instance-attribute
The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.
class-attribute
instance-attribute
The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.
class-attribute
instance-attribute
min_delivery_days
dataclass
ShopShippingProfileUpgrade(shipping_profile_id: int, upgrade_id: int, upgrade_name: str, type_: Type, rank: int, language: str, price: Money | Mapping[str, Any], secondary_price: Money | Mapping[str, Any], shipping_carrier_id: int, mail_class: str, min_delivery_days: int, max_delivery_days: int)
Response for Create a shipping profile upgrade
Attributes
instance-attribute
The numeric ID of the base shipping profile.
instance-attribute
The numeric ID that is associated with a shipping upgrade
instance-attribute
Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.
instance-attribute
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.
instance-attribute
The IETF language tag for the language of the shipping profile. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.
instance-attribute
The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.
instance-attribute
The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.
instance-attribute
The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped.
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
class-attribute
instance-attribute
The type of the shipping upgrade. Domestic (0) or international (1).
class-attribute
instance-attribute
Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.
class-attribute
instance-attribute
Additional cost of adding the shipping upgrade.
class-attribute
instance-attribute
Additional cost of adding the shipping upgrade for each additional item.
class-attribute
instance-attribute
The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date.
class-attribute
instance-attribute
The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date.
class-attribute
instance-attribute
min_delivery_days
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
class-attribute
instance-attribute
A brief heading string for the shop's main page.
class-attribute
instance-attribute
An announcement string to buyers that displays on the shop's homepage.
class-attribute
instance-attribute
A message string sent to users who complete a purchase from this shop.
dataclass
Shop(shop_id: int, user_id: int, shop_name: str, create_date: int, title: str, announcement: str, currency_code: str, is_vacation: bool, vacation_message: str, sale_message: str, digital_sale_message: str, update_date: int, listing_active_count: int, digital_listing_count: int, login_name: str, accepts_custom_requests: bool, policy_welcome: str, policy_payment: str, policy_shipping: str, policy_refunds: str, policy_additional: str, policy_seller_info: str, policy_update_date: int, policy_has_private_receipt_info: bool, has_unstructured_policies: bool, policy_privacy: str, vacation_autoreply: str, url: str, image_url760x100: str, num_favorers: int, languages: List[str], icon_url_fullxfull: str, is_using_structured_policies: bool, has_onboarded_structured_policies: bool, include_dispute_form_link: bool, is_direct_checkout_onboarded: bool, is_calculated_eligible: bool, is_opted_in_to_buyer_promise: bool, is_shop_us_based: bool, transaction_sold_count: int, shipping_from_country_iso: str, shop_location_country_iso: str, review_count: int, review_average: float)
Response for Update a shop
Attributes
instance-attribute
The date and time this shop was created, in epoch seconds.
instance-attribute
An announcement string to buyers that displays on the shop's homepage.
instance-attribute
The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.
instance-attribute
The shop's message string displayed when is_vacation is true.
instance-attribute
A message string sent to users who complete a purchase from this shop.
instance-attribute
A message string sent to users who purchase a digital item from this shop.
instance-attribute
The date and time of the last update to the shop, in epoch seconds.
instance-attribute
The number of active listings in the shop.
instance-attribute
The number of digital listings in the shop.
instance-attribute
When true, the shop accepts customization requests.
instance-attribute
The shop's policy welcome string (may be blank).
instance-attribute
The shop's payment policy string (may be blank).
instance-attribute
The shop's shipping policy string (may be blank).
instance-attribute
The shop's refund policy string (may be blank).
instance-attribute
The shop's additional policies string (may be blank).
instance-attribute
The shop's seller infomation string (may be blank).
instance-attribute
The date and time of the last update to the shop's policies, in epoch seconds.
instance-attribute
When true, EU receipts display private info.
instance-attribute
When true, the shop displays additional unstructured policy fields.
instance-attribute
The shop's privacy policy string (may be blank).
instance-attribute
The shop's automatic reply string displayed in new conversations when is_vacation is true.
class-attribute
instance-attribute
The URL string for this shop's banner image.
instance-attribute
The number of users who marked this shop a favorite.
instance-attribute
A list of language strings for the shop's enrolled languages.
instance-attribute
The URL string for this shop's icon image.
instance-attribute
When true, the shop accepted using structured policies.
instance-attribute
When true, the shop accepted OR declined after viewing structured policies onboarding.
instance-attribute
When true, this shop's policies include a link to an EU online dispute form.
instance-attribute
When true, the shop has onboarded onto Etsy Payments.
instance-attribute
When true, the shop is elegible for calculated shipping profiles. (Only available in the US and Canada)
instance-attribute
When true, the shop opted in to buyer promise.
instance-attribute
The total number of sales transactions for this shop
instance-attribute
The country iso the shop is shipping from.
instance-attribute
The country iso where the shop is located.
instance-attribute
Number of reviews of shop listings in the past year.
dataclass
dataclass
dataclass
dataclass
Response for Create a shop section
Attributes
instance-attribute
The numeric ID of a section in a specific Etsy shop.
instance-attribute
The positive non-zero numeric position of this section in the section display order for a shop, with rank 1 sections appearing first.
dataclass
User(user_id: int, login_name: str, primary_email: str, first_name: str, last_name: str, create_timestamp: int, referred_by_user_id: int, use_new_inventory_endpoints: bool, is_seller: bool, bio: str, gender: str, birth_month: str, birth_day: str, transaction_buy_count: int, transaction_sold_count: int)
Response for Get user
Attributes
instance-attribute
The numeric ID of a user. This number is also a valid shop ID for the user's shop.
instance-attribute
An email address string for the user's primary email address.
instance-attribute
The date and time the user created their account, in epoch seconds.
instance-attribute
The numeric ID of the user who referred this user.
instance-attribute
Deprecated. Always true.
instance-attribute
The number of transactions where the user has bought.
dataclass
UserAddress(user_address_id: int, user_id: int, name: str, first_line: str, second_line: str, city: str, state: str, zip: str, iso_country_code: str, country_name: str, is_default_shipping_address: bool)
Response for Get user's address
Attributes
instance-attribute
The ISO code of the country in this address.
dataclass
dataclass
dataclass
dataclass
dataclass
ListingCreateInput(quantity: int, title: str, description: str, price: float, who_made: str, taxonomy_id: int, shipping_profile_id: int, *, when_made: Optional[str] = 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
instance-attribute
The positive non-zero number of products available for purchase in the listing.
instance-attribute
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.
instance-attribute
A description string of the product for sale in the listing.
instance-attribute
The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.
instance-attribute
An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.
class-attribute
instance-attribute
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'.
instance-attribute
The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop.
instance-attribute
The numeric ID of the shipping profile associated with the listing.
class-attribute
instance-attribute
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)
class-attribute
instance-attribute
The numeric ID of the shop section for this listing.
class-attribute
instance-attribute
The minimum number of days required to process this listing.
class-attribute
instance-attribute
The maximum number of days required to process this listing.
class-attribute
instance-attribute
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)
class-attribute
instance-attribute
A string indicating a person for whom this product would make an appropriate gift.
class-attribute
instance-attribute
A string indicating an occassion for which this product would make an appropriate gift.
class-attribute
instance-attribute
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)
class-attribute
instance-attribute
The numeric weight of the product measured in units set in item weight unit.
class-attribute
instance-attribute
The numeric length of the product measured in units set in item dimensions unit.
class-attribute
instance-attribute
The numeric width of the product measured in units set in 'item dimensions unit'.
class-attribute
instance-attribute
The numeric height of the product measured in units set in 'item dimensions unit'.
class-attribute
instance-attribute
A string defining the units used to measure the weight of the product.
class-attribute
instance-attribute
A string defining the units used to measure the dimensions of the product.
class-attribute
instance-attribute
When true, this listing is personalizable.
class-attribute
instance-attribute
An array of numeric image IDs of the images in a listing, which can include up to 10 images.
class-attribute
instance-attribute
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'.
class-attribute
instance-attribute
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.
dataclass
ShopListing(listing_id: int, user_id: int, shop_id: int, title: str, description: str, state: State, creation_timestamp: int, ending_timestamp: int, original_creation_timestamp: int, last_modified_timestamp: int, state_timestamp: int, quantity: int, shop_section_id: int, featured_rank: int, url: str, num_favorers: int, non_taxable: bool, is_customizable: bool, is_personalizable: bool, personalization_is_required: bool, personalization_char_count_max: int, personalization_instructions: str, listing_type: bool, tags: List[str], materials: List[str], shipping_profile_id: int, processing_min: int, processing_max: int, who_made: WhoMade, when_made: WhenMade, is_supply: bool, item_weight: float, item_weight_unit: ItemWeightUnit, item_length: float, item_width: float, item_height: float, item_dimensions_unit: ItemDimensionsUnit, is_private: bool, recipient: Recipient, occasion: Occasion, style: List[str], file_data: str, has_variations: bool, should_auto_renew: bool, language: str, price: Money | Mapping[str, Any], taxonomy_id: int)
Response for Create a draft listing
Attributes
instance-attribute
The numeric ID for the listing associated to this transaction.
instance-attribute
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.
instance-attribute
A description string of the product for sale in the listing.
instance-attribute
The listing's creation time, in epoch seconds.
instance-attribute
The listing's expiration time, in epoch seconds.
instance-attribute
The listing's creation time, in epoch seconds.
instance-attribute
The time of the last update to the listing, in epoch seconds.
instance-attribute
The date and time of the last state change of this listing.
instance-attribute
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.
instance-attribute
The numeric ID of a section in a specific Etsy shop.
instance-attribute
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.
instance-attribute
The number of users who marked this listing a favorite.
instance-attribute
When true, applicable shop tax rates do not apply to this listing at checkout.
instance-attribute
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.
instance-attribute
When true, this listing is personalizable. The default value is null.
instance-attribute
When true, this listing requires personalization. The default value is null.
instance-attribute
This an integer value representing the maximum length for the personalization message entered by the buyer.
instance-attribute
When true, this listing requires personalization. The default value is null.
instance-attribute
An enumerated type string that indicates whether the listing is physical or a digital download.
instance-attribute
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.
instance-attribute
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.
instance-attribute
The numeric ID of the shipping profile associated with the listing.
instance-attribute
The minimum number of days required to process this listing. Default value is null.
instance-attribute
The maximum number of days required to process this listing. Default value is null.
instance-attribute
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'.
instance-attribute
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.
instance-attribute
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.
instance-attribute
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.
instance-attribute
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.
instance-attribute
When true, this is a private listing intendend for a specific buyer and hidden from shop view.
instance-attribute
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.
instance-attribute
A string describing the files attached to a digital listing.
instance-attribute
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.
instance-attribute
The IETF language tag for the default language of the listing. Ex: de,
en, es, fr, it, ja, nl, pl, pt, ru.
dataclass
dataclass
Update a listing property
Attributes
instance-attribute
An array of value strings for multiple Etsy listing property values.
dataclass
ListingPropertyValue(property_id: int, property_name: str, scale_id: int, scale_name: str, value_ids: List[int], values: List[str])
Response for Update a listing property
Attributes
dataclass
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
class-attribute
instance-attribute
The positive non-zero number of products available for purchase in the listing.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
A description string of the product for sale in the listing.
class-attribute
instance-attribute
The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.
class-attribute
instance-attribute
An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.
class-attribute
instance-attribute
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'.
class-attribute
instance-attribute
The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop.
class-attribute
instance-attribute
The numeric ID of the shipping profile associated with the listing.
class-attribute
instance-attribute
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)
class-attribute
instance-attribute
The numeric ID of the shop section for this listing.
class-attribute
instance-attribute
The minimum number of days required to process this listing.
class-attribute
instance-attribute
The maximum number of days required to process this listing.
class-attribute
instance-attribute
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)
class-attribute
instance-attribute
A string indicating a person for whom this product would make an appropriate gift.
class-attribute
instance-attribute
A string indicating an occassion for which this product would make an appropriate gift.
class-attribute
instance-attribute
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)
class-attribute
instance-attribute
The numeric weight of the product measured in units set in item weight unit.
class-attribute
instance-attribute
The numeric length of the product measured in units set in item dimensions unit.
class-attribute
instance-attribute
The numeric width of the product measured in units set in 'item dimensions unit'.
class-attribute
instance-attribute
The numeric height of the product measured in units set in 'item dimensions unit'.
class-attribute
instance-attribute
A string defining the units used to measure the weight of the product.
class-attribute
instance-attribute
A string defining the units used to measure the dimensions of the product.
class-attribute
instance-attribute
When true, this listing is personalizable.
class-attribute
instance-attribute
An array of numeric image IDs of the images in a listing, which can include up to 10 images.
class-attribute
instance-attribute
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'.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
When true, applicable shop tax rates apply to this listing at checkout.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
Indicates whether the listing is physical or a digital download.
dataclass
ShopListingFile(listing_file_id: int, listing_id: int, rank: int, filename: str, filesize: str, size_bytes: int, filetype: str, create_timestamp: int)
Response for Get a file from a listing
Attributes
instance-attribute
The unique numeric ID of a file associated with a digital listing.
instance-attribute
The numeric ID for the listing associated to this transaction.
instance-attribute
The numeric index of the display order position of this file in the listing, starting at 1.
instance-attribute
The file name string for a file associated with a digital listing.
instance-attribute
A human-readable format size string for the size of a file.
instance-attribute
A number indicating the size of a file, measured in bytes.
dataclass
dataclass
ListingUploadInput(file: str, *, listing_file_id: Optional[int] = None, name: Optional[str] = None, rank: Optional[int] = None)
Upload a listing file
Attributes
class-attribute
instance-attribute
The unique numeric ID of a file associated with a digital listing.
class-attribute
instance-attribute
The file name string of a file to upload
dataclass
ListingImage(listing_id: int, listing_image_id: int, hex_code: str, red: int, green: int, blue: int, hue: int, saturation: int, brightness: int, is_black_and_white: bool, creation_tsz: int, rank: int, url75x75: str, url170x135: str, url570x_n: str, url_fullxfull: str, full_height: int, full_width: int)
Response for Get a listing image
Attributes
instance-attribute
The numeric ID for the listing associated to this transaction.
instance-attribute
The numeric ID of the primary listing image for this transaction.
instance-attribute
The webhex string for the image's average color, in webhex notation.
instance-attribute
The numeric red value equal to the image's average red value, from 0-255 (RGB color).
instance-attribute
The numeric red value equal to the image's average red value, from 0-255 (RGB color).
instance-attribute
The numeric red value equal to the image's average red value, from 0-255 (RGB color).
instance-attribute
The numeric hue equal to the image's average hue, from 0-360 (HSV color).
instance-attribute
The numeric saturation equal to the image's average saturation, from 0-100 (HSV color).
instance-attribute
The numeric brightness equal to the image's average brightness, from 0-100 (HSV color).
instance-attribute
When true, the image is in black & white.
instance-attribute
The listing image's creation time, in epoch seconds.
instance-attribute
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.
class-attribute
instance-attribute
The url string for a 75x75 pixel thumbnail of the image.
class-attribute
instance-attribute
The url string for a 170x135 pixel thumbnail of the image.
class-attribute
instance-attribute
The url string for a thumbnail of the image, no more than 570 pixels wide with variable height.
instance-attribute
The url string for the full-size image, up to 3000 pixels in each dimension.
instance-attribute
The numeric height, measured in pixels, of the full-sized image referenced in url_fullxfull.
dataclass
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
class-attribute
instance-attribute
The file name string of a file to upload.
class-attribute
instance-attribute
The numeric ID of the primary listing image for this transaction.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
When true, this request replaces the existing image at a given rank.
dataclass
ListingInventoryWithAssociations(products: List[ListingInventoryProduct | Mapping[str, Any]], price_on_property: List[int], quantity_on_property: List[int], sku_on_property: List[int], listing: ShopListing | Mapping[str, Any])
Response for Get a listing's inventory
Attributes
instance-attribute
A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
instance-attribute
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.
instance-attribute
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.
instance-attribute
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.
dataclass
ListingUpdateInventoryInput(products: str, *, price_on_property: Optional[str] = None, quantity_on_property: Optional[str] = None, sku_on_property: Optional[str] = None)
Update a listing's inventory
Attributes
instance-attribute
A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
dataclass
ListingInventory(products: List[ListingInventoryProduct | Mapping[str, Any]], price_on_property: List[int], quantity_on_property: List[int], sku_on_property: List[int])
Response for Update a listing's inventory
Attributes
instance-attribute
A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
instance-attribute
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.
instance-attribute
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.
instance-attribute
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.
dataclass
ListingInventoryProductOffering(offering_id: int, quantity: int, is_enabled: bool, is_deleted: bool, price: Money | Mapping[str, Any])
Response for Get a listing's offering
Attributes
dataclass
ListingInventoryProduct(product_id: int, sku: str, is_deleted: bool, offerings: List[ListingInventoryProductOffering | Mapping[str, Any]], property_values: List[ListingPropertyValue | Mapping[str, Any]])
Response for Get a listing's product
Attributes
instance-attribute
The numeric ID for a specific product purchased from a listing.
instance-attribute
A list of product offering entries for this product.
dataclass
Response for Get a listing's translation
Attributes
instance-attribute
The IETF language tag (e.g. 'fr') for the language of this translation.
dataclass
Create a listing translation
Attributes
dataclass
Update a listing translation
Attributes
dataclass
dataclass
dataclass
dataclass
dataclass
ShopListingWithAssociations(listing_id: int, user_id: int, shop_id: int, title: str, description: str, state: State, creation_timestamp: int, ending_timestamp: int, original_creation_timestamp: int, last_modified_timestamp: int, state_timestamp: int, quantity: int, shop_section_id: int, featured_rank: int, url: str, num_favorers: int, non_taxable: bool, is_customizable: bool, is_personalizable: bool, personalization_is_required: bool, personalization_char_count_max: int, personalization_instructions: str, listing_type: bool, tags: List[str], materials: List[str], shipping_profile_id: int, processing_min: int, processing_max: int, who_made: WhoMade, when_made: WhenMade, is_supply: bool, item_weight: float, item_weight_unit: ItemWeightUnit, item_length: float, item_width: float, item_height: float, item_dimensions_unit: ItemDimensionsUnit, is_private: bool, recipient: Recipient, occasion: Occasion, style: List[str], file_data: str, has_variations: bool, should_auto_renew: bool, language: str, price: Money | Mapping[str, Any], taxonomy_id: int, user: User | Mapping[str, Any], shop: Shop | Mapping[str, Any], images: List[ListingImage | Mapping[str, Any]], production_partners: List[ShopProductionPartner | Mapping[str, Any]])
Definition: ShopListingWithAssociations
Attributes
instance-attribute
The numeric ID for the listing associated to this transaction.
instance-attribute
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.
instance-attribute
A description string of the product for sale in the listing.
instance-attribute
The listing's creation time, in epoch seconds.
instance-attribute
The listing's expiration time, in epoch seconds.
instance-attribute
The listing's creation time, in epoch seconds.
instance-attribute
The time of the last update to the listing, in epoch seconds.
instance-attribute
The date and time of the last state change of this listing.
instance-attribute
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.
instance-attribute
The numeric ID of a section in a specific Etsy shop.
instance-attribute
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.
instance-attribute
The number of users who marked this listing a favorite.
instance-attribute
When true, applicable shop tax rates do not apply to this listing at checkout.
instance-attribute
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.
instance-attribute
When true, this listing is personalizable. The default value is null.
instance-attribute
When true, this listing requires personalization. The default value is null.
instance-attribute
This an integer value representing the maximum length for the personalization message entered by the buyer.
instance-attribute
When true, this listing requires personalization. The default value is null.
instance-attribute
An enumerated type string that indicates whether the listing is physical or a digital download.
instance-attribute
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.
instance-attribute
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.
instance-attribute
The numeric ID of the shipping profile associated with the listing.
instance-attribute
The minimum number of days required to process this listing. Default value is null.
instance-attribute
The maximum number of days required to process this listing. Default value is null.
instance-attribute
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'.
instance-attribute
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.
instance-attribute
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.
instance-attribute
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.
instance-attribute
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.
instance-attribute
When true, this is a private listing intendend for a specific buyer and hidden from shop view.
instance-attribute
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.
instance-attribute
A string describing the files attached to a digital listing.
instance-attribute
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.
instance-attribute
The IETF language tag for the default language of the listing. Ex: de,
en, es, fr, it, ja, nl, pl, pt, ru.
instance-attribute
The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. See seller taxonomy for more information.
instance-attribute
Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image
dataclass
Definition: ShopProductionPartner
Attributes
instance-attribute
The numeric ID of a production partner.
dataclass
dataclass
PaymentAccountLedgerEntry(entry_id: int, ledger_id: int, sequence_number: int, amount: int, currency: str, description: str, balance: int, create_date: int)
Definition: PaymentAccountLedgerEntry
Attributes
instance-attribute
The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry.
instance-attribute
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.
instance-attribute
The amount of money in the shop's ledger the moment after this entry was applied.
dataclass
Payment(payment_id: int, buyer_user_id: int, shop_id: int, receipt_id: int, amount_gross: Money | Mapping[str, Any], amount_fees: Money | Mapping[str, Any], amount_net: Money | Mapping[str, Any], currency: str, shop_currency: str, buyer_currency: str, shipping_user_id: int, shipping_address_id: int, billing_address_id: int, status: str, shipped_timestamp: int, create_timestamp: int, update_timestamp: int, payment_adjustments: List[PaymentAdjustment | Mapping[str, Any]], *, posted_gross: Optional[Money | Mapping[str, Any]] = None, posted_fees: Optional[Money | Mapping[str, Any]] = None, posted_net: Optional[Money | Mapping[str, Any]] = None, adjusted_gross: Optional[Money | Mapping[str, Any]] = None, adjusted_fees: Optional[Money | Mapping[str, Any]] = None, adjusted_net: Optional[Money | Mapping[str, Any]] = None)
Definition: Payment
Attributes
instance-attribute
A unique numeric ID for a payment to a specific Etsy shop.
instance-attribute
The numeric ID for the user who paid the purchase.
instance-attribute
The numeric ID for the receipt associated to this transaction.
instance-attribute
The ISO (alphabetic) code string for the payment's currency.
instance-attribute
The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.
instance-attribute
The numeric ID of the user to which the seller ships the order.
instance-attribute
The numeric id identifying the shipping address.
instance-attribute
The numeric ID identifying the billing address of the buyer.
instance-attribute
A string indicating the current status of the payment, most commonly settled or authed.
instance-attribute
The transaction's shipping date and time, in epoch seconds.
instance-attribute
The transaction's creation date and time, in epoch seconds.
instance-attribute
The date and time of the last change to the payment adjustment in epoch seconds.
dataclass
PaymentAdjustment(payment_adjustment_id: int, payment_id: int, status: str, is_success: bool, user_id: int, reason_code: str, total_adjustment_amount: int, shop_total_adjustment_amount: int, buyer_total_adjustment_amount: int, total_fee_adjustment_amount: int, create_timestamp: int, update_timestamp: int)
Definition: PaymentAdjustment
Attributes
instance-attribute
The numeric ID for a payment adjustment.
instance-attribute
A unique numeric ID for a payment to a specific Etsy shop.
instance-attribute
When true, the payment adjustment was or is likely to complete successfully.
instance-attribute
The numeric ID for the user (seller) fulfilling the purchase.
instance-attribute
A human-readable string describing the reason for the refund.
instance-attribute
The total numeric amount of the refund in the payment currency.
instance-attribute
The numeric amount of the refund in the shop currency.
instance-attribute
The numeric amount of the refund in the buyer currency.
instance-attribute
The numeric amount of card processing fees associated with a payment adjustment.
instance-attribute
The transaction's creation date and time, in epoch seconds.
dataclass
ShopReceiptShipment(receipt_shipping_id: int, shipment_notification_timestamp: int, carrier_name: str, tracking_code: str)
Definition: ShopReceiptShipment
Attributes
instance-attribute
The unique numeric ID of a Shop Receipt Shipment record.
instance-attribute
The time at which Etsy notified the buyer of the shipment event, in epoch seconds.
instance-attribute
The name string for the carrier/company responsible for delivering the shipment.
dataclass
TransactionReview(shop_id: int, listing_id: int, buyer_user_id: int, rating: int, review: str, language: str, image_url_fullxfull: str, create_timestamp: int, update_timestamp: int)
Definition: TransactionReview
Attributes
instance-attribute
The ID of the shop listing that the TransactionReview belongs to.
instance-attribute
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.
instance-attribute
The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings.
instance-attribute
The date and time the TransactionReview was created in epoch seconds.
dataclass
SellerTaxonomyNode(id: int, level: int, name: str, children: List[SellerTaxonomyNode | Mapping[str, Any]], full_path_taxonomy_ids: List[int], *, parent_id: Optional[int] = None)
Definition: SellerTaxonomyNode
Attributes
instance-attribute
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.
instance-attribute
The integer depth of this taxonomy node in the seller taxonomy tree, with roots at level 0.
class-attribute
instance-attribute
The numeric taxonomy ID of the parent of this node.
instance-attribute
An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxanomy tree.
dataclass
TaxonomyNodeProperty(property_id: int, name: str, display_name: str, scales: List[TaxonomyPropertyScale | Mapping[str, Any]], is_required: bool, supports_attributes: bool, supports_variations: bool, is_multivalued: bool, possible_values: List[TaxonomyPropertyValue | Mapping[str, Any]], selected_values: List[TaxonomyPropertyValue | Mapping[str, Any]])
Definition: TaxonomyNodeProperty
Attributes
instance-attribute
A list of available scales.
instance-attribute
When true, listings assigned eligible taxonomy IDs require this property.
instance-attribute
When true, you can use this property in listing attributes.
instance-attribute
When true, you can use this property in listing variations.
instance-attribute
When true, you can assign multiple property values to this property
instance-attribute
A list of supported property value strings for this property.
dataclass
dataclass
Definition: TaxonomyPropertyValue
Attributes
instance-attribute
The numeric scale ID of the scale to which this property value belongs.
dataclass
ShippingCarrier(shipping_carrier_id: int, name: str, domestic_classes: List[ShippingCarrierMailClass | Mapping[str, Any]], international_classes: List[ShippingCarrierMailClass | Mapping[str, Any]])
Definition: ShippingCarrier
Attributes
instance-attribute
The numeric ID of this shipping carrier.
instance-attribute
Set of domestic mail classes of this shipping carrier.
dataclass
dataclass
dataclass
Definition: ShopShippingProfiles
dataclass
Offering(*, price: Optional[float] = None, quantity: Optional[int] = None, is_enabled: Optional[bool] = None)
Definition: Offering
Attributes
class-attribute
instance-attribute
The price of the product.
class-attribute
instance-attribute
How many of this product are available?
dataclass
Product(*, sku: Optional[str] = None, property_values: Optional[List[PropertyValue | Mapping[str, Any]]] = None, offerings: Optional[List[Offering | Mapping[str, Any]]] = None)
Definition: Product
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
class-attribute
instance-attribute
The unique ID of an Etsy listing property.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
The name of the property, in the requested locale language.
dataclass
ApplicationListingsInventoryRequest(products: List[Product | Mapping[str, Any]], *, price_on_property: Optional[List[int]] = None, quantity_on_property: Optional[List[int]] = None, sku_on_property: Optional[List[int]] = None)
Definition: V3ApplicationListingsInventoryRequest
Attributes
instance-attribute
A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
dataclass
dataclass
VariationImage(*, property_id: Optional[int] = None, value_id: Optional[int] = None, image_id: Optional[int] = None)
Definition: VariationImage
EtsyClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
ping(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Ping
Check to confirm connectivity to the Etsy API with an application.
Swagger operation ID: Ping.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
payment_ledger_entries(shop_id: int, min_created: int, max_created: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a shop payment account ledger's entries
Retrieve the entries of a shop's payment account ledger.
Swagger operation ID: PaymentLedgerEntries.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
min_created
|
int
|
The earliest unix timestamp for when a record was created. |
required |
max_created
|
int
|
The latest unix timestamp for when a record was created. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
payment_get_entry_id(shop_id: int, ledger_entry_ids: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: PaymentGetEntryID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
ledger_entry_ids
|
str
|
Array of integers. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
payment_get_receipt(shop_id: int, receipt_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: PaymentGetReceipt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
receipt_id
|
str
|
The numeric ID for the receipt associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
payments_get(shop_id: int, payment_ids: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: PaymentsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
payment_ids
|
str
|
A comma-separated array of Payment IDs numbers. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
receipt_get(shop_id: int, receipt_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a receipt
Retrieves a receipt, identified by a receipt ID, from an Etsy shop.
Swagger operation ID: ReceiptGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
receipt_id
|
int
|
The numeric ID for the receipt associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
receipts_get(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.
Swagger operation ID: ReceiptsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
min_created
|
Optional[int]
|
The earliest unix timestamp for when a record was created. |
None
|
max_created
|
Optional[int]
|
The latest unix timestamp for when a record was created. |
None
|
min_last_modified
|
Optional[int]
|
The earliest unix timestamp for when a record last changed. |
None
|
max_last_modified
|
Optional[int]
|
The latest unix timestamp for when a record last changed. |
None
|
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
was_paid
|
Optional[bool]
|
When true, the seller received payment for the product(s) in this receipt. |
None
|
was_shipped
|
Optional[bool]
|
When true, the seller shipped the product(s) in this receipt. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
receipt_create_shipment(input: ReceiptCreateShipmentInput | Mapping[str, Any], shop_id: int, receipt_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ReceiptCreateShipment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ReceiptCreateShipmentInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
receipt_id
|
int
|
The receipt to submit tracking for. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
transactions_listing(shop_id: int, listing_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Retrieve a listing's transactions
Retrieves the list of transactions associated with a listing.
Swagger operation ID: TransactionsListing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
transaction_receipt(shop_id: int, receipt_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a receipt's transaction
Retrieves the list of transactions associated with a specific receipt.
Swagger operation ID: TransactionReceipt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
receipt_id
|
int
|
The numeric ID for the receipt associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
transaction_get(shop_id: int, transaction_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a transaction
Retrieves a transaction by transaction ID.
Swagger operation ID: TransactionGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
transaction_id
|
int
|
The unique numeric ID for a transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
transaction_get_shop(shop_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a shop's transaction
Retrieves the list of transactions associated with a shop.
Swagger operation ID: TransactionGetShop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
reviews_get(shop_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get reviews
Retrieves the reviews from a shop given its ID.
Swagger operation ID: ReviewsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_carriers(origin_country_iso: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingCarriers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
origin_country_iso
|
str
|
The ISO code of the country from which the listing ships. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_profiles(shop_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get shipping profiles
Retrieves a list of shipping profiles available in the specific Etsy shop identified by its shop ID.
Swagger operation ID: ShippingProfiles.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_create_profile(input: ShippingCreateProfileInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingCreateProfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShippingCreateProfileInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_get_profile(shop_id: int, shipping_profile_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Get a shipping profile
Retrieves a shipping profile referenced by shipping profile ID.
Swagger operation ID: ShippingGetProfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_delete_profile(shop_id: int, shipping_profile_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete a shipping profile
Deletes a shipping profile by given ID.
Swagger operation ID: ShippingDeleteProfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_update_profile(input: ShippingUpdateProfileInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a shipping profile
Changes the settings in a shipping profile.
Swagger operation ID: ShippingUpdateProfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShippingUpdateProfileInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_get_destinations(shop_id: int, shipping_profile_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get profile destinations by shipping profile
Retrieves a list of shipping destination objects associated with a shipping profile.
Swagger operation ID: ShippingGetDestinations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_create_destination(input: ShippingCreateDestinationInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingCreateDestination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShippingCreateDestinationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_delete_profile_destination(shop_id: int, shipping_profile_id: int, shipping_profile_destination_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingDeleteProfileDestination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
shipping_profile_destination_id
|
int
|
The numeric ID of the shipping profile destination in the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_update_profile_destination(input: ShippingUpdateProfileDestinationInput | Mapping[str, Any], shop_id: int, shipping_profile_id: str, shipping_profile_destination_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingUpdateProfileDestination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShippingUpdateProfileDestinationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
str
|
The numeric ID of the shipping profile associated with the listing. |
required |
shipping_profile_destination_id
|
str
|
The numeric ID of the shipping profile destinationassociated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_get_profile_upgrades(shop_id: int, shipping_profile_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get shipping profile upgrades
Retrieves the list of shipping profile upgrades assigned to a specific shipping profile.
Swagger operation ID: ShippingGetProfileUpgrades.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_create_upgrade(input: ShippingCreateUpgradeInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingCreateUpgrade.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShippingCreateUpgradeInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_delete_profile_upgrade(shop_id: int, shipping_profile_id: int, upgrade_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ShippingDeleteProfileUpgrade.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile. |
required |
upgrade_id
|
int
|
The numeric ID that is associated with a shipping upgrade. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shipping_update_profile_upgrade(input: ShippingUpdateProfileUpgradeInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, upgrade_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a shipping profile upgrade
Updates a shipping profile upgrade and updates any listings that use the shipping profile.
Swagger operation ID: ShippingUpdateProfileUpgrade.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShippingUpdateProfileUpgradeInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shipping_profile_id
|
int
|
The numeric ID of the shipping profile associated with the listing. |
required |
upgrade_id
|
int
|
The numeric ID that is associated with a shipping upgrade. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shop_update(input: ShopUpdateInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a shop
Update a shop. Assumes that all string parameters are provided in the shop's primary language.
Swagger operation ID: ShopUpdate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShopUpdateInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shop_get_by_owner_id(user_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get shop by owner ID
Retrieves the shop identified by the shop owner's user ID.
Swagger operation ID: ShopGetByOwnerID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
str
|
The numeric user ID of the user who owns this shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shop_search(shop_name: str, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Search shops
Returns a list of shops with the matching name.
Swagger operation ID: ShopSearch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_name
|
str
|
The shop's name string. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shop_get_sections(shop_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get shop sections
Retrieves the list of shop sections in a specific shop identified by shop ID.
Swagger operation ID: ShopGetSections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shop_create_section(input: ShopCreateSectionInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a shop section
Creates a new section in a specific shop.
Swagger operation ID: ShopCreateSection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ShopCreateSectionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
user_get(user_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get user
Returns user profile for the user identified by a user ID.
Swagger operation ID: UserGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
int
|
The unique positive non-zero numeric ID for an user. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shop_get_section(shop_id: int, shop_section_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get shop section
Retrieves a shop section, referenced by section ID and shop ID.
Swagger operation ID: ShopGetSection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shop_section_id
|
int
|
The numeric ID of a section in a specific Etsy shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
user_get_address(user_address_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: UserGetAddress.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_address_id
|
int
|
The numeric ID of the user's address. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
user_get_addresses(*, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get user addresses
Retrieve a list of user addresses.
Swagger operation ID: UserGetAddresses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_taxonomy_nodes(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get seller taxonomy nodes
Retrieves the full hierarchy tree of seller taxonomy nodes.
Swagger operation ID: ListingGetTaxonomyNodes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_properties_by_taxonomy(taxonomy_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingGetPropertiesByTaxonomy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
taxonomy_id
|
str
|
The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_shop(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get listings by shop
Returns listings that belong to a Shop. Listings can be filtered using the state parameter.
Swagger operation ID: ListingGetShop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
state
|
Optional[str]
|
An enumerated string from any of: active or inactive. |
None
|
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
sort_on
|
Optional[str]
|
The value to sort a search result of listings on. |
None
|
sort_order
|
Optional[str]
|
The ascending(up) or descending(down) order to sort listings by. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_create(input: ListingCreateInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a draft listing
Creates a physical draft listing product in a shop on the Etsy channel.
Swagger operation ID: ListingCreate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingCreateInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get(listing_id: int, *, includes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Get a listing
Retrieves a listing record by listing ID.
Swagger operation ID: ListingGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
includes
|
Optional[str]
|
An enumerated string that attaches a valid association. Acceptable inputs are 'shop', 'images' and 'user'. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_delete(listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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
Swagger operation ID: ListingDelete.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_active(*, 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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.
Swagger operation ID: ListingGetActive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
keywords
|
Optional[str]
|
Search term or phrase that must appear in all results. |
None
|
sort_on
|
Optional[str]
|
The value to sort a search result of listings on. NOTE: sort on only works when combined with one of the search options (keywords, region, etc.). |
None
|
sort_order
|
Optional[str]
|
The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.). |
None
|
min_price
|
Optional[float]
|
The minimum price of listings to be returned by a search result. |
None
|
max_price
|
Optional[float]
|
The maximum price of listings to be returned by a search result. |
None
|
taxonomy_id
|
Optional[int]
|
The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. |
None
|
shop_location
|
Optional[str]
|
Filters by shop location. If location cannot be parsed, Etsy responds with an error. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_active_by_shop(shop_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, keywords: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.
Swagger operation ID: ListingGetActiveByShop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
keywords
|
Optional[str]
|
Search term or phrase that must appear in all results. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_by_id(listing_ids: str, *, includes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get listings by ID
Allows to query multiple listing IDs at once. Limit 100 IDs maximum per query.
Swagger operation ID: ListingGetByID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_ids
|
str
|
The array of numeric IDs for the listings in a specific Etsy shop. |
required |
includes
|
Optional[str]
|
An enumerated string that attaches a valid association. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_featured(shop_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get featured listings by shop
Retrieves listings associated to a shop that are featured.
Swagger operation ID: ListingGetFeatured.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_delete_property(shop_id: int, listing_id: int, property_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete a listing property
Deletes a property from a listing.
Swagger operation ID: ListingDeleteProperty.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
property_id
|
int
|
The unique ID of an Etsy listing property. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_update_property(input: ListingUpdatePropertyInput | Mapping[str, Any], shop_id: int, listing_id: int, property_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingUpdateProperty.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUpdatePropertyInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
property_id
|
int
|
The unique ID of an Etsy listing property. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_property(listing_id: int, property_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingGetProperty.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
property_id
|
int
|
The unique ID of an Etsy listing property. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_properties(shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a listing's properties
Returns a list of a listing's properties.
Swagger operation ID: ListingGetProperties.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_update(input: ListingUpdateInput | Mapping[str, Any], shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a listing
Updates a listing, identified by a listing ID, for a specific shop identified by a shop ID.
Swagger operation ID: ListingUpdate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUpdateInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_by_receipt(shop_id: int, receipt_id: int, *, limit: Optional[int] = None, offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get listings by shop receipt
Gets all listings associated with a receipt.
Swagger operation ID: ListingGetByReceipt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The numeric ID for the receipt associated to this transaction. |
required |
receipt_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_by_section_id(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get listings by shop section ID
Retrieves all the listings from the section of a specific shop.
Swagger operation ID: ListingGetBySectionID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
shop_section_ids
|
str
|
A array of numeric IDs for all sections in a specific Etsy shop. |
required |
limit
|
Optional[int]
|
The maximum number of results to return. |
None
|
offset
|
Optional[int]
|
The number of records to skip before selecting the first result. |
None
|
sort_on
|
Optional[str]
|
The value to sort a search result of listings on. |
None
|
sort_order
|
Optional[str]
|
The ascending(up) or descending(down) order to sort listings by. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_file(shop_id: int, listing_id: int, listing_file_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingGetFile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
listing_file_id
|
int
|
The unique numeric ID of a file associated with a digital listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_delete_file(shop_id: int, listing_id: int, listing_file_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingDeleteFile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
listing_file_id
|
int
|
The unique numeric ID of a file associated with a digital listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_files(shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingGetFiles.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
listing_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_upload(input: ListingUploadInput | Mapping[str, Any], shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingUpload.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUploadInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_image(shop_id: int, listing_id: int, listing_image_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a listing image
Retrieves the references and metadata for a listing image with a specific image ID.
Swagger operation ID: ListingGetImage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
listing_image_id
|
int
|
The numeric ID of the primary listing image for this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_delete_image(shop_id: int, listing_id: int, listing_image_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingDeleteImage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
listing_image_id
|
int
|
The numeric ID of the primary listing image for this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_images(shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a listing's images
Retrieves all listing image resources for a listing with a specific listing ID.
Swagger operation ID: ListingGetImages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_upload_image(input: ListingUploadImageInput | Mapping[str, Any], shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingUploadImage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUploadImageInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_inventory(listing_id: int, *, includes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.
Swagger operation ID: ListingGetInventory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
includes
|
Optional[str]
|
An enumerated string that attaches an valid association. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_update_inventory(input: ListingUpdateInventoryInput | Mapping[str, Any], listing_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: ListingUpdateInventory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUpdateInventoryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
listing_id
|
str
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_offering(listing_id: int, product_id: int, product_offering_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a listing's offering
Get an offering for a listing.
Swagger operation ID: ListingGetOffering.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
product_id
|
int
|
The numeric ID for the product associated to this transaction. |
required |
product_offering_id
|
int
|
The numeric ID for the product offering associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_product(listing_id: int, product_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a listing's product
Retrieve a listing product by ID.
Swagger operation ID: ListingGetProduct.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
listing_id
|
int
|
The listing to return a listing product for. |
required |
product_id
|
int
|
The numeric ID for a specific product purchased from a listing. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_translation(shop_id: int, listing_id: int, language: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a listing's translation
Returns the translation for a listing in the given language.
Swagger operation ID: ListingGetTranslation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
language
|
str
|
The IETF language tag for the language of this translation. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_create_translation(input: ListingCreateTranslationInput | Mapping[str, Any], shop_id: int, listing_id: int, language: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a listing translation
Creates a listing translation by listing ID and language.
Swagger operation ID: ListingCreateTranslation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingCreateTranslationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
language
|
str
|
The IETF language tag for the language of this translation. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_update_translation(input: ListingUpdateTranslationInput | Mapping[str, Any], shop_id: int, listing_id: int, language: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a listing translation
Updates a listing translation by listing ID and language.
Swagger operation ID: ListingUpdateTranslation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUpdateTranslationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
language
|
str
|
The IETF language tag for the language of this translation. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_get_variation(shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get listing's variation images
Gets all variation images on a listing.
Swagger operation ID: ListingGetVariation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
listing_update_variation(input: ListingUpdateVariationInput | Mapping[str, Any], shop_id: int, listing_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a listing's variation images
Creates variation images on a listing.
Swagger operation ID: ListingUpdateVariation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListingUpdateVariationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
shop_id
|
int
|
The unique positive non-zero numeric ID for an Etsy Shop. |
required |
listing_id
|
int
|
The numeric ID for the listing associated to this transaction. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |