Shopping — entry 006 of 15

Etsy

Verified Jul 2026

Etsy's Open API v3 gates even its read-only ping and listings endpoints behind a required x-api-key, reserving OAuth2 specifically for calls that touch private seller or buyer data. It's free to use under a sliding-window limit of 10,000 requests per day and 10 requests per second, and returns no CORS headers on either GET or OPTIONS, so it isn't designed for direct browser calls.

ecommercemarketplaceapi-keylistingshandmade

Visit developers.etsy.com ↗More Shopping

AuthenticationAPI KeySign up with the provider to obtain credentials.

HTTPSSupportedTraffic is encrypted in transit.

CORSDisabledBrowser calls need a server-side proxy.

PricingFreeNo paid tier — free for the documented use case.

FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score84out of 100

Authentication15/25API key required

Pricing20/20Free to use

Docs20/20Machine-readable spec file bundled

Formats9/15Single response format

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/etsy/"><img src="https://greatapis.com/badge/etsy.svg" alt="Scored 84 on greatapis.com"></a>

Auth quickstart

Sign up with the provider to get an API key.
Send it on every request as a headerx-api-key: <key>

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://openapi.etsy.com

Auth

api_keyoauth2

User2

GET/v3/application/users/me

Responses

Status	Description	Schema
`200`	Fetches basic info about the requesting user	`Self`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/users/{user_id}

Parameters

Name	In	Required	Type
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single User	`User`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

UserAddress3

GET/v3/application/user/addresses

Parameters

Name	In	Required	Type
`limit`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	A list of UserAddress records	`UserAddresses`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/user/addresses/{user_address_id}

Parameters

Name	In	Required	Type
`user_address_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single UserAddress	`UserAddress`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/user/addresses/{user_address_id}

Parameters

Name	In	Required	Type
`user_address_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The User Address resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop Receipt Transactions4

