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

The ShopListing Image API from Etsy — 4 operation(s) for shoplisting image.

Etsy ShopListing Image 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 Image. 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 4 operations across 4 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.

4 operations 4 paths 3 schemas 1 DELETE2 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 Image 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 4

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

ShopListing Image 4
DELETE
/v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
Etsy Delete Listing Image
deleteListingImage 3 params → 404400401403204500
GET
/v3/application/listings/{listing_id}/images/{listing_image_id}
Etsy Get Listing Image
getListingImage 2 params → 200404400403500
GET
/v3/application/listings/{listing_id}/images
Etsy Get Listing Images
getListingImages 1 param → 200404400403500
POST
/v3/application/shops/{shop_id}/listings/{listing_id}/images
Etsy Upload Listing Image
uploadListingImage 2 params body → 201404400409403401500

Schemas 3

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

ErrorSchema
object
1 property 1 required
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
ListingImages
object
Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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