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 Personalization API

The ShopListing Personalization API from Etsy — 2 operation(s) for shoplisting personalization.

Etsy ShopListing Personalization 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 Personalization. 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 3 operations across 2 paths, and defines 3 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.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 POST

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 Personalization 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 3

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

ShopListing Personalization 3
DELETE
/v3/application/shops/{shop_id}/listings/{listing_id}/personalization
Etsy Delete Listing Personalization
deleteListingPersonalization 2 params → 204404400403401500
POST
/v3/application/shops/{shop_id}/listings/{listing_id}/personalization
Etsy Update Listing Personalization
updateListingPersonalization 3 params body → 201400401403404409500
GET
/v3/application/listings/{listing_id}/personalization
Etsy Get Listing Personalization
getListingPersonalization 1 param → 200404400403500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_PersonalizationQuestion (8 properties), ErrorSchema (1 property), Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization (1 property). Each schema is shown below with its type and property counts.

Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization
object
1 property
Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_PersonalizationQuestion
object
8 properties
ErrorSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etsy-shoplisting-personalization-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