Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Etsy ShopListing API

The ShopListing API from Etsy — 13 operation(s) for shoplisting.

Etsy ShopListing API is one of 28 APIs that Etsy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ShopListing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 16 operations across 13 paths, and defines 24 schemas. It is described by OpenAPI 3.0.2, at version 3.0.0.

Requests are made against a single base URL, https://openapi.etsy.com.

16 operations 13 paths 24 schemas 2 DELETE11 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
3.0.0
Base URL
https://openapi.etsy.com
Authentication
API Key, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Etsy ShopListing API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 20 scopes. By default, every request must be authenticated.

  • api_key — Every request to a v3 API endpoint must include this data in the format keystring:sharedsecret. Your keystring and shared secret are available on the [Your App…
  • oauth2 — Open API v3 supports authenticating via OAuth 2.0. More information about Etsy's specific implementation of OAuth2 can be found [here](/documentation/essential…

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 2 DELETE, 11 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ShopListing 16
POST
/v3/application/shops/{shop_id}/listings
Etsy Create Draft Listing
createDraftListing 2 params body → 201400401403404500
GET
/v3/application/shops/{shop_id}/listings
Etsy Get Listings by Shop
getListingsByShop 8 params → 200400401403500
DELETE
/v3/application/listings/{listing_id}
Etsy Delete Listing
deleteListing 1 param → 403409204404400401500
GET
/v3/application/listings/{listing_id}
Etsy Get Listing
getListing 5 params → 200404400500
GET
/v3/application/listings/active
Etsy Find All Listings Active
findAllListingsActive 13 params → 200404500
GET
/v3/application/shops/{shop_id}/listings/active
Etsy Find All Active Listings by Shop
findAllActiveListingsByShop 7 params → 200404400500
GET
/v3/application/listings/batch
Etsy Get Listings by Listing Ids
getListingsByListingIds 5 params → 200400404500
GET
/v3/application/shops/{shop_id}/listings/featured
Etsy Get Featured Listings by Shop
getFeaturedListingsByShop 4 params → 200400403500
DELETE
/v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
Etsy Delete Listing Property
deleteListingProperty 3 params → 204403404400401500
PUT
/v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
Etsy Update Listing Property
updateListingProperty 3 params body → 200403404400401500
GET
/v3/application/listings/{listing_id}/properties/{property_id}
Etsy Get Listing Property
getListingProperty 2 params → 200404501400500
GET
/v3/application/shops/{shop_id}/listings/{listing_id}/properties
Etsy Get Listing Properties
getListingProperties 2 params → 200404400500
PATCH
/v3/application/shops/{shop_id}/listings/{listing_id}
Etsy Update Listing
updateListing 3 params body → 200400401403409404500
GET
/v3/application/shops/{shop_id}/receipts/{receipt_id}/listings
Etsy Get Listings by Shop Receipt
getListingsByShopReceipt 5 params → 200400403404401500
GET
/v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings
Etsy Get Listings by Shop Return Policy
getListingsByShopReturnPolicy 3 params → 200400403404401500
GET
/v3/application/shops/{shop_id}/shop-sections/listings
Etsy Get Listings by Shop Section Id
getListingsByShopSectionId 7 params → 200400500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ShopListingWithAssociations (61 properties), ShopListing (49 properties), Shop (47 properties), ListingImage (20 properties). Each schema is shown below with its type and property counts.

ListingVideo
object
Reference urls and metadata for a video associated with a specific listing.
6 properties
ListingImage
object
Reference urls and metadata for an image associated with a specific listing. The urlfullxfull parameter contains the URL for full-sized binary image file.
20 properties
ListingPropertyValue
object
A representation of structured data values.
6 properties
ListingPropertyValues
object
Represents several ListingPropertyValues.
2 properties
Money
object
A representation of an amount of money.
3 properties
ShopListingWithAssociations
object
A listing from a shop, which contains a product quantity, title, description, price, etc. and additional fields which represent associations.
61 properties
ShopListings
object
A set of ShopListing resources.
2 properties
Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization
object
1 property
ShopShippingProfileUpgrade
object
A representation of a shipping profile upgrade option.
12 properties
ShopShippingProfileDestination
object
Represents a shipping destination assigned to a shipping profile.
11 properties
ShopShippingProfile
object
Represents a profile used to set a listing's shipping information. Please note that it's not possible to create calculated shipping templates via the API. Howe…
11 properties
ListingTranslation
object
Represents the translation data for a Listing.
5 properties
ErrorSchema
object
1 property 1 required
Shop
object
A shop created by an Etsy user.
47 properties
ListingInventoryProduct
object
A representation of a product for a listing.
5 properties
User
object
Represents a single user of the site
5 properties
Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_PersonalizationQuestion
object
8 properties
ShopProductionPartner
object
Represents a description of a shop production partner.
3 properties
ListingBuyerPrice
object
The buyer-facing price for a listing, including VAT, inclusive shipping (UK), and active promotions.
10 properties
ListingInventoryProductOffering
object
A representation of an offering for a listing.
6 properties
ShopListingsWithAssociations
object
A set of ShopListing resources with associations.
2 properties
ListingTranslations
object
Container for all current supported translations of a listing. Note that Etsy periodically adds/removes languages, so this list may change in the future.
13 properties
ShopListing
object
A listing from a shop, which contains a product quantity, title, description, price, etc.
49 properties
ListingInventory
object
A representation of a single listing's inventory record.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etsy-shoplisting-api-openapi.yml Raw ↑

Other APIs Etsy publishes across the network.

Etsy Open API v3 Webhooks
Etsy BuyerTaxonomy API
Etsy Ledger Entry API
Etsy Other API
Etsy Payment API
Etsy Review API
Etsy SellerTaxonomy API
Etsy Shop API
Etsy Shop HolidayPreferences API
Etsy Shop ProcessingProfiles API
Etsy Shop ProductionPartner API
Etsy Shop Receipt API