GET/v3/application/shops/{shop_id}/listings/{listing_id}/transactions

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A list of transactions	`ShopReceiptTransactions`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`receipt_id`	path	yes	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A list of transactions	`ShopReceiptTransactions`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/transactions

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A list of transactions	`ShopReceiptTransactions`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/transactions/{transaction_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`transaction_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single transaction	`ShopReceiptTransaction`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Other2

GET/v3/application/openapi-ping

Responses

Status	Description	Schema
`200`	A confirmation that the current application has access to the Open API	`Pong`
`401`	Missing or invalid API key.	`ErrorSchema`
`404`	App does not have the proper permissions to access this resource.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/scopes

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A confirmation that the current application has access to the Open API	`Scopes`
`401`	Missing or invalid API key.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop4

GET/v3/application/shops

Parameters

Name	In	Required	Type
`shop_name`	query	yes	string
`limit`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	A list of Shops	`Shops`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single Shop	`Shop`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single Shop.	`Shop`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/users/{user_id}/shops

Parameters

Name	In	Required	Type
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single Shop	`Shop`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop ShippingProfile14

GET/v3/application/shipping-carriers

Parameters

Name	In	Required	Type
`origin_country_iso`	query	yes	string

Responses

Status	Description	Schema
`200`	A set of ShippingCarriers	`ShippingCarriers`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/shipping-profiles

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of shipping profiles	`ShopShippingProfiles`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/shipping-profiles

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single ShippingProfile	`ShopShippingProfile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single ShippingProfile	`ShopShippingProfile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	The updated shipping profile.	`ShopShippingProfile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	This function is temporarily unavailable. Please try again later.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ShopShippingProfile resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	A list of shipping destination objects.	`ShopShippingProfileDestinations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`201`	A single shipping destination.	`ShopShippingProfileDestination`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer
`shipping_profile_destination_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single shipping destination.	`ShopShippingProfileDestination`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	This function is temporarily unavailable. Please try again later.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer
`shipping_profile_destination_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Etsy deleted the shipping profile destination.	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of shipping profile upgrades.	`ShopShippingProfileUpgrades`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single shipping profile upgrade.	`ShopShippingProfileUpgrade`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer
`upgrade_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single shipping profile upgrade.	`ShopShippingProfileUpgrade`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	This function is temporarily unavailable. Please try again later.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shipping_profile_id`	path	yes	integer
`upgrade_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Etsy deleted the shipping profile upgrade.	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop Section5

GET/v3/application/shops/{shop_id}/sections

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of shop sections.	`ShopSections`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/sections

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A Shop Section resource	`ShopSection`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	This function is temporarily unavailable. Please try again later.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/sections/{shop_section_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shop_section_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A shop section resource	`ShopSection`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/sections/{shop_section_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shop_section_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A Shop Section resource	`ShopSection`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	This function is temporarily unavailable. Please try again later.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/sections/{shop_section_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shop_section_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The shop section resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	This function is temporarily unavailable. Please try again later.	`ErrorSchema`

ShopListing17

GET/v3/application/listings/active

Parameters

Name	In	Required	Type
`limit`	query	no	integer
`offset`	query	no	integer
`keywords`	query	no	string
`sort_on`	query	no	string
`sort_order`	query	no	string
`min_price`	query	no	number
`max_price`	query	no	number
`taxonomy_id`	query	no	integer
`shop_location`	query	no	string
`is_safe`	query	no	boolean
`currency`	query	no	string
`buyer_country`	query	no	string

Responses

Status	Description	Schema
`200`	A list of all active listings on Etsy paginated by their creation date. Without sort_order listings will be returned newest-first by default.	`ShopListings`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/batch

Parameters

Name	In	Required	Type
`listing_ids`	query	yes	array
`includes`	query	no	array
`legacy`	query	no	boolean
`currency`	query	no	string
`buyer_country`	query	no	string

Responses

Status	Description	Schema
`200`	A list of Listings	`ShopListingsWithAssociations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/batch/shipping

Parameters

Name	In	Required	Type
`listing_ids`	query	yes	array

Responses

Status	Description	Schema
`200`	A list of listings with their shipping profiles.	`ShopListingsWithAssociations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/{listing_id}

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`includes`	query	no	array
`language`	query	no	string
`allow_suggested_title`	query	no	boolean

Responses

Status	Description	Schema
`200`	A single Listing.	`ShopListingWithAssociations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/listings/{listing_id}

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The Listing resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/{listing_id}/properties/{property_id}

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`property_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single ListingProperty.	`ListingPropertyValue`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`501`	This endpoint is not functional at this time.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/listings

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`state`	query	no	string
`limit`	query	no	integer
`offset`	query	no	integer
`sort_on`	query	no	string
`sort_order`	query	no	string
`includes`	query	no	array

Responses

Status	Description	Schema
`200`	A list of Listings	`ShopListingsWithAssociations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`201`	A single ShopListing	`ShopListing`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/listings/active

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`limit`	query	no	integer
`sort_on`	query	no	string
`sort_order`	query	no	string
`offset`	query	no	integer
`keywords`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieves a list of all active listings on Etsy in a specific shop, paginated by listing creation date.	`ShopListings`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/listings/featured

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A list of Listings	`ShopListings`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PATCH/v3/application/shops/{shop_id}/listings/{listing_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single ShopListing	`ShopListing`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/listings/{listing_id}/properties

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A Listing's Properties	`ListingPropertyValues`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`property_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single listing property.	`ListingPropertyValue`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`property_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ListingProperty resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings

Parameters

Name	In	Required	Type
`return_policy_id`	path	yes	integer
`shop_id`	path	yes	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A set of ShopListing resources.	`ShopListings`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/receipts/{receipt_id}/listings

Parameters

Name	In	Required	Type
`receipt_id`	path	yes	integer
`shop_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A set of ShopListing resources.	`ShopListings`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/shop-sections/listings

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`shop_section_ids`	query	yes	array
`limit`	query	no	integer
`offset`	query	no	integer
`sort_on`	query	no	string
`sort_order`	query	no	string
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A list of listings from a shop section.	`ShopListings`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop ProcessingProfiles5

GET/v3/application/shops/{shop_id}/readiness-state-definitions

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	A list of ProcessingProfiles	`ShopProcessingProfiles`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/readiness-state-definitions

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`201`	A single ReadinessStateDefinition	`ShopProcessingProfile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`readiness_state_definition_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single ProcessingProfile	`ShopProcessingProfile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`readiness_state_definition_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	The updated ReadinessStateDefinition	`ShopProcessingProfile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`readiness_state_definition_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ReadinessStateDefinition was successfully deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop ProductionPartner1

GET/v3/application/shops/{shop_id}/production-partners

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of shop production partners	`ShopProductionPartners`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop Return Policy6

GET/v3/application/shops/{shop_id}/policies/return

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List of shop's Return Policies	`ShopReturnPolicies`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/policies/return

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single Return Policy	`ShopReturnPolicy`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/policies/return/consolidate

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	The updated target Return Policy	`ShopReturnPolicy`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/policies/return/{return_policy_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`return_policy_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single Return Policy	`ShopReturnPolicy`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/policies/return/{return_policy_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`return_policy_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	An updated Return Policy	`ShopReturnPolicy`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/policies/return/{return_policy_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`return_policy_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The Return Policy was successfully deleted.	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop HolidayPreferences2

GET/v3/application/shops/{shop_id}/holiday-preferences

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of holiday preferences	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/holiday-preferences/{holiday_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`holiday_id`	path	yes	integer

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	The updated holiday preferences	`ShopHolidayPreference`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

SellerTaxonomy2

GET/v3/application/seller-taxonomy/nodes

Responses

Status	Description	Schema
`200`	List the full hierarchy tree of seller taxonomy nodes.	`SellerTaxonomyNodes`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`
`503`	The service is unavailable	`ErrorSchema`

GET/v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties

Parameters

Name	In	Required	Type
`taxonomy_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of product properties, with applicable scales and values.	`TaxonomyNodeProperties`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Review2

GET/v3/application/listings/{listing_id}/reviews

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer
`min_created`	query	no	integer
`max_created`	query	no	integer

Responses

Status	Description	Schema
`200`	A set of Transaction Reviews by Listing ID	`ListingReviews`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/reviews

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer
`min_created`	query	no	integer
`max_created`	query	no	integer

Responses

Status	Description	Schema
`200`	A set of Transaction Reviews By Shop ID	`TransactionReviews`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Shop Receipt4

GET/v3/application/shops/{shop_id}/receipts

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`min_created`	query	no	integer
`max_created`	query	no	integer
`min_last_modified`	query	no	integer
`max_last_modified`	query	no	integer
`limit`	query	no	integer
`offset`	query	no	integer
`sort_on`	query	no	string
`sort_order`	query	no	string
`was_paid`	query	no	boolean
`was_shipped`	query	no	boolean
`was_delivered`	query	no	boolean
`was_canceled`	query	no	boolean
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A list of Shop Receipts	`ShopReceipts`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/receipts/{receipt_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`receipt_id`	path	yes	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A single Shop Receipt	`ShopReceipt`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/receipts/{receipt_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`receipt_id`	path	yes	integer
`legacy`	query	no	boolean

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	Update A Shop Receipt	`ShopReceipt`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`receipt_id`	path	yes	integer
`legacy`	query	no	boolean

Request body

application/json

Responses

Status	Description	Schema
`200`	A single ShopReceipt	`ShopReceipt`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Payment3

GET/v3/application/shops/{shop_id}/payment-account/ledger-entries/payments

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`ledger_entry_ids`	query	yes	array

Responses

Status	Description	Schema
`200`	A list of Payments	`Payments`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/payments

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`payment_ids`	query	yes	array

Responses

Status	Description	Schema
`200`	A list of payments from a specific shop.	`Payments`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/receipts/{receipt_id}/payments

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`receipt_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single payment	`Payments`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Ledger Entry2

GET/v3/application/shops/{shop_id}/payment-account/ledger-entries

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`min_created`	query	yes	integer
`max_created`	query	yes	integer
`limit`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	A list of PaymentAccountLedgerEntries	`PaymentAccountLedgerEntries`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`ledger_entry_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single of PaymentAccountLedgerEntry	`PaymentAccountLedgerEntry`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Video4

GET/v3/application/listings/{listing_id}/videos

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of videos for a listing	`ListingVideos`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/{listing_id}/videos/{video_id}

Parameters

Name	In	Required	Type
`video_id`	path	yes	integer
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	The metadata for a video associated with a listing.	`ListingVideo`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings/{listing_id}/videos

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Request body

multipart/form-data

Responses

Status	Description	Schema
`201`	The metadata for a file associated with a digital listing.	`ListingVideo`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`video_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ListingVideo resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing VariationImage2

GET/v3/application/shops/{shop_id}/listings/{listing_id}/variation-images

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of ListingVariationImages	`ListingVariationImages`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings/{listing_id}/variation-images

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Request body

application/json

Responses

Status	Description	Schema
`200`	A single ListingVariationImage	`ListingVariationImages`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Translation3

GET/v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`language`	path	yes	string

Responses

Status	Description	Schema
`200`	A single ListingTranslation	`ListingTranslation`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`language`	path	yes	string

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single ListingTranslation	`ListingTranslation`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`language`	path	yes	string

Request body

application/x-www-form-urlencoded

Responses

Status	Description	Schema
`200`	A single ListingTranslation	`ListingTranslation`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Personalization3

GET/v3/application/listings/{listing_id}/personalization

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A listing personalization questions	`Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings/{listing_id}/personalization

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`supports_multiple_personalization_questions`	query	no	boolean

Request body

application/json

Responses

Status	Description	Schema
`201`	A single Listing Personalization record	`Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/listings/{listing_id}/personalization

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ListingPersonalization resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Inventory3

GET/v3/application/listings/batch/inventory

Parameters

Name	In	Required	Type
`listing_ids`	query	yes	array

Responses

Status	Description	Schema
`200`	A list of listings with their inventory records.	`ShopListingsWithAssociations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/{listing_id}/inventory

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`show_deleted`	query	no	boolean
`includes`	query	no	string

Responses

Status	Description	Schema
`200`	A single listing inventory record.	`ListingInventoryWithAssociations`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`422`	There was a problem processing your request. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

PUT/v3/application/listings/{listing_id}/inventory

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`max_variations_supported`	query	no	string

Request body

application/json

Responses

Status	Description	Schema
`200`	A single listing's inventory record.	`ListingInventory`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Offering1

GET/v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`product_id`	path	yes	integer
`product_offering_id`	path	yes	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A single ListingInventoryProductOffering	`ListingInventoryProductOffering`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Product1

GET/v3/application/listings/{listing_id}/inventory/products/{product_id}

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`product_id`	path	yes	integer
`legacy`	query	no	boolean

Responses

Status	Description	Schema
`200`	A single ListingInventoryProduct	`ListingInventoryProduct`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing Image4

GET/v3/application/listings/{listing_id}/images

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	An array of ListingImage	`ListingImages`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/listings/{listing_id}/images/{listing_image_id}

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`listing_image_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A single ListingImage	`ListingImage`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings/{listing_id}/images

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Request body

multipart/form-data

Responses

Status	Description	Schema
`201`	A single ListingImage	`ListingImage`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`listing_image_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ListingImage resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

ShopListing File4

GET/v3/application/shops/{shop_id}/listings/{listing_id}/files

Parameters

Name	In	Required	Type
`listing_id`	path	yes	integer
`shop_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of metadata objects for the file resources associated with a listing.	`ShopListingFiles`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

POST/v3/application/shops/{shop_id}/listings/{listing_id}/files

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer

Request body

multipart/form-data

Responses

Status	Description	Schema
`201`	The metadata for a file associated with a digital listing.	`ShopListingFile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`listing_file_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	The metadata for a file associated with a digital listing.	`ShopListingFile`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

DELETE/v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}

Parameters

Name	In	Required	Type
`shop_id`	path	yes	integer
`listing_id`	path	yes	integer
`listing_file_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	The ShopListingFile resource was correctly deleted	—
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`401`	The request lacks valid authentication credentials. See the error message for details.	`ErrorSchema`
`403`	The request attempted to perform an operation it is not allowed to. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`409`	There was a request conflict with the current state of the target resource. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

BuyerTaxonomy2

GET/v3/application/buyer-taxonomy/nodes

Responses

Status	Description	Schema
`200`	List the full hierarchy tree of buyer taxonomy nodes.	`BuyerTaxonomyNodes`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

GET/v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties

Parameters

Name	In	Required	Type
`taxonomy_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	A list of product properties, with applicable scales and values.	`BuyerTaxonomyNodeProperties`
`400`	There was a problem with the request data. See the error message for details.	`ErrorSchema`
`404`	A resource could not be found. See the error message for details.	`ErrorSchema`
`500`	The server encountered an internal error. See the error message for details.	`ErrorSchema`

Try it

Operation

API key

Developer reference

Base URLhttps://openapi.etsy.com

Rate limit

Etsy enforces per-application limits at the API-key level rather than a single published default -- each app's actual QPS/QPD ceiling is visible live in the Developer Portal (etsy.com/developers/your-apps). A progressive sliding-window algorithm tracks usage, echoed on every response via x-limit-per-second/x-remaining-this-second/x-limit-per-day/x-remaining-today headers, and exceeding either window returns HTTP 429 with a retry-after header (developers.etsy.com/documentation/essentials/rate-limits).

Key endpoints

GET/v3/application/openapi-ping
GET/v3/application/shops/{shop_id}
GET/v3/application/shops/{shop_id}/listings
GET/v3/application/listings/active
GET/v3/application/listings/{listing_id}

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

People comparing Etsy also look at…

Digi-Key

Best Buy

eBay

Flipkart Marketplace

Lazada

Mercadolibre