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

The ShopListing Inventory API from Etsy — 1 operation(s) for shoplisting inventory.

Etsy ShopListing Inventory 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 Inventory. 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 2 operations across 1 path, and defines 8 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.

2 operations 1 paths 8 schemas 1 GET1 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 Inventory 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 2

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

ShopListing Inventory 2
GET
/v3/application/listings/{listing_id}/inventory
Etsy Get Listing Inventory
getListingInventory 4 params → 200404401400422500
PUT
/v3/application/listings/{listing_id}/inventory
Etsy Update Listing Inventory
updateListingInventory 3 params body → 200404403400401500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ShopListing (49 properties), ListingPropertyValue (6 properties), ListingInventoryWithAssociations (6 properties), ListingInventoryProductOffering (6 properties). Each schema is shown below with its type and property counts.

ErrorSchema
object
1 property 1 required
ListingInventoryWithAssociations
object
A representation of a single listing's inventory record with associations
6 properties
ListingPropertyValue
object
A representation of structured data values.
6 properties
ListingInventoryProduct
object
A representation of a product for a listing.
5 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
Money
object
A representation of an amount of money.
3 properties
ListingInventoryProductOffering
object
A representation of an offering for a listing.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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