Etsy (Independent Publisher)

The numeric ID for the listing associated to this transaction.

The numeric ID for the user posting the listing.

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

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.

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

An enumerated string from any of: active or inactive. Note: Setting a draft listing to active will also publish the listing on etsy.com.

The listing's creation time, in epoch seconds.

The listing's expiration time, in epoch seconds.

The listing's creation time, in epoch seconds.

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

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

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.

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

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.

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

The number of users who marked this listing a favorite.

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

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.

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

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

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

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

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

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.

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.

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

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

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

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

An enumerated 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'.

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'.

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.

A string defining the units used to measure the weight of the product. Default value is null.

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.

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.

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.

A string defining the units used to measure the dimensions of the product. Default value is null.

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

An enumerated string indicating a person for whom this product would make an appropriate gift. Default value is null.

An enumerated string indicating an occassion for which this product would make an appropriate gift. Default value is null.

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.

A string describing the files attached to a digital listing.

When true, the listing has variations.

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.

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

A representation of an amount of money.

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

The amount of represented by this data.

The divisor to render the amount.

The ISO currency code for this data.

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

The numeric ID for the listing associated to this transaction.

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

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

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

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

A type string indicating a file's MIME type.

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

The number of ShopListingFiles being returned..

An array of ShopListingFile resources.

The number of shop listing resources found.

The shop listing resources found.

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

The user's login name string.

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

The user's first name.

The user's last name.

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

The numeric ID of the user who referred this user.

Deprecated. Always true.

True if the user is seller.

The user's biography.

The user's gender.

The user's month of birth.

The user's day of birth.

The number of transactions where the user has bought.

The number of transactions where the user has sold.

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

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

The shop's name string.

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

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

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

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

When true, this shop is not accepting purchases.

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

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

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

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

The number of active listings in the shop.

The number of digital listings in the shop.

The shop owner's login name string.

When true, the shop accepts customization requests.

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

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

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

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

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

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

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

When true, EU receipts display private info.

When true, the shop displays additional unstructured policy fields.

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

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

The URL string for this shop.

The URL string for this shop's banner image.

The number of users who marked this shop a favorite.

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

The URL string for this shop's icon image.

When true, the shop accepted using structured policies.

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

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

When true, the shop has onboarded onto Etsy Payments.

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

When true, the shop opted in to buyer promise.

When true, the shop is based in the US.

The total number of sales transactions for this shop

The country iso the shop is shipping from.

The country iso where the shop is located.

Number of reviews of shop listings in the past year.

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

The numeric ID for the listing associated to this transaction.

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

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

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

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

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

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

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

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

When true, the image is in black & white.

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

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.

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

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

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

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

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

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

The number of results.

The list of requested resources.

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

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.

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.

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.

A listing from a shop, which contains a product quantity, title, description, price, etc.

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

The SKU string for the product

When true, someone deleted this product.

A list of product offering entries for this product.

A list of property value entries for this product.

The ID for the product offering

The quantity the product offering

Whether or not the offering can be shown to buyers.

Whether or not the offering has been deleted.

A representation of an amount of money.

The numeric ID of the Property.

The name of the Property.

The numeric ID of the scale (if any).

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

The numeric IDs of the property values

The property values

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

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.

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.

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.

The number of shop listing resources found.

The shop listing resources found.

The number of shop listing resources found.

The shop listing resources found.

The number of shop receipt transaction resources found.

The shop receipt transaction resources found.

The unique numeric ID for a transaction.

The title string of the listing purchased in this transaction.

The description string of the listing purchased in this transaction.

The numeric user ID for the seller in this transaction.

The numeric user ID for the buyer in this transaction.

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

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

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

The numeric quantity of products purchased in this transaction.

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

The numeric ID for the receipt associated to this transaction.

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

A string describing the files purchased in this transaction.

The numeric ID for the listing associated to this transaction.

The type string for the transaction, usually listing

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

A representation of an amount of money.

A representation of an amount of money.

