Etsy · Example Payload

Open Api V3 Shop Example

MarketplaceE-CommerceHandmadeListingsOrderPaymentsReviewsShippingTaxonomyAuthentication

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

Top-level fields

shop_iduser_idshop_namecreate_datecreated_timestamptitleannouncementcurrency_codeis_vacationvacation_messagesale_messagedigital_sale_messageupdate_dateupdated_timestamplisting_active_countdigital_listing_countlogin_nameaccepts_custom_requestspolicy_welcomepolicy_paymentpolicy_shippingpolicy_refundspolicy_additionalpolicy_seller_infopolicy_update_datepolicy_has_private_receipt_infohas_unstructured_policiespolicy_privacyvacation_autoreplyurlimage_url_760x100num_favorerslanguagesicon_url_fullxfullis_using_structured_policieshas_onboarded_structured_policiesinclude_dispute_form_linkis_direct_checkout_onboardedis_etsy_payments_onboardedis_calculated_eligibleis_opted_in_to_buyer_promiseis_shop_us_basedtransaction_sold_countshipping_from_country_isoshop_location_country_isoreview_countreview_average

Example Payload

Raw ↑ 
{
  "shop_id": 123456,
  "user_id": 456789,
  "shop_name": "HandmadeCrafts",
  "create_date": 1,
  "created_timestamp": 1758153645,
  "title": "Handmade Ceramic Mug \u2014 Stoneware",
  "announcement": "example string",
  "currency_code": "USD",
  "is_vacation": true,
  "vacation_message": "Thanks for your order! Shipping out tomorrow.",
  "sale_message": "Thanks for your order! Shipping out tomorrow.",
  "digital_sale_message": "Thanks for your order! Shipping out tomorrow.",
  "update_date": 1,
  "updated_timestamp": 1758153645,
  "listing_active_count": 1,
  "digital_listing_count": 1,
  "login_name": "handmade_seller",
  "accepts_custom_requests": true,
  "policy_welcome": "example string",
  "policy_payment": "example string",
  "policy_shipping": "example string",
  "policy_refunds": "example string",
  "policy_additional": "example string",
  "policy_seller_info": "example string",
  "policy_update_date": 1,
  "policy_has_private_receipt_info": true,
  "has_unstructured_policies": true,
  "policy_privacy": "example string",
  "vacation_autoreply": "example string",
  "url": "https://www.etsy.com/listing/123456789",
  "image_url_760x100": "https://www.etsy.com/listing/123456789",
  "num_favorers": 1,
  "languages": [
    "en-US",
    "en-US"
  ],
  "icon_url_fullxfull": "https://www.etsy.com/listing/123456789",
  "is_using_structured_policies": true,
  "has_onboarded_structured_policies": true,
  "include_dispute_form_link": true,
  "is_direct_checkout_onboarded": true,
  "is_etsy_payments_onboarded": true,
  "is_calculated_eligible": true,
  "is_opted_in_to_buyer_promise": true,
  "is_shop_us_based": true,
  "transaction_sold_count": 1,
  "shipping_from_country_iso": "US",
  "shop_location_country_iso": "US",
  "review_count": 1,
  "review_average": 1.0
}