Etsy · Example Payload

Open Api V3 Shop Listing Example

Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.

handmadehandmade

Open Api V3 Shop Listing Example is an example object payload from Etsy, with 49 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

listing_iduser_idshop_idtitledescriptionstatecreation_timestampcreated_timestampending_timestamporiginal_creation_timestamplast_modified_timestampupdated_timestampstate_timestampquantityshop_section_idfeatured_rankurlnum_favorersnon_taxableis_taxableis_customizableis_personalizablelisting_typetagsmaterialsshipping_profile_idreturn_policy_idprocessing_minprocessing_maxwho_madewhen_madeis_supplyitem_weightitem_weight_unititem_lengthitem_widthitem_heightitem_dimensions_unitis_privatestylefile_datahas_variationsshould_auto_renewlanguagepriceconverted_pricetaxonomy_idreadiness_state_idsuggested_title

Example Payload

Raw ↑ 
{
  "listing_id": 123456789,
  "user_id": 456789,
  "shop_id": 123456,
  "title": "Handmade Ceramic Mug \u2014 Stoneware",
  "description": "Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.",
  "state": "active",
  "creation_timestamp": 1758153645,
  "created_timestamp": 1758153645,
  "ending_timestamp": 1758153645,
  "original_creation_timestamp": 1758153645,
  "last_modified_timestamp": 1758153645,
  "updated_timestamp": 1758153645,
  "state_timestamp": 1758153645,
  "quantity": 1,
  "shop_section_id": 1,
  "featured_rank": 1,
  "url": "https://www.etsy.com/listing/123456789",
  "num_favorers": 1,
  "non_taxable": true,
  "is_taxable": true,
  "is_customizable": true,
  "is_personalizable": true,
  "listing_type": "physical",
  "tags": [
    "handmade",
    "handmade"
  ],
  "materials": [
    "ceramic",
    "ceramic"
  ],
  "shipping_profile_id": 1,
  "return_policy_id": 1,
  "processing_min": 1,
  "processing_max": 1,
  "who_made": "i_did",
  "when_made": "made_to_order",
  "is_supply": true,
  "item_weight": 0.5,
  "item_weight_unit": "oz",
  "item_length": 1.0,
  "item_width": 1.0,
  "item_height": 1.0,
  "item_dimensions_unit": "in",
  "is_private": true,
  "style": [
    "example value",
    "example value"
  ],
  "file_data": "example string",
  "has_variations": true,
  "should_auto_renew": true,
  "language": "en-US",
  "price": "example",
  "converted_price": "example",
  "taxonomy_id": 1234,
  "readiness_state_id": 1,
  "suggested_title": "Handmade Ceramic Mug \u2014 Stoneware"
}