The numeric ID for the Listing.

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

The title of the Listing of this Translation.

The description of the Listing of this Translation.

The tags of the Listing of this Translation.

The count of variation images.

The variation images results.

The numeric ID of the Property.

The numeric ID of the Value.

The numeric ID of the Image.

The number of payment account ledger entry resources found.

The payment account ledger entry resources found.

The ledger entry's numeric ID.

The ledger's numeric ID.

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

The amount of money credited to the ledger.

The currency of the entry on the ledger.

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.

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

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

The number of payments in the response.

A list of payments.

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

The numeric ID for the user who paid the purchase.

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

The numeric ID for the receipt associated to this transaction.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

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

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

The currency string of the buyer.

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

The numeric id identifying the shipping address.

The numeric ID identifying the billing address of the buyer.

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

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

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

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

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

The numeric ID for a payment adjustment.

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

The status string of the payment adjustment.

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

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

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

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

The numeric amount of the refund in the shop currency.

The numeric amount of the refund in the buyer currency.

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

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

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

The authenticated application's ID

The numeric ID for the receipt associated to this transaction.

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

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

The email address string for the seller of the listing.

The numeric ID for the user making the purchase.

The email address string for the buyer of the listing.

The name string for the recipient in the shipping address.

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

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

The city string for the recipient in the shipping address.

The state string for the recipient in the shipping address.

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

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

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

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).

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

An optional message string from the seller.

An optional message string from the buyer.

The machine-generated acknowledgement string from the payment system.

When true, buyer paid for this purchase.

When true, seller shipped the products.

The receipt's creation time, in epoch seconds.

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

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

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A representation of an amount of money.

A list of shipment statements for this receipt.

The unique numeric ID of a Shop Receipt Shipment record.

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

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

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

The number of Shop Receipts found.

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

The number of TransactionReview resources found.

The TransactionReview resources found.

The shop's numeric ID.

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

The numeric ID of the user who was the buyer in this transaction. Note: This field may be absent, depending on the buyer's privacy settings.

Rating value on scale from 1 to 5

A message left by the author, explaining the feedback.

The language of the TransactionReview

The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings.

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

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

The number of results.

The list of requested resources.

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.

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

The name string for this taxonomy node.

The numeric taxonomy ID of the parent of this node.

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

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

The number of results.

The list of requested resources.

The unique numeric ID of this product property.

The name string for this taxonomy node.

The human-readable product property name string.

A list of available scales.

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

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

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

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

A list of supported property value strings for this property.

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

The unique numeric ID of a scale.

The name string for a scale.

The description string for a scale.

The numeric ID of this property value.

The name string of this property value.

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

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

The numeric ID of this shipping carrier.

The name of this shipping carrier.

Set of domestic mail classes of this shipping carrier.

Set of international mail classes of this shipping carrier.

The unique identifier of this mail class.

The name of this mail class.

The total number of Shops

The Shop resources.

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

The title string for a shop section.

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

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

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

The number of results.

The list of requested resources.

The numeric ID of the shipping profile.

The name string of this shipping profile.

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

The minimum number of days for processing the listing.

The maximum number of days for processing the listing.

Translated display label string for processing days.

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

When true, someone deleted this shipping profile.

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

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

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

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

The numeric ID of the shipping profile.

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

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

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

A representation of an amount of money.

A representation of an amount of money.

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

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

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

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

The numeric ID of the base shipping profile.

The numeric ID that is associated with a shipping upgrade

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

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

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.

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

A representation of an amount of money.

A representation of an amount of money.

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

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

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

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

The number of results.

The list of requested resources.

The number of results.

The list of requested resources.

The numeric ID of the user's address.

The user's numeric ID.

The user's name for this address.

The first line of the user's address.

The second line of the user's address.

The city field of the user's address.

The state field of the user's address.

The zip code field of the user's address.

The ISO code of the country in this address.

The name of the user's country.

Is this the user's default shipping address.

The number of UserAddress records being returned.

An array of UserAddress resources.