{"files":{"SKILL.md":"---\nname: etsy-open-api-v3\ndescription: \"Etsy Open API v3 API skill. Use when working with Etsy Open API v3 for application. Covers 103 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Etsy Open API v3\nAPI version: 3.0.0\n\n## Auth\nApiKey x-api-key in header | OAuth2\n\n## Base URL\nhttps://openapi.etsy.com\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /v3/application/buyer-taxonomy/nodes -- verify access\n3. POST /v3/application/shops/{shop_id}/listings -- create first listings\n\n## Endpoints\n\n103 endpoints across 1 groups. See references/api-spec.lap for full details.\n\n### application\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v3/application/buyer-taxonomy/nodes | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/listings/{listing_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/{listing_id}/files | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings/{listing_id}/files | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/active | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/active | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/images/{listing_image_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/images | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings/{listing_id}/images | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/inventory | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/listings/{listing_id}/inventory | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/inventory/products/{product_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/batch | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/featured | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/listings/{listing_id}/personalization | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings/{listing_id}/personalization | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/personalization | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/properties/{property_id} | Feedback only Give feedbackDevelopment for this endpoint is in progress. It will only return a 501 response. |\n| GET | /v3/application/shops/{shop_id}/listings/{listing_id}/properties | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/{listing_id}/transactions | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PATCH | /v3/application/shops/{shop_id}/listings/{listing_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/videos/{video_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/videos | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/listings/{listing_id}/videos | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/payment-account/ledger-entries | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/payments | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/openapi-ping | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/receipts/{receipt_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/receipts/{receipt_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/receipts | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/listings/{listing_id}/reviews | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/reviews | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/seller-taxonomy/nodes | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shipping-carriers | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/users/{user_id}/shops | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/holiday-preferences | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/holiday-preferences/{holiday_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/policies/return/consolidate | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/policies/return | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/policies/return | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/policies/return/{return_policy_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/policies/return/{return_policy_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/policies/return/{return_policy_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/production-partners | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/readiness-state-definitions | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/readiness-state-definitions | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/sections | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/sections | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/sections/{shop_section_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/sections/{shop_section_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/sections/{shop_section_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/shop-sections/listings | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/shipping-profiles | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/shipping-profiles | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| PUT | /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| POST | /v3/application/scopes | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/transactions/{transaction_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/shops/{shop_id}/transactions | General ReleaseReport bugThis endpoint is ready for production use. |\n| DELETE | /v3/application/user/addresses/{user_address_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/user/addresses/{user_address_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/user/addresses | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/users/{user_id} | General ReleaseReport bugThis endpoint is ready for production use. |\n| GET | /v3/application/users/me | General ReleaseReport bugThis endpoint is ready for production use. |\n\n## Common Questions\n\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all nodes?\" -> GET /v3/application/buyer-taxonomy/nodes\n- \"List all properties?\" -> GET /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties\n- \"Create a listing?\" -> POST /v3/application/shops/{shop_id}/listings\n- \"List all listings?\" -> GET /v3/application/shops/{shop_id}/listings\n- \"Delete a listing?\" -> DELETE /v3/application/listings/{listing_id}\n- \"Get listing details?\" -> GET /v3/application/listings/{listing_id}\n- \"Delete a file?\" -> DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}\n- \"Get file details?\" -> GET /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}\n- \"List all files?\" -> GET /v3/application/shops/{shop_id}/listings/{listing_id}/files\n- \"Create a file?\" -> POST /v3/application/shops/{shop_id}/listings/{listing_id}/files\n- \"List all active?\" -> GET /v3/application/listings/active\n- \"List all active?\" -> GET /v3/application/shops/{shop_id}/listings/active\n- \"Delete a image?\" -> DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}\n- \"Get image details?\" -> GET /v3/application/listings/{listing_id}/images/{listing_image_id}\n- \"List all images?\" -> GET /v3/application/listings/{listing_id}/images\n- \"Create a image?\" -> POST /v3/application/shops/{shop_id}/listings/{listing_id}/images\n- \"List all inventory?\" -> GET /v3/application/listings/{listing_id}/inventory\n- \"Get product details?\" -> GET /v3/application/listings/{listing_id}/inventory/products/{product_id}\n- \"Get offering details?\" -> GET /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}\n- \"List all batch?\" -> GET /v3/application/listings/batch\n- \"List all featured?\" -> GET /v3/application/shops/{shop_id}/listings/featured\n- \"Create a personalization?\" -> POST /v3/application/shops/{shop_id}/listings/{listing_id}/personalization\n- \"List all personalization?\" -> GET /v3/application/listings/{listing_id}/personalization\n- \"Delete a property?\" -> DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}\n- \"Update a property?\" -> PUT /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}\n- \"Get property details?\" -> GET /v3/application/listings/{listing_id}/properties/{property_id}\n- \"List all properties?\" -> GET /v3/application/shops/{shop_id}/listings/{listing_id}/properties\n- \"List all transactions?\" -> GET /v3/application/shops/{shop_id}/listings/{listing_id}/transactions\n- \"Get translation details?\" -> GET /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}\n- \"Update a translation?\" -> PUT /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}\n- \"Partially update a listing?\" -> PATCH /v3/application/shops/{shop_id}/listings/{listing_id}\n- \"List all variation-images?\" -> GET /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images\n- \"Create a variation-image?\" -> POST /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images\n- \"Delete a video?\" -> DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}\n- \"Get video details?\" -> GET /v3/application/listings/{listing_id}/videos/{video_id}\n- \"List all videos?\" -> GET /v3/application/listings/{listing_id}/videos\n- \"Create a video?\" -> POST /v3/application/shops/{shop_id}/listings/{listing_id}/videos\n- \"Get ledger-entry details?\" -> GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}\n- \"List all ledger-entries?\" -> GET /v3/application/shops/{shop_id}/payment-account/ledger-entries\n- \"List all payments?\" -> GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments\n- \"List all payments?\" -> GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments\n- \"List all payments?\" -> GET /v3/application/shops/{shop_id}/payments\n- \"List all openapi-ping?\" -> GET /v3/application/openapi-ping\n- \"Get receipt details?\" -> GET /v3/application/shops/{shop_id}/receipts/{receipt_id}\n- \"Update a receipt?\" -> PUT /v3/application/shops/{shop_id}/receipts/{receipt_id}\n- \"List all receipts?\" -> GET /v3/application/shops/{shop_id}/receipts\n- \"List all listings?\" -> GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings\n- \"Create a tracking?\" -> POST /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking\n- \"List all transactions?\" -> GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions\n- \"List all reviews?\" -> GET /v3/application/listings/{listing_id}/reviews\n- \"List all reviews?\" -> GET /v3/application/shops/{shop_id}/reviews\n- \"List all nodes?\" -> GET /v3/application/seller-taxonomy/nodes\n- \"List all properties?\" -> GET /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties\n- \"List all shipping-carriers?\" -> GET /v3/application/shipping-carriers\n- \"Get shop details?\" -> GET /v3/application/shops/{shop_id}\n- \"Update a shop?\" -> PUT /v3/application/shops/{shop_id}\n- \"List all shops?\" -> GET /v3/application/users/{user_id}/shops\n- \"List all holiday-preferences?\" -> GET /v3/application/shops/{shop_id}/holiday-preferences\n- \"Update a holiday-preference?\" -> PUT /v3/application/shops/{shop_id}/holiday-preferences/{holiday_id}\n- \"List all shops?\" -> GET /v3/application/shops\n- \"Create a consolidate?\" -> POST /v3/application/shops/{shop_id}/policies/return/consolidate\n- \"Create a return?\" -> POST /v3/application/shops/{shop_id}/policies/return\n- \"List all return?\" -> GET /v3/application/shops/{shop_id}/policies/return\n- \"Delete a return?\" -> DELETE /v3/application/shops/{shop_id}/policies/return/{return_policy_id}\n- \"Get return details?\" -> GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}\n- \"Update a return?\" -> PUT /v3/application/shops/{shop_id}/policies/return/{return_policy_id}\n- \"List all listings?\" -> GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings\n- \"List all production-partners?\" -> GET /v3/application/shops/{shop_id}/production-partners\n- \"Create a readiness-state-definition?\" -> POST /v3/application/shops/{shop_id}/readiness-state-definitions\n- \"List all readiness-state-definitions?\" -> GET /v3/application/shops/{shop_id}/readiness-state-definitions\n- \"Delete a readiness-state-definition?\" -> DELETE /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}\n- \"Get readiness-state-definition details?\" -> GET /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}\n- \"Update a readiness-state-definition?\" -> PUT /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}\n- \"Create a section?\" -> POST /v3/application/shops/{shop_id}/sections\n- \"List all sections?\" -> GET /v3/application/shops/{shop_id}/sections\n- \"Delete a section?\" -> DELETE /v3/application/shops/{shop_id}/sections/{shop_section_id}\n- \"Get section details?\" -> GET /v3/application/shops/{shop_id}/sections/{shop_section_id}\n- \"Update a section?\" -> PUT /v3/application/shops/{shop_id}/sections/{shop_section_id}\n- \"List all listings?\" -> GET /v3/application/shops/{shop_id}/shop-sections/listings\n- \"Create a shipping-profile?\" -> POST /v3/application/shops/{shop_id}/shipping-profiles\n- \"List all shipping-profiles?\" -> GET /v3/application/shops/{shop_id}/shipping-profiles\n- \"Delete a shipping-profile?\" -> DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}\n- \"Get shipping-profile details?\" -> GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}\n- \"Update a shipping-profile?\" -> PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}\n- \"Create a destination?\" -> POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations\n- \"List all destinations?\" -> GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations\n- \"Delete a destination?\" -> DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}\n- \"Update a destination?\" -> PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}\n- \"Create a upgrade?\" -> POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades\n- \"List all upgrades?\" -> GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades\n- \"Delete a upgrade?\" -> DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}\n- \"Update a upgrade?\" -> PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}\n- \"Create a scope?\" -> POST /v3/application/scopes\n- \"Get transaction details?\" -> GET /v3/application/shops/{shop_id}/transactions/{transaction_id}\n- \"List all transactions?\" -> GET /v3/application/shops/{shop_id}/transactions\n- \"Delete a address?\" -> DELETE /v3/application/user/addresses/{user_address_id}\n- \"Get address details?\" -> GET /v3/application/user/addresses/{user_address_id}\n- \"List all addresses?\" -> GET /v3/application/user/addresses\n- \"Get user details?\" -> GET /v3/application/users/{user_id}\n- \"List all me?\" -> GET /v3/application/users/me\n- \"How to authenticate?\" -> See Auth section\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- List endpoints may support pagination; check for limit, offset, or cursor params\n- Create/update endpoints typically return the created/updated object\n\n## CLI\n\n```bash\n# Update this spec to the latest version\nnpx @lap-platform/lapsh get etsy-open-api-v3 -o references/api-spec.lap\n\n# Search for related APIs\nnpx @lap-platform/lapsh search etsy-open-api-v3\n```\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Etsy Open API v3\n@base https://openapi.etsy.com\n@version 3.0.0\n@auth ApiKey x-api-key in header | OAuth2\n@endpoints 103\n@hint download_for_search\n@toc application(103)\n\n@endpoint GET /v3/application/buyer-taxonomy/nodes\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@returns(200) {count: int, results: [any]} # List the full hierarchy tree of buyer taxonomy nodes.\n@errors {500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {taxonomy_id: int(int64) # The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\".}\n@returns(200) {count: int, results: [any]} # A list of product properties, with applicable scales and values.\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(201) {listing_id: int(int64), user_id: int(int64), shop_id: int(int64), title: str, description: str, state: str, creation_timestamp: int, created_timestamp: int, ending_timestamp: int, original_creation_timestamp: int, last_modified_timestamp: int, updated_timestamp: int, state_timestamp: int?, quantity: int, shop_section_id: int(int64)?, featured_rank: int, url: str, num_favorers: int, non_taxable: bool, is_taxable: bool, is_customizable: bool, is_personalizable: bool, personalization_is_required: bool, personalization_char_count_max: int?, personalization_instructions: str?, listing_type: str, tags: [str], materials: [str], shipping_profile_id: int(int64)?, return_policy_id: int(int64)?, processing_min: int?, processing_max: int?, who_made: str?, when_made: str?, is_supply: bool?, item_weight: num(float)?, item_weight_unit: str?, item_length: num(float)?, item_width: num(float)?, item_height: num(float)?, item_dimensions_unit: str?, is_private: bool, style: [str], file_data: str?, has_variations: bool, should_auto_renew: bool, language: str?, price: any, taxonomy_id: int?, readiness_state_id: int(int64)?, suggested_title: str?} # A single ShopListing\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {state: str(active/inactive/sold_out/draft/expired)=active # When _updating_ a listing, this value can be either `active` or `inactive`. Note: Setting a `draft` listing to `active` will also publish the listing on etsy.com and requires that the listing have an image set. Setting a `sold_out` listing to active will update the quantity to 1 and renew the listing on etsy.com., limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., sort_on: str(created/price/updated/score)=created # The value to sort a search result of listings on. NOTES: a) `sort_on` only works when combined with one of the search options (keywords, region, etc.). b) when using `score` the returned results will always be in _descending_ order, regardless of the `sort_order` parameter., sort_order: str(asc/ascending/desc/descending/up/down)=desc # The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.)., includes: [str]=null # An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of Listings\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/listings/{listing_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(204) The Listing resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@optional {includes: [str]=null # An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'., language: str=null # The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles., allow_suggested_title: bool # This parameter will include in the response a suggested title for the listing, if one is available. Since suggestions are only available to the listing's owner, client must submit an oauth_access_token scoped to the owner of the listing.}\n@returns(200) {listing_id: int(int64), user_id: int(int64), shop_id: int(int64), title: str, description: str, state: str, creation_timestamp: int, created_timestamp: int, ending_timestamp: int, original_creation_timestamp: int, last_modified_timestamp: int, updated_timestamp: int, state_timestamp: int?, quantity: int, shop_section_id: int(int64)?, featured_rank: int, url: str, num_favorers: int, non_taxable: bool, is_taxable: bool, is_customizable: bool, is_personalizable: bool, personalization_is_required: bool, personalization_char_count_max: int?, personalization_instructions: str?, listing_type: str, tags: [str], materials: [str], shipping_profile_id: int(int64)?, return_policy_id: int(int64)?, processing_min: int?, processing_max: int?, who_made: str?, when_made: str?, is_supply: bool?, item_weight: num(float)?, item_weight_unit: str?, item_length: num(float)?, item_width: num(float)?, item_height: num(float)?, item_dimensions_unit: str?, is_private: bool, style: [str], file_data: str?, has_variations: bool, should_auto_renew: bool, language: str?, price: any, taxonomy_id: int?, readiness_state_id: int(int64)?, suggested_title: str?, shipping_profile: any?, user: any?, shop: any?, images: [any], videos: [any], inventory: any?, production_partners: [any], skus: [str], translations: any?, views: int, personalization: any?} # A single Listing.\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., listing_file_id: int(int64) # The unique numeric ID of a file associated with a digital listing.}\n@returns(204) The ShopListingFile resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., listing_file_id: int(int64) # The unique numeric ID of a file associated with a digital listing.}\n@returns(200) {listing_file_id: int(int64), listing_id: int(int64), rank: int, filename: str, filesize: str, size_bytes: int, filetype: str, create_timestamp: int, created_timestamp: int} # The metatdata for a file associated with a digital listing.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/{listing_id}/files\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {count: int, results: [any]} # A list of metadata objects for the file resources associated with a listing.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings/{listing_id}/files\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(201) {listing_file_id: int(int64), listing_id: int(int64), rank: int, filename: str, filesize: str, size_bytes: int, filetype: str, create_timestamp: int, created_timestamp: int} # The metadata for a file associated with a digital listing.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/active\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., keywords: str=null # Search term or phrase that must appear in all results., sort_on: str(created/price/updated/score)=created # The value to sort a search result of listings on. NOTES: a) `sort_on` only works when combined with one of the search options (keywords, region, etc.). b) when using `score` the returned results will always be in _descending_ order, regardless of the `sort_order` parameter., sort_order: str(asc/ascending/desc/descending/up/down)=desc # The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.)., min_price: num(float)=null # The minimum price of listings to be returned by a search result., max_price: num(float)=null # The maximum price of listings to be returned by a search result., taxonomy_id: int(int64)=null # The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information., shop_location: str=null # Filters by shop location. If location cannot be parsed, Etsy responds with an error., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles., is_safe: bool # When true, filters out mature/adult content from search results.}\n@returns(200) {count: int, results: [any]} # A list of all active listings on Etsy paginated by their creation date. Without sort_order listings will be returned newest-first by default.\n@errors {404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/active\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {limit: int=25 # The maximum number of results to return., sort_on: str(created/price/updated/score)=created # The value to sort a search result of listings on. NOTES: a) `sort_on` only works when combined with one of the search options (keywords, region, etc.). b) when using `score` the returned results will always be in _descending_ order, regardless of the `sort_order` parameter., sort_order: str(asc/ascending/desc/descending/up/down)=desc # The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.)., offset: int=0 # The number of records to skip before selecting the first result., keywords: str=null # Search term or phrase that must appear in all results., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # Retrieves a list of all active listings on Etsy in a specific shop, paginated by listing creation date.\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., listing_image_id: int(int64) # The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.}\n@returns(204) The ListingImage resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/images/{listing_image_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., listing_image_id: int(int64) # The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.}\n@returns(200) {listing_id: int(int64), listing_image_id: int(int64), hex_code: str?, red: int?, green: int?, blue: int?, hue: int?, saturation: int?, brightness: int?, is_black_and_white: bool?, creation_tsz: int, created_timestamp: int, rank: int, url_75x75: str, url_170x135: str, url_570xN: str, url_fullxfull: str, full_height: int?, full_width: int?, alt_text: str?} # A single ListingImage\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/images\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(200) {count: int, results: [any]} # An array of ListingImage\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings/{listing_id}/images\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(201) {listing_id: int(int64), listing_image_id: int(int64), hex_code: str?, red: int?, green: int?, blue: int?, hue: int?, saturation: int?, brightness: int?, is_black_and_white: bool?, creation_tsz: int, created_timestamp: int, rank: int, url_75x75: str, url_170x135: str, url_570xN: str, url_fullxfull: str, full_height: int?, full_width: int?, alt_text: str?} # A single ListingImage\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/inventory\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@optional {show_deleted: bool # A boolean value for inventory whether to include deleted products and their offerings. Default value is false., includes: str # An enumerated string that attaches a valid association. Default value is null., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {products: [any], price_on_property: [int], quantity_on_property: [int], sku_on_property: [int], readiness_state_on_property: [int(int64)], listing: any} # A single listing inventory record.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 422: There was a problem processing your request. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/listings/{listing_id}/inventory\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., products: [map{sku: str, property_values: [map], offerings!: [map]}] # A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles., price_on_property: [int] # An array of unique [listing property](/documentation/reference#operation/getListingProperties) ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size., quantity_on_property: [int] # An array of unique [listing property](/documentation/reference#operation/getListingProperties) ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color., sku_on_property: [int] # An array of unique [listing property](/documentation/reference#operation/getListingProperties) ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for different colored products in the same listing, then this array contains the property ID for color., readiness_state_on_property: [int(int64)] # An array of unique [listing property](/documentation/reference#operation/getListingProperties) ID integers for the properties that change processing profile, if any. For example, if you need specific processing profiles for different colored products in the same listing, then this array contains the property ID for color.}\n@returns(200) {products: [any], price_on_property: [int], quantity_on_property: [int], sku_on_property: [int], readiness_state_on_property: [int(int64)]} # A single listing's inventory record.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/inventory/products/{product_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The listing to return a ListingProduct for., product_id: int(int64) # The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {product_id: int(int64), sku: str, is_deleted: bool, offerings: [any], property_values: [any]} # A single ListingInventoryProduct\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64), product_id: int(int64), product_offering_id: int(int64)}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {offering_id: int(int64), quantity: int, is_enabled: bool, is_deleted: bool, price: any, readiness_state_id: int(int64)?} # A single ListingInventoryProductOffering\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/batch\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_ids: [int(int64)] # The list of numeric IDS for the listings in a specific Etsy shop.}\n@optional {includes: [str]=null # An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of Listings\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/featured\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of Listings\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/personalization\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(204) The ListingPersonalization resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings/{listing_id}/personalization\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., personalization_questions: [map{question_id: int(int64), question_text!: str, instructions: str, question_type!: str, required!: bool, max_allowed_files: int, max_allowed_characters: int, options: [map]}]}\n@optional {supports_multiple_personalization_questions: bool # This query parameter indicates that the caller supports up to 5 personalization questions and the following question types: 'text_input', 'dropdown', 'unlabeled_upload', 'labeled_upload'. Sending this param without updating your application can lead to inadvertantly deleting seller-entered data.}\n@returns(201) {personalization_questions: [map]} # A single Listing Personalization record\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/personalization\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(200) {personalization_questions: [map]} # A listing personalization questions\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., property_id: int(int64) # The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).}\n@returns(204) The ListingProperty resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., property_id: int(int64) # The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).}\n@returns(200) {property_id: int(int64), property_name: str?, scale_id: int(int64)?, scale_name: str?, value_ids: [int(int64)], values: [str]} # A single listing property.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/properties/{property_id}\n@desc Feedback only Give feedbackDevelopment for this endpoint is in progress. It will only return a 501 response.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., property_id: int(int64) # The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).}\n@returns(200) {property_id: int(int64), property_name: str?, scale_id: int(int64)?, scale_name: str?, value_ids: [int(int64)], values: [str]} # A single ListingProperty.\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details., 501: This endpoint is not functional at this time.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/{listing_id}/properties\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(200) {count: int, results: [map]} # A Listing's Properties\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/{listing_id}/transactions\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of transactions\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., language: str # The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.}\n@returns(200) {listing_id: int(int64), language: str, title: str?, description: str?, tags: [str]} # A single ListingTranslation\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., language: str # The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.}\n@returns(200) {listing_id: int(int64), language: str, title: str?, description: str?, tags: [str]} # A single ListingTranslation\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., language: str # The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.}\n@returns(200) {listing_id: int(int64), language: str, title: str?, description: str?, tags: [str]} # A single ListingTranslation\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PATCH /v3/application/shops/{shop_id}/listings/{listing_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {listing_id: int(int64), user_id: int(int64), shop_id: int(int64), title: str, description: str, state: str, creation_timestamp: int, created_timestamp: int, ending_timestamp: int, original_creation_timestamp: int, last_modified_timestamp: int, updated_timestamp: int, state_timestamp: int?, quantity: int, shop_section_id: int(int64)?, featured_rank: int, url: str, num_favorers: int, non_taxable: bool, is_taxable: bool, is_customizable: bool, is_personalizable: bool, personalization_is_required: bool, personalization_char_count_max: int?, personalization_instructions: str?, listing_type: str, tags: [str], materials: [str], shipping_profile_id: int(int64)?, return_policy_id: int(int64)?, processing_min: int?, processing_max: int?, who_made: str?, when_made: str?, is_supply: bool?, item_weight: num(float)?, item_weight_unit: str?, item_length: num(float)?, item_width: num(float)?, item_height: num(float)?, item_dimensions_unit: str?, is_private: bool, style: [str], file_data: str?, has_variations: bool, should_auto_renew: bool, language: str?, price: any, taxonomy_id: int?, readiness_state_id: int(int64)?, suggested_title: str?} # A single ShopListing\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(200) {count: int, results: [map]} # A list of ListingVariationImages\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., variation_images: [map{property_id!: int(int64), value_id!: int(int64), image_id!: int(int64)}] # A list of variation image data.}\n@returns(200) {count: int, results: [map]} # A single ListingVariationImage\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction., video_id: int(int64) # The unique ID of a video associated with a listing.}\n@returns(204) The ListingVideo resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/videos/{video_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {video_id: int(int64) # The unique ID of a video associated with a listing., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(200) {video_id: int(int64), height: int, width: int, thumbnail_url: str, video_url: str, video_state: str} # The metatdata for a video associated with a listing.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/videos\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(200) {count: int, results: [any]} # A list of videos for a listing\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/listings/{listing_id}/videos\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@returns(201) {video_id: int(int64), height: int, width: int, thumbnail_url: str, video_url: str, video_state: str} # The metadata for a file associated with a digital listing.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., ledger_entry_id: int(int64) # The unique ID of the shop owner ledger entry.}\n@returns(200) {entry_id: int(int64), ledger_id: int(int64), sequence_number: int, amount: int, currency: str, description: str, balance: int, create_date: int, created_timestamp: int, ledger_type: str, reference_type: str, reference_id: str?, parent_entry_id: int, payment_adjustments: [any]} # A single of PaymentAccountLedgerEntry\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/payment-account/ledger-entries\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., min_created: int # The earliest unix timestamp for when a record was created., max_created: int # The latest unix timestamp for when a record was created.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result.}\n@returns(200) {count: int, results: [any]} # A list of PaymentAccountLedgerEntries\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., ledger_entry_ids: [int(int64)]}\n@returns(200) {count: int, results: [any]} # A list of Payments\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., receipt_id: int(int64) # The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.}\n@returns(200) {count: int, results: [any]} # A single payment\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/payments\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., payment_ids: [int(int64)] # A comma-separated array of Payment IDs numbers.}\n@returns(200) {count: int, results: [any]} # A list of payments from a specific shop.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/openapi-ping\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@returns(200) {application_id: int(int64)} # A confirmation that the current application has access to the Open API\n@errors {401: Missing or invalid API key., 404: App does not have the proper permissions to access this resource., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/receipts/{receipt_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., receipt_id: int(int64) # The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {receipt_id: int(int64), receipt_type: int, seller_user_id: int(int64), seller_email: str(email)?, buyer_user_id: int(int64), buyer_email: str?, name: str, first_line: str?, second_line: str?, city: str?, state: str?, zip: str?, status: str, formatted_address: str?, country_iso: str?, payment_method: str, payment_email: str?, message_from_seller: str?, message_from_buyer: str?, message_from_payment: str?, is_paid: bool, is_shipped: bool, create_timestamp: int, created_timestamp: int, update_timestamp: int, updated_timestamp: int, is_gift: bool, gift_message: str, gift_sender: str, grandtotal: any, subtotal: any, total_price: any, total_shipping_cost: any, total_tax_cost: any, total_vat_cost: any, discount_amt: any, gift_wrap_price: any, shipments: [any], transactions: [any], refunds: [any]} # A single Shop Receipt\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/receipts/{receipt_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., receipt_id: int(int64) # The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {receipt_id: int(int64), receipt_type: int, seller_user_id: int(int64), seller_email: str(email)?, buyer_user_id: int(int64), buyer_email: str?, name: str, first_line: str?, second_line: str?, city: str?, state: str?, zip: str?, status: str, formatted_address: str?, country_iso: str?, payment_method: str, payment_email: str?, message_from_seller: str?, message_from_buyer: str?, message_from_payment: str?, is_paid: bool, is_shipped: bool, create_timestamp: int, created_timestamp: int, update_timestamp: int, updated_timestamp: int, is_gift: bool, gift_message: str, gift_sender: str, grandtotal: any, subtotal: any, total_price: any, total_shipping_cost: any, total_tax_cost: any, total_vat_cost: any, discount_amt: any, gift_wrap_price: any, shipments: [any], transactions: [any], refunds: [any]} # Update A Shop Receipt\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/receipts\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {min_created: int=null # The earliest unix timestamp for when a record was created., max_created: int=null # The latest unix timestamp for when a record was created., min_last_modified: int=null # The earliest unix timestamp for when a record last changed., max_last_modified: int=null # The latest unix timestamp for when a record last changed., limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., sort_on: str(created/updated/receipt_id)=created # The value to sort a search result of listings on., sort_order: str(asc/ascending/desc/descending/up/down)=desc # The ascending(up) or descending(down) order to sort receipts by., was_paid: bool # When `true`, returns receipts where the seller has recieved payment for the receipt. When `false`, returns receipts where payment has not been received., was_shipped: bool # When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set., was_delivered: bool # When `true`, returns receipts that have been marked as delivered. When `false`, returns receipts where shipment has not been marked as delivered., was_canceled: bool # When `true`, the endpoint will only return the canceled receipts. When `false`, the endpoint will only return non-canceled receipts., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of Shop Receipts\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {receipt_id: int(int64) # The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction., shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A set of ShopListing resources.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., receipt_id: int(int64) # The receipt to submit tracking for.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {receipt_id: int(int64), receipt_type: int, seller_user_id: int(int64), seller_email: str(email)?, buyer_user_id: int(int64), buyer_email: str?, name: str, first_line: str?, second_line: str?, city: str?, state: str?, zip: str?, status: str, formatted_address: str?, country_iso: str?, payment_method: str, payment_email: str?, message_from_seller: str?, message_from_buyer: str?, message_from_payment: str?, is_paid: bool, is_shipped: bool, create_timestamp: int, created_timestamp: int, update_timestamp: int, updated_timestamp: int, is_gift: bool, gift_message: str, gift_sender: str, grandtotal: any, subtotal: any, total_price: any, total_shipping_cost: any, total_tax_cost: any, total_vat_cost: any, discount_amt: any, gift_wrap_price: any, shipments: [any], transactions: [any], refunds: [any]} # A single ShopReceipt\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., receipt_id: int(int64) # The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of transactions\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/listings/{listing_id}/reviews\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {listing_id: int(int64) # The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., min_created: int # The earliest unix timestamp for when a record was created., max_created: int # The latest unix timestamp for when a record was created.}\n@returns(200) {count: int, results: [any]} # A set of Transaction Reviews by Listing ID\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/reviews\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., min_created: int # The earliest unix timestamp for when a record was created., max_created: int # The latest unix timestamp for when a record was created.}\n@returns(200) {count: int, results: [any]} # A set of Transaction Reviews By Shop ID\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/seller-taxonomy/nodes\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@returns(200) {count: int, results: [any]} # List the full hierarchy tree of seller taxonomy nodes.\n@errors {500: The server encountered an internal error. See the error message for details., 503: The service is unavailable}\n\n@endpoint GET /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {taxonomy_id: int(int64) # The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\".}\n@returns(200) {count: int, results: [any]} # A list of product properties, with applicable scales and values.\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shipping-carriers\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {origin_country_iso: str(ISO 3166-1 alpha-2) # The ISO code of the country from which the listing ships.}\n@returns(200) {count: int, results: [map]} # A set of ShippingCarriers\n@errors {400: There was a problem with the request data. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {shop_id: int(int64), user_id: int(int64), shop_name: str, create_date: int, created_timestamp: int, title: str?, announcement: str?, currency_code: str, is_vacation: bool, vacation_message: str?, sale_message: str?, digital_sale_message: str?, update_date: int, updated_timestamp: int, listing_active_count: int, digital_listing_count: int, login_name: str, accepts_custom_requests: bool, policy_welcome: str?, policy_payment: str?, policy_shipping: str?, policy_refunds: str?, policy_additional: str?, policy_seller_info: str?, policy_update_date: int, policy_has_private_receipt_info: bool, has_unstructured_policies: bool, policy_privacy: str?, vacation_autoreply: str?, url: str, image_url_760x100: str?, num_favorers: int, languages: [str], icon_url_fullxfull: str?, is_using_structured_policies: bool, has_onboarded_structured_policies: bool, include_dispute_form_link: bool, is_direct_checkout_onboarded: bool, is_etsy_payments_onboarded: bool, is_calculated_eligible: bool, is_opted_in_to_buyer_promise: bool, is_shop_us_based: bool, transaction_sold_count: int, shipping_from_country_iso: str(ISO 3166-1 alpha-2)?, shop_location_country_iso: str(ISO 3166-1 alpha-2)?, review_count: int?, review_average: num(float)?} # A single Shop\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {shop_id: int(int64), user_id: int(int64), shop_name: str, create_date: int, created_timestamp: int, title: str?, announcement: str?, currency_code: str, is_vacation: bool, vacation_message: str?, sale_message: str?, digital_sale_message: str?, update_date: int, updated_timestamp: int, listing_active_count: int, digital_listing_count: int, login_name: str, accepts_custom_requests: bool, policy_welcome: str?, policy_payment: str?, policy_shipping: str?, policy_refunds: str?, policy_additional: str?, policy_seller_info: str?, policy_update_date: int, policy_has_private_receipt_info: bool, has_unstructured_policies: bool, policy_privacy: str?, vacation_autoreply: str?, url: str, image_url_760x100: str?, num_favorers: int, languages: [str], icon_url_fullxfull: str?, is_using_structured_policies: bool, has_onboarded_structured_policies: bool, include_dispute_form_link: bool, is_direct_checkout_onboarded: bool, is_etsy_payments_onboarded: bool, is_calculated_eligible: bool, is_opted_in_to_buyer_promise: bool, is_shop_us_based: bool, transaction_sold_count: int, shipping_from_country_iso: str(ISO 3166-1 alpha-2)?, shop_location_country_iso: str(ISO 3166-1 alpha-2)?, review_count: int?, review_average: num(float)?} # A single Shop.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/users/{user_id}/shops\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {user_id: int(int64) # The numeric user ID of the [user](/documentation/reference#tag/User) who owns this shop.}\n@returns(200) {shop_id: int(int64), user_id: int(int64), shop_name: str, create_date: int, created_timestamp: int, title: str?, announcement: str?, currency_code: str, is_vacation: bool, vacation_message: str?, sale_message: str?, digital_sale_message: str?, update_date: int, updated_timestamp: int, listing_active_count: int, digital_listing_count: int, login_name: str, accepts_custom_requests: bool, policy_welcome: str?, policy_payment: str?, policy_shipping: str?, policy_refunds: str?, policy_additional: str?, policy_seller_info: str?, policy_update_date: int, policy_has_private_receipt_info: bool, has_unstructured_policies: bool, policy_privacy: str?, vacation_autoreply: str?, url: str, image_url_760x100: str?, num_favorers: int, languages: [str], icon_url_fullxfull: str?, is_using_structured_policies: bool, has_onboarded_structured_policies: bool, include_dispute_form_link: bool, is_direct_checkout_onboarded: bool, is_etsy_payments_onboarded: bool, is_calculated_eligible: bool, is_opted_in_to_buyer_promise: bool, is_shop_us_based: bool, transaction_sold_count: int, shipping_from_country_iso: str(ISO 3166-1 alpha-2)?, shop_location_country_iso: str(ISO 3166-1 alpha-2)?, review_count: int?, review_average: num(float)?} # A single Shop\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/holiday-preferences\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) A list of holiday preferences\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/holiday-preferences/{holiday_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., holiday_id: int(1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/27/28/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44/45/46/47/48/49/50/51/52/53/54/55/56/57/58/59/60/61/62/63/64/65/66/67/68/69/70/71/72/73/74/75/76/77/78/79/80/81/82/83/84/85/86/87/88/89/90/91/92/93/94/95/96/97/98/99/100/101/102/103/104/105) # The unique id that maps to the holiday a country observes. See the [Fulfillment Tutorial docs](https://developer.etsy.com/documentation/tutorials/fulfillment/#country-holidays) for more info}\n@returns(200) {shop_id: int(int64), holiday_id: int, country_iso: str(ISO 3166-1 alpha-2), is_working: bool, holiday_name: str} # The updated holiday preferences\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_name: str # The shop's name string.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result.}\n@returns(200) {count: int, results: [any]} # A list of Shops\n@errors {500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/policies/return/consolidate\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {return_policy_id: int(int64), shop_id: int(int64), accepts_returns: bool, accepts_exchanges: bool, return_deadline: int?} # The updated target Return Policy\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/policies/return\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {return_policy_id: int(int64), shop_id: int(int64), accepts_returns: bool, accepts_exchanges: bool, return_deadline: int?} # A single Return Policy\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/policies/return\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {count: int, results: [map]} # List of shop's Return Policies\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/policies/return/{return_policy_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., return_policy_id: int(int64) # The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).}\n@returns(204) The Return Policy was successfully deleted.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., return_policy_id: int(int64) # The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).}\n@returns(200) {return_policy_id: int(int64), shop_id: int(int64), accepts_returns: bool, accepts_exchanges: bool, return_deadline: int?} # A single Return Policy\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/policies/return/{return_policy_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., return_policy_id: int(int64) # The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).}\n@returns(200) {return_policy_id: int(int64), shop_id: int(int64), accepts_returns: bool, accepts_exchanges: bool, return_deadline: int?} # An updated Return Policy\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {return_policy_id: int(int64) # The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies)., shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A set of ShopListing resources.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/production-partners\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {count: int, results: [any]} # A list of shop production partners\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/readiness-state-definitions\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(201) {shop_id: int(int64), readiness_state_id: int(int64), readiness_state: str, min_processing_days: int, max_processing_days: int, processing_days_display_label: str} # A single ReadinessStateDefinition\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/readiness-state-definitions\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result.}\n@returns(200) {count: int, results: [map]} # A list of ProcessingProfiles\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., readiness_state_definition_id: int(int64) # The numeric ID of the [processing profile](/documentation/reference#operation/getShopReadinessStateDefinition) associated with the listing. Returned only when the listing is `active` and of type `physical`, and the endpoint is either shop-scoped (path contains `shop_id`) or a single-listing request such as `getListing`. For every other case this field can be null.}\n@returns(204) The ReadinessStateDefinition was successfully deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., readiness_state_definition_id: int(int64) # The numeric ID of the [processing profile](/documentation/reference#operation/getShopReadinessStateDefinition) associated with the listing. Returned only when the listing is `active` and of type `physical`, and the endpoint is either shop-scoped (path contains `shop_id`) or a single-listing request such as `getListing`. For every other case this field can be null.}\n@returns(200) {shop_id: int(int64), readiness_state_id: int(int64), readiness_state: str, min_processing_days: int, max_processing_days: int, processing_days_display_label: str} # A single ProcessingProfile\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., readiness_state_definition_id: int(int64) # The numeric ID of the [processing profile](/documentation/reference#operation/getShopReadinessStateDefinition) associated with the listing. Returned only when the listing is `active` and of type `physical`, and the endpoint is either shop-scoped (path contains `shop_id`) or a single-listing request such as `getListing`. For every other case this field can be null.}\n@returns(200) {shop_id: int(int64), readiness_state_id: int(int64), readiness_state: str, min_processing_days: int, max_processing_days: int, processing_days_display_label: str} # The updated ReadinessStateDefinition\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 409: There was a request conflict with the current state of the target resource. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/sections\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {shop_section_id: int(int64), title: str, rank: int, user_id: int(int64), active_listing_count: int} # A Shop Section resource\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details., 503: This function is temporarily unavailable. Please try again later.}\n\n@endpoint GET /v3/application/shops/{shop_id}/sections\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {count: int, results: [any]} # A list of shop sections.\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/sections/{shop_section_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shop_section_id: int(int64) # The numeric ID of a section in a specific Etsy shop.}\n@returns(204) The shop section resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details., 503: This function is temporarily unavailable. Please try again later.}\n\n@endpoint GET /v3/application/shops/{shop_id}/sections/{shop_section_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shop_section_id: int(int64) # The numeric ID of a section in a specific Etsy shop.}\n@returns(200) {shop_section_id: int(int64), title: str, rank: int, user_id: int(int64), active_listing_count: int} # A shop section resource\n@errors {400: There was a problem with the request data. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/sections/{shop_section_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shop_section_id: int(int64) # The numeric ID of a section in a specific Etsy shop.}\n@returns(200) {shop_section_id: int(int64), title: str, rank: int, user_id: int(int64), active_listing_count: int} # A Shop Section resource\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details., 503: This function is temporarily unavailable. Please try again later.}\n\n@endpoint GET /v3/application/shops/{shop_id}/shop-sections/listings\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shop_section_ids: [int(int64)] # A list of numeric IDS for all sections in a specific Etsy shop.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., sort_on: str(created/price/updated/score)=created # The value to sort a search result of listings on. NOTES: a) `sort_on` only works when combined with one of the search options (keywords, region, etc.). b) when using `score` the returned results will always be in _descending_ order, regardless of the `sort_order` parameter., sort_order: str(asc/ascending/desc/descending/up/down)=desc # The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.)., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of listings from a shop section.\n@errors {400: There was a problem with the request data. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint POST /v3/application/shops/{shop_id}/shipping-profiles\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {shipping_profile_id: int(int64), title: str?, user_id: int(int64), origin_country_iso: str(ISO 3166-1 alpha-2), is_deleted: bool, shipping_profile_destinations: [any], shipping_profile_upgrades: [any], origin_postal_code: str?, profile_type: str, domestic_handling_fee: num(float), international_handling_fee: num(float)} # A single ShippingProfile\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/shipping-profiles\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@returns(200) {count: int, results: [map]} # A list of shipping profiles\n@errors {400: There was a problem with the request data. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@returns(204) The ShopShippingProfile resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@returns(200) {shipping_profile_id: int(int64), title: str?, user_id: int(int64), origin_country_iso: str(ISO 3166-1 alpha-2), is_deleted: bool, shipping_profile_destinations: [any], shipping_profile_upgrades: [any], origin_postal_code: str?, profile_type: str, domestic_handling_fee: num(float), international_handling_fee: num(float)} # A single ShippingProfile\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@returns(200) {shipping_profile_id: int(int64), title: str?, user_id: int(int64), origin_country_iso: str(ISO 3166-1 alpha-2), is_deleted: bool, shipping_profile_destinations: [any], shipping_profile_upgrades: [any], origin_postal_code: str?, profile_type: str, domestic_handling_fee: num(float), international_handling_fee: num(float)} # The updated shipping profile.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details., 503: This function is temporarily unavailable. Please try again later.}\n\n@endpoint POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@returns(201) {shipping_profile_destination_id: int(int64), shipping_profile_id: int(int64), origin_country_iso: str(ISO 3166-1 alpha-2), destination_country_iso: str, destination_region: str, primary_cost: any, secondary_cost: any, shipping_carrier_id: int?, mail_class: str?, min_delivery_days: int?, max_delivery_days: int?} # A single shipping destination.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result.}\n@returns(200) {count: int, results: [any]} # A list of shipping destination objects.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`., shipping_profile_destination_id: int(int64) # The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.}\n@returns(204) Etsy deleted the shipping profile destination.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`., shipping_profile_destination_id: int(int64) # The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.}\n@returns(200) {shipping_profile_destination_id: int(int64), shipping_profile_id: int(int64), origin_country_iso: str(ISO 3166-1 alpha-2), destination_country_iso: str, destination_region: str, primary_cost: any, secondary_cost: any, shipping_carrier_id: int?, mail_class: str?, min_delivery_days: int?, max_delivery_days: int?} # A single shipping destination.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details., 503: This function is temporarily unavailable. Please try again later.}\n\n@endpoint POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@returns(200) {shipping_profile_id: int(int64), upgrade_id: int(int64), upgrade_name: str, type: int, rank: int, language: str, price: any, secondary_price: any, shipping_carrier_id: int?, mail_class: str?, min_delivery_days: int?, max_delivery_days: int?} # A single shipping profile upgrade.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.}\n@returns(200) {count: int, results: [any]} # A list of shipping profile upgrades.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the shipping profile., upgrade_id: int(int64) # The numeric ID that is associated with a shipping upgrade}\n@returns(204) Etsy deleted the shipping profile upgrade.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., shipping_profile_id: int(int64) # The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`., upgrade_id: int(int64) # The numeric ID that is associated with a shipping upgrade}\n@returns(200) {shipping_profile_id: int(int64), upgrade_id: int(int64), upgrade_name: str, type: int, rank: int, language: str, price: any, secondary_price: any, shipping_carrier_id: int?, mail_class: str?, min_delivery_days: int?, max_delivery_days: int?} # A single shipping profile upgrade.\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details., 503: This function is temporarily unavailable. Please try again later.}\n\n@endpoint POST /v3/application/scopes\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@returns(200) A confirmation that the current application has access to the Open API\n@errors {401: Missing or invalid API key., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/transactions/{transaction_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop., transaction_id: int(int64) # The unique numeric ID for a transaction.}\n@returns(200) {transaction_id: int(int64), title: str?, description: str?, seller_user_id: int(int64), buyer_user_id: int(int64), create_timestamp: int, created_timestamp: int, paid_timestamp: int?, shipped_timestamp: int?, quantity: int, listing_image_id: int(int64)?, receipt_id: int(int64), is_digital: bool, file_data: str, listing_id: int?, transaction_type: str, product_id: int(int64)?, sku: str?, price: any, shipping_cost: any, variations: [any], product_data: [any], shipping_profile_id: int(int64)?, min_processing_days: int?, max_processing_days: int?, shipping_method: str?, shipping_upgrade: str?, expected_ship_date: int?, buyer_coupon: num(float), shop_coupon: num(float)} # A single transaction\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/shops/{shop_id}/transactions\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {shop_id: int(int64) # The unique positive non-zero numeric ID for an Etsy Shop.}\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result., legacy: bool # This parameter needed to enable new parameters and response values related to processing profiles.}\n@returns(200) {count: int, results: [any]} # A list of transactions\n@errors {401: The request lacks valid authentication credentials. See the error message for details., 403: The request attempted to perform an operation it is not allowed to. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint DELETE /v3/application/user/addresses/{user_address_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {user_address_id: int(int64) # The numeric ID of the user's address.}\n@returns(204) The User Address resource was correctly deleted\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/user/addresses/{user_address_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {user_address_id: int(int64) # The numeric ID of the user's address.}\n@returns(200) {user_address_id: int(int64), user_id: int(int64), name: str, first_line: str, second_line: str?, city: str, state: str?, zip: str?, iso_country_code: str?, country_name: str?, is_default_shipping_address: bool} # A single UserAddress\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/user/addresses\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@optional {limit: int=25 # The maximum number of results to return., offset: int=0 # The number of records to skip before selecting the first result.}\n@returns(200) {count: int, results: [any]} # A list of UserAddress records\n@errors {401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/users/{user_id}\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@required {user_id: int(int64)}\n@returns(200) {user_id: int(int64), primary_email: str(email)?, first_name: str?, last_name: str?, image_url_75x75: str?} # A single User\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@endpoint GET /v3/application/users/me\n@desc General ReleaseReport bugThis endpoint is ready for production use.\n@returns(200) {user_id: int(int64), shop_id: int(int64)} # Fetches basic info about the requesting user\n@errors {400: There was a problem with the request data. See the error message for details., 401: The request lacks valid authentication credentials. See the error message for details., 404: A resource could not be found. See the error message for details., 500: The server encountered an internal error. See the error message for details.}\n\n@end\n"}}