openapi: 3.0.2
info:
  title: Etsy Open API v3
  description: <div class="wt-text-body-01"><p class="wt-pt-xs-2 wt-pb-xs-2">Etsy's Open API provides a simple RESTful interface for various Etsy.com features.</p><p class="wt-pb-xs-2">If you'd like to report an issue or provide feedback on the API design, <a target="_blank" class="wt-text-link wt-p-xs-0" href="https://github.com/etsy/open-api/discussions">please add an issue in Github</a>.</p></div>&copy; 2021-2026 Etsy, Inc. All Rights Reserved. Use of this code is subject to Etsy's <a class='wt-text-link wt-p-xs-0' target='_blank' href='https://www.etsy.com/legal/api'>API Developer Terms of Use</a>.
  termsOfService: https://www.etsy.com/legal/api
  contact:
    email: developers@etsy.com
  version: 3.0.0
  x-generated-from: https://www.etsy.com/openapi/generated/oas/3.0.0.json
  x-last-validated: '2026-05-30'
servers:
  - url: https://openapi.etsy.com
    description: Etsy Open API v3 base URL (per Etsy developer documentation; live calls also resolve at https://api.etsy.com/v3/application).
security:
  - api_key: []
tags:
  - name: User
  - name: UserAddress
  - name: Shop Receipt Transactions
  - name: Other
  - name: Shop
  - name: Shop ShippingProfile
  - name: Shop Section
  - name: ShopListing
  - name: Shop ProcessingProfiles
  - name: Shop ProductionPartner
  - name: Shop Return Policy
  - name: Shop HolidayPreferences
  - name: SellerTaxonomy
  - name: Review
  - name: Shop Receipt
  - name: Payment
  - name: Ledger Entry
  - name: ShopListing Video
  - name: ShopListing VariationImage
  - name: ShopListing Translation
  - name: ShopListing Personalization
  - name: ShopListing Inventory
  - name: ShopListing Offering
  - name: ShopListing Product
  - name: ShopListing Image
  - name: ShopListing File
  - name: BuyerTaxonomy
x-tagGroups:
  - name: Listing Management
    tags:
      - BuyerTaxonomy
      - SellerTaxonomy
      - ShopListing
      - ShopListing File
      - ShopListing Image
      - ShopListing Inventory
      - ShopListing Offering
      - ShopListing Personalization
      - ShopListing Product
      - ShopListing Translation
      - ShopListing VariationImage
      - ShopListing Video
  - name: Other
    tags:
      - Other
  - name: Payment Management
    tags:
      - Ledger Entry
      - Payment
  - name: Receipt Management
    tags:
      - Shop Receipt
      - Shop Receipt Transactions
  - name: Review Management
    tags:
      - Review
  - name: Shipping Management
    tags:
      - Shop HolidayPreferences
      - Shop ProcessingProfiles
      - Shop ShippingProfile
  - name: Shop Management
    tags:
      - Shop
      - Shop ProductionPartner
      - Shop Section
  - name: Shop Policy Management
    tags:
      - Shop Return Policy
  - name: User Management
    tags:
      - User
      - UserAddress
paths:
  /v3/application/buyer-taxonomy/nodes:
    get:
      operationId: getBuyerTaxonomyNodes
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the full hierarchy tree of buyer taxonomy nodes."
      tags:
        - BuyerTaxonomy
      parameters: []
      responses:
        '200':
          description: List the full hierarchy tree of buyer taxonomy nodes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyerTaxonomyNodes'
              examples:
                GetBuyerTaxonomyNodes200Example:
                  summary: Default getBuyerTaxonomyNodes 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetBuyerTaxonomyNodes500Example:
                  summary: Default getBuyerTaxonomyNodes 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Buyer Taxonomy Nodes
  /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties:
    get:
      operationId: getPropertiesByBuyerTaxonomyId
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of product properties, with applicable scales and values, supported for a specific buyer taxonomy ID."
      tags:
        - BuyerTaxonomy
      parameters:
        - name: taxonomy_id
          in: path
          description: "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\"."
          required: true
          schema:
            type: integer
            description: "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\"."
            format: int64
            minimum: 1
          example: 1234
      responses:
        '200':
          description: A list of product properties, with applicable scales and values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyerTaxonomyNodeProperties'
              examples:
                GetPropertiesByBuyerTaxonomyId200Example:
                  summary: Default getPropertiesByBuyerTaxonomyId 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPropertiesByBuyerTaxonomyId404Example:
                  summary: Default getPropertiesByBuyerTaxonomyId 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPropertiesByBuyerTaxonomyId400Example:
                  summary: Default getPropertiesByBuyerTaxonomyId 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPropertiesByBuyerTaxonomyId500Example:
                  summary: Default getPropertiesByBuyerTaxonomyId 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Properties by Buyer Taxonomy Id
  /v3/application/shops/{shop_id}/listings:
    post:
      operationId: createDraftListing
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a physical draft [listing](/documentation/reference#tag/ShopListing) product in a shop on the Etsy channel."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - quantity
                - title
                - description
                - price
                - who_made
                - when_made
                - taxonomy_id
              properties:
                quantity:
                  type: integer
                  description: 'The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the [getListingInventory](/documentation/reference#operation/getListingInventory) endpoint.'
                title:
                  type: string
                  description: "The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each."
                description:
                  type: string
                  description: A description string of the product for sale in the listing.
                price:
                  type: number
                  description: 'The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price. The [`getListingInventory`](/documentation/reference/#operation/getListingInventory) method requests exact prices for available offerings.'
                  format: float
                who_made:
                  type: string
                  description: An enumerated string indicating who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.
                  enum:
                    - i_did
                    - someone_else
                    - collective
                when_made:
                  type: string
                  description: An enumerated string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.
                  enum:
                    - made_to_order
                    - '2020_2026'
                    - '2010_2019'
                    - '2007_2009'
                    - before_2007
                    - '2000_2006'
                    - 1990s
                    - 1980s
                    - 1970s
                    - 1960s
                    - 1950s
                    - 1940s
                    - 1930s
                    - 1920s
                    - 1910s
                    - 1900s
                    - 1800s
                    - 1700s
                    - before_1700
                taxonomy_id:
                  type: integer
                  description: The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.
                  format: int64
                  minimum: 1
                shipping_profile_id:
                  type: integer
                  description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
                  format: int64
                  nullable: true
                  minimum: 1
                return_policy_id:
                  type: integer
                  description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
                  format: int64
                  nullable: true
                  minimum: 1
                materials:
                  type: array
                  description: 'A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.'
                  nullable: true
                  items:
                    type: string
                shop_section_id:
                  type: integer
                  description: The numeric ID of the [shop section](/documentation/reference#tag/Shop-Section) for this listing. Default value is null.
                  format: int64
                  nullable: true
                  minimum: 1
                processing_min:
                  type: integer
                  description: The minimum number of days required to process this listing. Default value is null.
                  nullable: true
                processing_max:
                  type: integer
                  description: The maximum number of days required to process this listing. Default value is null.
                  nullable: true
                readiness_state_id:
                  type: integer
                  description: 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.
                  format: int64
                  nullable: true
                  minimum: 1
                tags:
                  type: array
                  description: "A comma-separated list of tag strings for the listing. When creating or updating a listing, valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}\\-'™©®]/u) Default value is null."
                  nullable: true
                  items:
                    type: string
                styles:
                  type: array
                  description: 'An array of style strings for this listing, each of which is free-form text string such as "Formal", or "Steampunk". When creating or updating a listing, the listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Each style string is limited to 45 characters. Default value is null.'
                  nullable: true
                  items:
                    type: string
                item_weight:
                  type: number
                  description: The numeric weight of the product measured in units set in 'item_weight_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_length:
                  type: number
                  description: The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_width:
                  type: number
                  description: The numeric width of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_height:
                  type: number
                  description: The numeric height of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_weight_unit:
                  type: string
                  description: A string defining the units used to measure the weight of the product. Default value is null.
                  nullable: true
                  enum:
                    - oz
                    - lb
                    - g
                    - kg
                item_dimensions_unit:
                  type: string
                  description: A string defining the units used to measure the dimensions of the product. Default value is null.
                  nullable: true
                  enum:
                    - in
                    - ft
                    - mm
                    - cm
                    - m
                    - yd
                    - inches
                is_personalizable:
                  type: boolean
                  description: '[DEPRECATED] When true, this listing is personalizable. The default value is false. NOTE: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details.'
                personalization_is_required:
                  type: boolean
                  description: '[DEPRECATED] When true, this listing requires personalization. The default value is false. NOTE: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details.'
                personalization_char_count_max:
                  type: integer
                  description: "[DEPRECATED] This is an integer value representing the maximum length for the personalization message entered by the buyer. Will only change if is_personalizable is 'true'. Note: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details."
                personalization_instructions:
                  type: string
                  description: "[DEPRECATED] A string representing instructions for the buyer to enter the personalization. Will only change if is_personalizable is 'true'. Note: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details."
                production_partner_ids:
                  type: array
                  description: An array of unique IDs of production partner ids.
                  nullable: true
                  items:
                    type: integer
                    format: int64
                    minimum: 1
                image_ids:
                  type: array
                  description: An array of numeric image IDs of the images in a listing, which can include up to 20 images.
                  nullable: true
                  items:
                    type: integer
                    format: int64
                    minimum: 1
                is_supply:
                  type: boolean
                  description: When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'.
                is_customizable:
                  type: boolean
                  description: When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.
                should_auto_renew:
                  type: boolean
                  description: When true, renews a listing for four months upon expiration.
                is_taxable:
                  type: boolean
                  description: When true, applicable [shop](/documentation/reference#tag/Shop) tax rates apply to this listing at checkout.
                type:
                  type: string
                  description: An enumerated type string that indicates whether the listing is physical or a digital download.
                  enum:
                    - physical
                    - download
                    - both
            examples:
              CreateDraftListingRequestExample:
                summary: Default createDraftListing request
                x-microcks-default: true
                value:
                  quantity: 1
                  title: example string
                  description: example string
                  price: 1.0
                  who_made: i_did
                  when_made: made_to_order
                  taxonomy_id: 1
                  shipping_profile_id: 1
                  return_policy_id: 1
                  materials:
                    - example string
                  shop_section_id: 1
                  processing_min: 1
                  processing_max: 1
                  readiness_state_id: 1
                  tags:
                    - example string
                  styles:
                    - example string
                  item_weight: 1.0
                  item_length: 1.0
                  item_width: 1.0
                  item_height: 1.0
                  item_weight_unit: oz
                  item_dimensions_unit: in
                  is_personalizable: true
                  personalization_is_required: true
                  personalization_char_count_max: 1
                  personalization_instructions: example string
                  production_partner_ids:
                    - 1
                  image_ids:
                    - 1
                  is_supply: true
                  is_customizable: true
                  should_auto_renew: true
                  is_taxable: true
                  type: physical
      responses:
        '201':
          description: A single ShopListing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListing'
              examples:
                CreateDraftListing201Example:
                  summary: Default createDraftListing 201 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    user_id: 456789
                    shop_id: 123456
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    state: active
                    creation_timestamp: 1758153645
                    created_timestamp: 1758153645
                    ending_timestamp: 1758153645
                    original_creation_timestamp: 1758153645
                    last_modified_timestamp: 1758153645
                    updated_timestamp: 1758153645
                    state_timestamp: 1758153645
                    quantity: 1
                    shop_section_id: 1
                    featured_rank: 1
                    url: https://www.etsy.com/listing/123456789
                    num_favorers: 1
                    non_taxable: true
                    is_taxable: true
                    is_customizable: true
                    is_personalizable: true
                    listing_type: physical
                    tags:
                      - example string
                    materials:
                      - example string
                    shipping_profile_id: 1
                    return_policy_id: 1
                    processing_min: 1
                    processing_max: 1
                    who_made: i_did
                    when_made: made_to_order
                    is_supply: true
                    item_weight: 0.5
                    item_weight_unit: oz
                    item_length: 1.0
                    item_width: 1.0
                    item_height: 1.0
                    item_dimensions_unit: in
                    is_private: true
                    style:
                      - example string
                    file_data: example string
                    has_variations: true
                    should_auto_renew: true
                    language: en-US
                    price: example
                    converted_price: example
                    taxonomy_id: 1234
                    readiness_state_id: 1
                    suggested_title: Handmade Ceramic Mug — Stoneware
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateDraftListing400Example:
                  summary: Default createDraftListing 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateDraftListing401Example:
                  summary: Default createDraftListing 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateDraftListing403Example:
                  summary: Default createDraftListing 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateDraftListing404Example:
                  summary: Default createDraftListing 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateDraftListing500Example:
                  summary: Default createDraftListing 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Draft Listing
    get:
      operationId: getListingsByShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nEndpoint to list Listings that belong to a Shop. Listings can be filtered using the 'state' param."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: state
          in: query
          description: '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.'
          required: false
          schema:
            type: string
            description: '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.'
            enum:
              - active
              - inactive
              - sold_out
              - draft
              - expired
            default: active
          example: active
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: sort_on
          in: query
          description: '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.'
          required: false
          schema:
            type: string
            description: '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.'
            enum:
              - created
              - price
              - updated
              - score
            default: created
          example: created
        - name: sort_order
          in: query
          description: '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.).'
          required: false
          schema:
            type: string
            description: '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.).'
            enum:
              - asc
              - ascending
              - desc
              - descending
              - up
              - down
            default: desc
          example: asc
        - name: includes
          in: query
          description: An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'.
          required: false
          schema:
            type: array
            description: An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'.
            items:
              type: string
              enum:
                - Shipping
                - Images
                - Shop
                - User
                - Translations
                - Inventory
                - Videos
                - Personalization
                - BuyerPrice
            default:
          example:
            - Shipping
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of Listings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListingsWithAssociations'
              examples:
                GetListingsByShop200Example:
                  summary: Default getListingsByShop 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShop400Example:
                  summary: Default getListingsByShop 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShop401Example:
                  summary: Default getListingsByShop 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShop403Example:
                  summary: Default getListingsByShop 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShop500Example:
                  summary: Default getListingsByShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listings by Shop
  /v3/application/listings/{listing_id}:
    delete:
      operationId: deleteListing
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to delete a ShopListing. A ShopListing can be deleted only if the state is one of the following:  SOLD_OUT, DRAFT, EXPIRED, INACTIVE, ACTIVE and is_available or ACTIVE and has seller flags:  SUPRESSED (frozen), VACATION, CUSTOM_SHOPS (pattern), SELL_ON_FACEBOOK"
      tags:
        - ShopListing
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListing403Example:
                  summary: Default deleteListing 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListing409Example:
                  summary: Default deleteListing 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '204':
          description: The Listing resource was correctly deleted
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListing404Example:
                  summary: Default deleteListing 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListing400Example:
                  summary: Default deleteListing 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListing401Example:
                  summary: Default deleteListing 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListing500Example:
                  summary: Default deleteListing 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_d
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Listing
    get:
      operationId: getListing
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a listing record by listing ID."
      tags:
        - ShopListing
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: includes
          in: query
          description: An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'.
          required: false
          schema:
            type: array
            description: An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'.
            items:
              type: string
              enum:
                - Shipping
                - Images
                - Shop
                - User
                - Translations
                - Inventory
                - Videos
                - Personalization
                - BuyerPrice
            default:
          example:
            - Shipping
        - name: language
          in: query
          description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          required: false
          schema:
            type: string
            description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
            default:
          example: en-US
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
        - name: allow_suggested_title
          in: query
          description: 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.
          required: false
          schema:
            type: boolean
            description: 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.
          example: true
      responses:
        '200':
          description: A single Listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListingWithAssociations'
              examples:
                GetListing200Example:
                  summary: Default getListing 200 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    user_id: 456789
                    shop_id: 123456
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    state: active
                    creation_timestamp: 1758153645
                    created_timestamp: 1758153645
                    ending_timestamp: 1758153645
                    original_creation_timestamp: 1758153645
                    last_modified_timestamp: 1758153645
                    updated_timestamp: 1758153645
                    state_timestamp: 1758153645
                    quantity: 1
                    shop_section_id: 1
                    featured_rank: 1
                    url: https://www.etsy.com/listing/123456789
                    num_favorers: 1
                    non_taxable: true
                    is_taxable: true
                    is_customizable: true
                    is_personalizable: true
                    listing_type: physical
                    tags:
                      - example string
                    materials:
                      - example string
                    shipping_profile_id: 1
                    return_policy_id: 1
                    processing_min: 1
                    processing_max: 1
                    who_made: i_did
                    when_made: made_to_order
                    is_supply: true
                    item_weight: 0.5
                    item_weight_unit: oz
                    item_length: 1.0
                    item_width: 1.0
                    item_height: 1.0
                    item_dimensions_unit: in
                    is_private: true
                    style:
                      - example string
                    file_data: example string
                    has_variations: true
                    should_auto_renew: true
                    language: en-US
                    price: example
                    converted_price: example
                    taxonomy_id: 1234
                    readiness_state_id: 1
                    suggested_title: Handmade Ceramic Mug — Stoneware
                    shipping_profile: example
                    user: example
                    shop: example
                    images:
                      - 
                    videos:
                      - 
                    inventory: example
                    production_partners:
                      - 
                    skus:
                      - example string
                    translations: example
                    views: 1
                    personalization: example
                    buyer_price: example
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListing404Example:
                  summary: Default getListing 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListing400Example:
                  summary: Default getListing 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListing500Example:
                  summary: Default getListing 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing
  /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}:
    delete:
      operationId: deleteListingFile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a file from a specific listing. When you delete the final file for a digital listing, the listing converts into a physical listing. The response to a delete request returns a list of the remaining file records associated with the given listing."
      tags:
        - ShopListing File
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: listing_file_id
          in: path
          description: The unique numeric ID of a file associated with a digital listing.
          required: true
          schema:
            type: integer
            description: The unique numeric ID of a file associated with a digital listing.
            format: int64
            minimum: 1
          example: 1
      responses:
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingFile409Example:
                  summary: Default deleteListingFile 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingFile404Example:
                  summary: Default deleteListingFile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingFile400Example:
                  summary: Default deleteListingFile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '204':
          description: The ShopListingFile resource was correctly deleted
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingFile403Example:
                  summary: Default deleteListingFile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingFile401Example:
                  summary: Default deleteListingFile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingFile500Example:
                  summary: Default deleteListingFile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Listing File
    get:
      operationId: getListingFile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a single file associated with the given digital listing. Requesting a file from a physical listing returns an empty result."
      tags:
        - ShopListing File
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: listing_file_id
          in: path
          description: The unique numeric ID of a file associated with a digital listing.
          required: true
          schema:
            type: integer
            description: The unique numeric ID of a file associated with a digital listing.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: The metadata for a file associated with a digital listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListingFile'
              examples:
                GetListingFile200Example:
                  summary: Default getListingFile 200 response
                  x-microcks-default: true
                  value:
                    listing_file_id: 1
                    listing_id: 123456789
                    rank: 1
                    filename: Handmade Ceramic Mug
                    filesize: example string
                    size_bytes: 1
                    filetype: example string
                    create_timestamp: 1758153645
                    created_timestamp: 1758153645
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingFile404Example:
                  summary: Default getListingFile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingFile400Example:
                  summary: Default getListingFile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingFile403Example:
                  summary: Default getListingFile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingFile401Example:
                  summary: Default getListingFile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingFile500Example:
                  summary: Default getListingFile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing File
  /v3/application/shops/{shop_id}/listings/{listing_id}/files:
    get:
      operationId: getAllListingFiles
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves all the files associated with the given digital listing. Requesting files from a physical listing returns an empty result."
      tags:
        - ShopListing File
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: A list of metadata objects for the file resources associated with a listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListingFiles'
              examples:
                GetAllListingFiles200Example:
                  summary: Default getAllListingFiles 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetAllListingFiles404Example:
                  summary: Default getAllListingFiles 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetAllListingFiles400Example:
                  summary: Default getAllListingFiles 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetAllListingFiles401Example:
                  summary: Default getAllListingFiles 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetAllListingFiles500Example:
                  summary: Default getAllListingFiles 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get All Listing Files
    post:
      operationId: uploadListingFile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUploads a new file for a digital listing, or associates an existing file with a specific listing. You must either provide the `listing_file_id` of an existing file, or the name and binary file data for a file to upload. Associating an existing file to a physical listing converts the physical listing into a digital listing, which removes all shipping costs and any product and inventory variations."
      tags:
        - ShopListing File
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                listing_file_id:
                  type: integer
                  description: The unique numeric ID of a file associated with a digital listing.
                  format: int64
                  minimum: 1
                file:
                  type: string
                  description: A binary file to upload.
                  format: binary
                  nullable: true
                name:
                  type: string
                  description: The file name string of a file to upload
                rank:
                  type: integer
                  description: The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.
                  format: int64
                  minimum: 1
                  default: 1
      responses:
        '201':
          description: The metadata for a file associated with a digital listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListingFile'
              examples:
                UploadListingFile201Example:
                  summary: Default uploadListingFile 201 response
                  x-microcks-default: true
                  value:
                    listing_file_id: 1
                    listing_id: 123456789
                    rank: 1
                    filename: Handmade Ceramic Mug
                    filesize: example string
                    size_bytes: 1
                    filetype: example string
                    create_timestamp: 1758153645
                    created_timestamp: 1758153645
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingFile404Example:
                  summary: Default uploadListingFile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingFile400Example:
                  summary: Default uploadListingFile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingFile403Example:
                  summary: Default uploadListingFile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingFile401Example:
                  summary: Default uploadListingFile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingFile500Example:
                  summary: Default uploadListingFile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Upload Listing File
  /v3/application/listings/active:
    get:
      operationId: findAllListingsActive
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nA list of all active listings on Etsy paginated by their creation date. Without sort_order listings will be returned newest-first by default."
      tags:
        - ShopListing
      parameters:
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: keywords
          in: query
          description: Search term or phrase that must appear in all results.
          required: false
          schema:
            type: string
            description: Search term or phrase that must appear in all results.
            default:
          example: example string
        - name: sort_on
          in: query
          description: '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.'
          required: false
          schema:
            type: string
            description: '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.'
            enum:
              - created
              - price
              - updated
              - score
            default: created
          example: created
        - name: sort_order
          in: query
          description: '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.).'
          required: false
          schema:
            type: string
            description: '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.).'
            enum:
              - asc
              - ascending
              - desc
              - descending
              - up
              - down
            default: desc
          example: asc
        - name: min_price
          in: query
          description: The minimum price of listings to be returned by a search result.
          required: false
          schema:
            type: number
            description: The minimum price of listings to be returned by a search result.
            format: float
            default:
          example: 25.0
        - name: max_price
          in: query
          description: The maximum price of listings to be returned by a search result.
          required: false
          schema:
            type: number
            description: The maximum price of listings to be returned by a search result.
            format: float
            default:
          example: 25.0
        - name: taxonomy_id
          in: query
          description: The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.
          required: false
          schema:
            type: integer
            description: The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.
            format: int64
            minimum: 1
            default:
          example: 1234
        - name: shop_location
          in: query
          description: Filters by shop location. If location cannot be parsed, Etsy responds with an error.
          required: false
          schema:
            type: string
            description: Filters by shop location. If location cannot be parsed, Etsy responds with an error.
            default:
          example: example string
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
        - name: is_safe
          in: query
          description: When true, filters out mature/adult content from search results.
          required: false
          schema:
            type: boolean
            description: When true, filters out mature/adult content from search results.
          example: true
        - name: currency
          in: query
          description: The ISO 4217 alphabetic currency code (e.g., EUR, MXN) for price conversion. If provided, the listing price will be converted to this currency.
          required: false
          schema:
            type: string
            description: The ISO 4217 alphabetic currency code (e.g., EUR, MXN) for price conversion. If provided, the listing price will be converted to this currency.
            default:
          example: example string
        - name: buyer_country
          in: query
          description: The ISO 3166-1 alpha-2 country code (e.g., DE, MX). Filters results to listings that ship to this country.
          required: false
          schema:
            type: string
            description: The ISO 3166-1 alpha-2 country code (e.g., DE, MX). Filters results to listings that ship to this country.
            format: ISO 3166-1 alpha-2
            default:
          example: US
      responses:
        '200':
          description: A list of all active listings on Etsy paginated by their creation date. Without sort_order listings will be returned newest-first by default.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListings'
              examples:
                FindAllListingsActive200Example:
                  summary: Default findAllListingsActive 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                FindAllListingsActive404Example:
                  summary: Default findAllListingsActive 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                FindAllListingsActive500Example:
                  summary: Default findAllListingsActive 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Find All Listings Active
  /v3/application/shops/{shop_id}/listings/active:
    get:
      operationId: findAllActiveListingsByShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of all active listings on Etsy in a specific shop, paginated by listing creation date."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: sort_on
          in: query
          description: '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.'
          required: false
          schema:
            type: string
            description: '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.'
            enum:
              - created
              - price
              - updated
              - score
            default: created
          example: created
        - name: sort_order
          in: query
          description: '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.).'
          required: false
          schema:
            type: string
            description: '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.).'
            enum:
              - asc
              - ascending
              - desc
              - descending
              - up
              - down
            default: desc
          example: asc
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: keywords
          in: query
          description: Search term or phrase that must appear in all results.
          required: false
          schema:
            type: string
            description: Search term or phrase that must appear in all results.
            default:
          example: example string
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: Retrieves a list of all active listings on Etsy in a specific shop, paginated by listing creation date.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListings'
              examples:
                FindAllActiveListingsByShop200Example:
                  summary: Default findAllActiveListingsByShop 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                FindAllActiveListingsByShop404Example:
                  summary: Default findAllActiveListingsByShop 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                FindAllActiveListingsByShop400Example:
                  summary: Default findAllActiveListingsByShop 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                FindAllActiveListingsByShop500Example:
                  summary: Default findAllActiveListingsByShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Find All Active Listings by Shop
  /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}:
    delete:
      operationId: deleteListingImage
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to delete a listing image. A copy of the file remains on our servers, and so a deleted image may be re-associated with the listing without re-uploading the original image; see uploadListingImage."
      tags:
        - ShopListing Image
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: listing_image_id
          in: path
          description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
            format: int64
            minimum: 1
          example: 1
      responses:
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingImage404Example:
                  summary: Default deleteListingImage 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingImage400Example:
                  summary: Default deleteListingImage 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingImage401Example:
                  summary: Default deleteListingImage 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingImage403Example:
                  summary: Default deleteListingImage 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '204':
          description: The ListingImage resource was correctly deleted
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingImage500Example:
                  summary: Default deleteListingImage 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Listing Image
  /v3/application/listings/{listing_id}/images/{listing_image_id}:
    get:
      operationId: getListingImage
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the references and metadata for a listing image with a specific image ID."
      tags:
        - ShopListing Image
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: listing_image_id
          in: path
          description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single ListingImage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingImage'
              examples:
                GetListingImage200Example:
                  summary: Default getListingImage 200 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    listing_image_id: 1
                    hex_code: example string
                    red: 1
                    green: 1
                    blue: 1
                    hue: 1
                    saturation: 1
                    brightness: 1
                    is_black_and_white: true
                    creation_tsz: 1
                    created_timestamp: 1758153645
                    rank: 1
                    url_75x75: https://www.etsy.com/listing/123456789
                    url_170x135: https://www.etsy.com/listing/123456789
                    url_570xN: https://www.etsy.com/listing/123456789
                    url_fullxfull: https://www.etsy.com/listing/123456789
                    full_height: 1
                    full_width: 1
                    alt_text: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImage404Example:
                  summary: Default getListingImage 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImage400Example:
                  summary: Default getListingImage 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImage403Example:
                  summary: Default getListingImage 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImage500Example:
                  summary: Default getListingImage 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Image
  /v3/application/listings/{listing_id}/images:
    get:
      operationId: getListingImages
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves all listing image resources for a listing with a specific listing ID."
      tags:
        - ShopListing Image
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '200':
          description: An array of ListingImage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingImages'
              examples:
                GetListingImages200Example:
                  summary: Default getListingImages 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImages404Example:
                  summary: Default getListingImages 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImages400Example:
                  summary: Default getListingImages 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImages403Example:
                  summary: Default getListingImages 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingImages500Example:
                  summary: Default getListingImages 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Images
  /v3/application/shops/{shop_id}/listings/{listing_id}/images:
    post:
      operationId: uploadListingImage
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUploads or assigns an image to a listing identified by a shop ID with a listing ID. To upload a new image, set the image file as the value for the `image` parameter. You can assign a previously deleted image to a listing using the deleted image's image ID in the `listing_image_id` parameter. When a request contains both `image` and `listing_image_id` parameter values, the endpoint uploads the image in the `image` parameter only. Note: When uploading a new image, data such as colors and size may return as null values due to asynchronous processing of the image. Use getListingImage endpoint to fetch these values."
      tags:
        - ShopListing Image
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  description: The file name string of a file to upload
                  format: binary
                  nullable: true
                listing_image_id:
                  type: integer
                  description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
                  format: int64
                  minimum: 1
                rank:
                  type: integer
                  description: The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.
                  minimum: 0
                  default: 1
                overwrite:
                  type: boolean
                  description: When true, this request replaces the existing image at a given rank.
                  default: false
                is_watermarked:
                  type: boolean
                  description: When true, indicates that the uploaded image has a watermark.
                  default: false
                alt_text:
                  type: string
                  description: Alt text for the listing image. Max length 500 characters.
                  default: ''
      responses:
        '201':
          description: A single ListingImage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingImage'
              examples:
                UploadListingImage201Example:
                  summary: Default uploadListingImage 201 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    listing_image_id: 1
                    hex_code: example string
                    red: 1
                    green: 1
                    blue: 1
                    hue: 1
                    saturation: 1
                    brightness: 1
                    is_black_and_white: true
                    creation_tsz: 1
                    created_timestamp: 1758153645
                    rank: 1
                    url_75x75: https://www.etsy.com/listing/123456789
                    url_170x135: https://www.etsy.com/listing/123456789
                    url_570xN: https://www.etsy.com/listing/123456789
                    url_fullxfull: https://www.etsy.com/listing/123456789
                    full_height: 1
                    full_width: 1
                    alt_text: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingImage404Example:
                  summary: Default uploadListingImage 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingImage400Example:
                  summary: Default uploadListingImage 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingImage409Example:
                  summary: Default uploadListingImage 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingImage403Example:
                  summary: Default uploadListingImage 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingImage401Example:
                  summary: Default uploadListingImage 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingImage500Example:
                  summary: Default uploadListingImage 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Upload Listing Image
  /v3/application/listings/{listing_id}/inventory:
    get:
      operationId: getListingInventory
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the inventory record for a listing. Listings you did not edit using the Etsy.com inventory tools have no inventory records. This endpoint returns SKU data if you are the owner of the inventory records being fetched."
      tags:
        - ShopListing Inventory
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: show_deleted
          in: query
          description: A boolean value for inventory whether to include deleted products and their offerings. Default value is false.
          required: false
          schema:
            type: boolean
            description: A boolean value for inventory whether to include deleted products and their offerings. Default value is false.
          example: true
        - name: includes
          in: query
          description: An enumerated string that attaches a valid association. Default value is null.
          required: false
          schema:
            type: string
            description: An enumerated string that attaches a valid association. Default value is null.
            enum:
              - Listing
          example: Listing
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A single listing inventory record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingInventoryWithAssociations'
              examples:
                GetListingInventory200Example:
                  summary: Default getListingInventory 200 response
                  x-microcks-default: true
                  value:
                    products:
                      - 
                    price_on_property:
                      - 1
                    quantity_on_property:
                      - 1
                    sku_on_property:
                      - 1
                    readiness_state_on_property:
                      - 1
                    listing: example
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingInventory404Example:
                  summary: Default getListingInventory 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingInventory401Example:
                  summary: Default getListingInventory 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingInventory400Example:
                  summary: Default getListingInventory 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '422':
          description: There was a problem processing your request. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingInventory422Example:
                  summary: Default getListingInventory 422 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingInventory500Example:
                  summary: Default getListingInventory 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Inventory
    put:
      operationId: updateListingInventory
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates the inventory for a listing identified by a listing ID. The update fails if the supplied values for product sku, offering quantity, price, and/or processing profile are incompatible with values in `*_on_property` fields. When setting a price, assign a float equal to amount divided by divisor as specified in the Money resource."
      tags:
        - ShopListing Inventory
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
        - name: max_variations_supported
          in: query
          description: 'Coming soon: This parameter determines whether a third variation can be added to or updated for a listing. It accepts values of 2 or 3, where 3 enables third-variation support.'
          required: false
          schema:
            type: string
            description: 'Coming soon: This parameter determines whether a third variation can be added to or updated for a listing. It accepts values of 2 or 3, where 3 enables third-variation support.'
            enum:
              - '2'
              - '3'
          example: '2'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - products
              properties:
                products:
                  type: array
                  description: A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
                  items:
                    type: object
                    properties:
                      sku:
                        type: string
                        description: The SKU string for the product
                        nullable: true
                      property_values:
                        type: array
                        description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
                        items:
                          type: object
                          properties:
                            property_id:
                              type: integer
                              description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingInventory).
                              format: int64
                              minimum: 1
                            value_ids:
                              type: array
                              description: An array of unique IDs of Etsy [listing property](/documentation/reference#operation/getListingInventory) values.
                              items:
                                type: integer
                                format: int64
                                minimum: 1
                            scale_id:
                              type: integer
                              description: The numeric ID of a single Etsy.com measurement scale. For example, for shoe size, there are three `scale_id`s available - `UK`, `US/Canada`, and `EU`, where `US/Canada` has `scale_id` 19.
                              format: int64
                              nullable: true
                              minimum: 1
                            property_name:
                              type: string
                              description: The name of the property, in the requested locale language.
                            values:
                              type: array
                              description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
                              items:
                                type: string
                          required:
                            - property_id
                            - value_ids
                            - values
                      offerings:
                        type: array
                        description: A list of product offering entries for this product.
                        items:
                          type: object
                          properties:
                            price:
                              type: number
                              description: The price of the product.
                              format: float
                            quantity:
                              type: integer
                              description: How many of this product are available?
                            is_enabled:
                              type: boolean
                              description: True if the offering is shown to buyers
                            readiness_state_id:
                              type: integer
                              description: 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.
                              format: int64
                              nullable: true
                              minimum: 1
                          required:
                            - price
                            - quantity
                            - is_enabled
                            - readiness_state_id
                    required:
                      - offerings
                price_on_property:
                  type: array
                  description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
                  items:
                    type: integer
                quantity_on_property:
                  type: array
                  description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
                  items:
                    type: integer
                sku_on_property:
                  type: array
                  description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
                  items:
                    type: integer
                readiness_state_on_property:
                  type: array
                  description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
                  nullable: true
                  items:
                    type: integer
                    format: int64
                    minimum: 1
            examples:
              UpdateListingInventoryRequestExample:
                summary: Default updateListingInventory request
                x-microcks-default: true
                value:
                  products:
                    - sku: example string
                      property_values:
                        - property_id: 1
                          value_ids:
                            - {}
                          scale_id: 1
                          property_name: example string
                          values:
                            - {}
                      offerings:
                        - price: 1.0
                          quantity: 1
                          is_enabled: true
                          readiness_state_id: 1
                  price_on_property:
                    - 1
                  quantity_on_property:
                    - 1
                  sku_on_property:
                    - 1
                  readiness_state_on_property:
                    - 1
      responses:
        '200':
          description: A single listing's inventory record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingInventory'
              examples:
                UpdateListingInventory200Example:
                  summary: Default updateListingInventory 200 response
                  x-microcks-default: true
                  value:
                    products:
                      - 
                    price_on_property:
                      - 1
                    quantity_on_property:
                      - 1
                    sku_on_property:
                      - 1
                    readiness_state_on_property:
                      - 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingInventory404Example:
                  summary: Default updateListingInventory 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingInventory403Example:
                  summary: Default updateListingInventory 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingInventory400Example:
                  summary: Default updateListingInventory 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingInventory401Example:
                  summary: Default updateListingInventory 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingInventory500Example:
                  summary: Default updateListingInventory 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Listing Inventory
  /v3/application/listings/{listing_id}/inventory/products/{product_id}:
    get:
      operationId: getListingProduct
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to retrieve a ListingProduct by ID."
      tags:
        - ShopListing Product
      parameters:
        - name: listing_id
          in: path
          description: The listing to return a ListingProduct for.
          required: true
          schema:
            type: integer
            description: The listing to return a ListingProduct for.
            format: int64
            minimum: 1
          example: 123456789
        - name: product_id
          in: path
          description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
          required: true
          schema:
            type: integer
            description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
            format: int64
            minimum: 1
          example: 567890123
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A single ListingInventoryProduct
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingInventoryProduct'
              examples:
                GetListingProduct200Example:
                  summary: Default getListingProduct 200 response
                  x-microcks-default: true
                  value:
                    product_id: 567890123
                    sku: SKU-12345
                    is_deleted: true
                    offerings:
                      - 
                    property_values:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProduct404Example:
                  summary: Default getListingProduct 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProduct400Example:
                  summary: Default getListingProduct 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProduct401Example:
                  summary: Default getListingProduct 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProduct500Example:
                  summary: Default getListingProduct 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Product
  /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}:
    get:
      operationId: getListingOffering
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGet an Offering for a Listing"
      tags:
        - ShopListing Offering
      parameters:
        - name: listing_id
          in: path
          description: ''
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
          example: 123456789
        - name: product_id
          in: path
          description: ''
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
          example: 567890123
        - name: product_offering_id
          in: path
          description: ''
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
          example: 1
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A single ListingInventoryProductOffering
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingInventoryProductOffering'
              examples:
                GetListingOffering200Example:
                  summary: Default getListingOffering 200 response
                  x-microcks-default: true
                  value:
                    offering_id: 1
                    quantity: 1
                    is_enabled: true
                    is_deleted: true
                    price: example
                    readiness_state_id: 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingOffering404Example:
                  summary: Default getListingOffering 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingOffering400Example:
                  summary: Default getListingOffering 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingOffering500Example:
                  summary: Default getListingOffering 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Offering
  /v3/application/listings/batch:
    get:
      operationId: getListingsByListingIds
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nAllows to query multiple listing ids at once. Limit 100 ids maximum per query."
      tags:
        - ShopListing
      parameters:
        - name: listing_ids
          in: query
          description: The list of numeric IDS for the listings in a specific Etsy shop.
          required: true
          schema:
            type: array
            description: The list of numeric IDS for the listings in a specific Etsy shop.
            items:
              type: integer
              format: int64
              minimum: 1
          example:
            - 123456789
        - name: includes
          in: query
          description: An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'.
          required: false
          schema:
            type: array
            description: An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations', 'Videos', 'Inventory' and 'Personalization'.
            items:
              type: string
              enum:
                - Shipping
                - Images
                - Shop
                - User
                - Translations
                - Inventory
                - Videos
                - Personalization
                - BuyerPrice
            default:
          example:
            - Shipping
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
        - name: currency
          in: query
          description: The ISO 4217 alphabetic currency code (e.g., EUR, MXN) for price conversion. If provided, the listing price will be converted to this currency.
          required: false
          schema:
            type: string
            description: The ISO 4217 alphabetic currency code (e.g., EUR, MXN) for price conversion. If provided, the listing price will be converted to this currency.
            default:
          example: example string
        - name: buyer_country
          in: query
          description: The ISO 3166-1 alpha-2 country code (e.g., GB, DE). Used for buyer-facing price calculations (VAT, inclusive shipping). Does not filter listings.
          required: false
          schema:
            type: string
            description: The ISO 3166-1 alpha-2 country code (e.g., GB, DE). Used for buyer-facing price calculations (VAT, inclusive shipping). Does not filter listings.
            format: ISO 3166-1 alpha-2
            default:
          example: US
      responses:
        '200':
          description: A list of Listings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListingsWithAssociations'
              examples:
                GetListingsByListingIds200Example:
                  summary: Default getListingsByListingIds 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByListingIds400Example:
                  summary: Default getListingsByListingIds 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByListingIds404Example:
                  summary: Default getListingsByListingIds 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByListingIds500Example:
                  summary: Default getListingsByListingIds 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listings by Listing Ids
  /v3/application/shops/{shop_id}/listings/featured:
    get:
      operationId: getFeaturedListingsByShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves Listings associated to a Shop that are featured."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of Listings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListings'
              examples:
                GetFeaturedListingsByShop200Example:
                  summary: Default getFeaturedListingsByShop 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetFeaturedListingsByShop400Example:
                  summary: Default getFeaturedListingsByShop 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetFeaturedListingsByShop403Example:
                  summary: Default getFeaturedListingsByShop 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetFeaturedListingsByShop500Example:
                  summary: Default getFeaturedListingsByShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Featured Listings by Shop
  /v3/application/shops/{shop_id}/listings/{listing_id}/personalization:
    delete:
      operationId: deleteListingPersonalization
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes personalization for a listing."
      tags:
        - ShopListing Personalization
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '204':
          description: The ListingPersonalization resource was correctly deleted
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingPersonalization404Example:
                  summary: Default deleteListingPersonalization 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingPersonalization400Example:
                  summary: Default deleteListingPersonalization 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingPersonalization403Example:
                  summary: Default deleteListingPersonalization 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingPersonalization401Example:
                  summary: Default deleteListingPersonalization 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingPersonalization500Example:
                  summary: Default deleteListingPersonalization 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Listing Personalization
    post:
      operationId: updateListingPersonalization
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates or updates personalization settings for a listing, allowing the seller to collect personalization from the buyer. This endpoint will fully replace any existing personalization on the listing."
      tags:
        - ShopListing Personalization
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: supports_multiple_personalization_questions
          in: query
          description: "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 inadvertently deleting seller-entered data."
          required: false
          schema:
            type: boolean
            description: "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 inadvertently deleting seller-entered data."
            nullable: true
          example: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - personalization_questions
              properties:
                personalization_questions:
                  type: array
                  items:
                    type: object
                    properties:
                      question_id:
                        type: integer
                        description: 'The ID of the personalization question. This field is optional. Include it when updating an existing question; omit it when creating a new question. Note: This value may change if the personalization question is updated.'
                        format: int64
                        nullable: true
                        minimum: 1
                      question_text:
                        type: string
                        description: "The title of the personalization question. Must be between 1 and 45 characters. Note: During the migration to the new personalization endpoints, if you're still using a legacy UI (without a title input),please send the default value 'Personalization'."
                      instructions:
                        type: string
                        description: Optional instructions for a personalization question. This field is not allowed for 'dropdown' questions. For legacy, single personalization, max length is 256 characters. Once multiple personalization questions are enabled, the max length will be 120 characters.
                        nullable: true
                      question_type:
                        type: string
                        description: "The type of the personalization question. Note: Currently, only a single question with type 'text_input' is supported. See https://developers.etsy.com/documentation/tutorials/personalization-migration for details about new question types."
                        enum:
                          - text_input
                          - dropdown
                          - unlabeled_upload
                          - labeled_upload
                      required:
                        type: boolean
                        description: When true, the personalization question is required.
                      max_allowed_files:
                        type: integer
                        description: The maximum number of files the buyer may upload in response to a personalization question. This field is optional and only applicable to 'unlabeled_upload' and 'labeled_upload' questions.
                        nullable: true
                      max_allowed_characters:
                        type: integer
                        description: The maximum number of characters the buyer may enter in response to a personalization question. This field is optional and only applicable to 'text_input' questions.
                        nullable: true
                      options:
                        type: array
                        description: The list of options for a personalization question. For 'dropdown' questions, this list contains the options for the dropdown. For 'labeled_upload' questions, this list contains the labels for the files that the buyer may upload, and must match the max_allowed_files value..
                        nullable: true
                        items:
                          type: object
                          properties:
                            option_id:
                              type: integer
                              description: 'The ID of the option. This field is optional. Include it when updating an existing option; omit it when creating a new option. Note: This value may change if the option or question is updated.'
                              format: int64
                              nullable: true
                              minimum: 1
                            label:
                              type: string
                              description: "The option label. Note: For 'dropdown' questions, max length is 20 characters. For 'labeled_upload' questions, max length is 45 characters."
                          required:
                            - label
                    required:
                      - question_text
                      - question_type
                      - required
            examples:
              UpdateListingPersonalizationRequestExample:
                summary: Default updateListingPersonalization request
                x-microcks-default: true
                value:
                  personalization_questions:
                    - question_id: 1
                      question_text: example string
                      instructions: example string
                      question_type: text_input
                      required: true
                      max_allowed_files: 1
                      max_allowed_characters: 1
                      options:
                        - option_id: 1
                          label: example string
      responses:
        '201':
          description: A single Listing Personalization record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization'
              examples:
                UpdateListingPersonalization201Example:
                  summary: Default updateListingPersonalization 201 response
                  x-microcks-default: true
                  value:
                    personalization_questions:
                      - question_id: 1
                        question_text: example string
                        instructions: example string
                        question_type: example string
                        required: true
                        max_allowed_characters: 1
                        max_allowed_files: 1
                        options:
                          - {}
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingPersonalization400Example:
                  summary: Default updateListingPersonalization 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingPersonalization401Example:
                  summary: Default updateListingPersonalization 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingPersonalization403Example:
                  summary: Default updateListingPersonalization 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingPersonalization404Example:
                  summary: Default updateListingPersonalization 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingPersonalization409Example:
                  summary: Default updateListingPersonalization 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingPersonalization500Example:
                  summary: Default updateListingPersonalization 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Listing Personalization
  /v3/application/listings/{listing_id}/personalization:
    get:
      operationId: getListingPersonalization
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a listing's personalization questions by listing ID."
      tags:
        - ShopListing Personalization
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '200':
          description: A listing personalization questions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization'
              examples:
                GetListingPersonalization200Example:
                  summary: Default getListingPersonalization 200 response
                  x-microcks-default: true
                  value:
                    personalization_questions:
                      - question_id: 1
                        question_text: example string
                        instructions: example string
                        question_type: example string
                        required: true
                        max_allowed_characters: 1
                        max_allowed_files: 1
                        options:
                          - {}
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingPersonalization404Example:
                  summary: Default getListingPersonalization 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingPersonalization400Example:
                  summary: Default getListingPersonalization 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingPersonalization403Example:
                  summary: Default getListingPersonalization 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingPersonalization500Example:
                  summary: Default getListingPersonalization 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Personalization
  /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}:
    delete:
      operationId: deleteListingProperty
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a property for a Listing."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: property_id
          in: path
          description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).
          required: true
          schema:
            type: integer
            description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).
            format: int64
            minimum: 1
          example: 1
      responses:
        '204':
          description: The ListingProperty resource was correctly deleted
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingProperty403Example:
                  summary: Default deleteListingProperty 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingProperty404Example:
                  summary: Default deleteListingProperty 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingProperty400Example:
                  summary: Default deleteListingProperty 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingProperty401Example:
                  summary: Default deleteListingProperty 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingProperty500Example:
                  summary: Default deleteListingProperty 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Listing Property
    put:
      operationId: updateListingProperty
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates or populates the properties list defining product offerings for a listing. Each offering requires both a `value` and a `value_id` that are valid for a `scale_id` assigned to the listing or that you assign to the listing with this request."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: property_id
          in: path
          description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).
          required: true
          schema:
            type: integer
            description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - value_ids
                - values
              properties:
                value_ids:
                  type: array
                  description: An array of unique IDs of multiple Etsy [listing property](/documentation/reference#operation/getListingProperties) values. For example, if your listing is composed of different materials, then the value ID list contains value IDs for each material.
                  items:
                    type: integer
                    format: int64
                    minimum: 1
                values:
                  type: array
                  description: 'An array of value strings for multiple Etsy [listing property](/documentation/reference#operation/getListingProperties) values. For example, if your listing is painted in different colors, then the values array contains the color strings for each color. Note: parenthesis characters (`(` and `)`) are not allowed.'
                  items:
                    type: string
                scale_id:
                  type: integer
                  description: The numeric ID of a single Etsy.com measurement scale. For example, for shoe size, there are three `scale_id`s available - `UK`, `US/Canada`, and `EU`, where `US/Canada` has `scale_id` 19.
                  format: int64
                  minimum: 1
            examples:
              UpdateListingPropertyRequestExample:
                summary: Default updateListingProperty request
                x-microcks-default: true
                value:
                  value_ids:
                    - 1
                  values:
                    - example string
                  scale_id: 1
      responses:
        '200':
          description: A single listing property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingPropertyValue'
              examples:
                UpdateListingProperty200Example:
                  summary: Default updateListingProperty 200 response
                  x-microcks-default: true
                  value:
                    property_id: 1
                    property_name: Handmade Ceramic Mug
                    scale_id: 1
                    scale_name: Handmade Ceramic Mug
                    value_ids:
                      - 1
                    values:
                      - example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingProperty403Example:
                  summary: Default updateListingProperty 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingProperty404Example:
                  summary: Default updateListingProperty 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingProperty400Example:
                  summary: Default updateListingProperty 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingProperty401Example:
                  summary: Default updateListingProperty 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingProperty500Example:
                  summary: Default updateListingProperty 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Listing Property
  /v3/application/listings/{listing_id}/properties/{property_id}:
    get:
      operationId: getListingProperty
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationTertiary wt-mr-xs-2\"> Feedback only </span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Give feedback</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">Development for this endpoint is in progress. It will only return a 501 response.</p></div>\n\nRetrieves a listing's property"
      tags:
        - ShopListing
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: property_id
          in: path
          description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).
          required: true
          schema:
            type: integer
            description: The unique ID of an Etsy [listing property](/documentation/reference#operation/getListingProperties).
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single ListingProperty.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingPropertyValue'
              examples:
                GetListingProperty200Example:
                  summary: Default getListingProperty 200 response
                  x-microcks-default: true
                  value:
                    property_id: 1
                    property_name: Handmade Ceramic Mug
                    scale_id: 1
                    scale_name: Handmade Ceramic Mug
                    value_ids:
                      - 1
                    values:
                      - example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperty404Example:
                  summary: Default getListingProperty 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '501':
          description: This endpoint is not functional at this time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperty501Example:
                  summary: Default getListingProperty 501 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperty400Example:
                  summary: Default getListingProperty 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperty500Example:
                  summary: Default getListingProperty 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Property
  /v3/application/shops/{shop_id}/listings/{listing_id}/properties:
    get:
      operationId: getListingProperties
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGet a listing's properties"
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '200':
          description: A Listing's Properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingPropertyValues'
              examples:
                GetListingProperties200Example:
                  summary: Default getListingProperties 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - property_id: 1
                        property_name: Handmade Ceramic Mug
                        scale_id: 1
                        scale_name: Handmade Ceramic Mug
                        value_ids:
                          - {}
                        values:
                          - {}
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperties404Example:
                  summary: Default getListingProperties 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperties400Example:
                  summary: Default getListingProperties 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingProperties500Example:
                  summary: Default getListingProperties 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Properties
  /v3/application/shops/{shop_id}/listings/{listing_id}/transactions:
    get:
      operationId: getShopReceiptTransactionsByListing
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the list of transactions associated with a listing."
      tags:
        - Shop Receipt Transactions
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceiptTransactions'
              examples:
                GetShopReceiptTransactionsByListing200Example:
                  summary: Default getShopReceiptTransactionsByListing 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByListing403Example:
                  summary: Default getShopReceiptTransactionsByListing 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByListing404Example:
                  summary: Default getShopReceiptTransactionsByListing 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByListing400Example:
                  summary: Default getShopReceiptTransactionsByListing 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByListing401Example:
                  summary: Default getShopReceiptTransactionsByListing 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByListing500Example:
                  summary: Default getShopReceiptTransactionsByListing 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Receipt Transactions by Listing
  /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}:
    post:
      operationId: createListingTranslation
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a ListingTranslation by listing_id and language"
      tags:
        - ShopListing Translation
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: language
          in: path
          description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          required: true
          schema:
            type: string
            description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          example: en-US
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - title
                - description
              properties:
                title:
                  type: string
                  description: The title of the Listing of this Translation.
                description:
                  type: string
                  description: The description of the Listing of this Translation.
                tags:
                  type: array
                  description: The tags of the Listing of this Translation.
                  items:
                    type: string
            examples:
              CreateListingTranslationRequestExample:
                summary: Default createListingTranslation request
                x-microcks-default: true
                value:
                  title: example string
                  description: example string
                  tags:
                    - example string
      responses:
        '200':
          description: A single ListingTranslation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingTranslation'
              examples:
                CreateListingTranslation200Example:
                  summary: Default createListingTranslation 200 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    language: en-US
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    tags:
                      - example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateListingTranslation404Example:
                  summary: Default createListingTranslation 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateListingTranslation400Example:
                  summary: Default createListingTranslation 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateListingTranslation403Example:
                  summary: Default createListingTranslation 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateListingTranslation401Example:
                  summary: Default createListingTranslation 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateListingTranslation500Example:
                  summary: Default createListingTranslation 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Listing Translation
    get:
      operationId: getListingTranslation
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGet a Translation for a Listing in the given language"
      tags:
        - ShopListing Translation
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: language
          in: path
          description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          required: true
          schema:
            type: string
            description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          example: en-US
      responses:
        '200':
          description: A single ListingTranslation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingTranslation'
              examples:
                GetListingTranslation200Example:
                  summary: Default getListingTranslation 200 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    language: en-US
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    tags:
                      - example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingTranslation404Example:
                  summary: Default getListingTranslation 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingTranslation400Example:
                  summary: Default getListingTranslation 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingTranslation500Example:
                  summary: Default getListingTranslation 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Translation
    put:
      operationId: updateListingTranslation
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates a ListingTranslation by listing_id and language"
      tags:
        - ShopListing Translation
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: language
          in: path
          description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          required: true
          schema:
            type: string
            description: 'The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.'
          example: en-US
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - title
                - description
              properties:
                title:
                  type: string
                  description: The title of the Listing of this Translation.
                description:
                  type: string
                  description: The description of the Listing of this Translation.
                tags:
                  type: array
                  description: The tags of the Listing of this Translation.
                  items:
                    type: string
            examples:
              UpdateListingTranslationRequestExample:
                summary: Default updateListingTranslation request
                x-microcks-default: true
                value:
                  title: example string
                  description: example string
                  tags:
                    - example string
      responses:
        '200':
          description: A single ListingTranslation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingTranslation'
              examples:
                UpdateListingTranslation200Example:
                  summary: Default updateListingTranslation 200 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    language: en-US
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    tags:
                      - example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingTranslation404Example:
                  summary: Default updateListingTranslation 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingTranslation400Example:
                  summary: Default updateListingTranslation 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingTranslation403Example:
                  summary: Default updateListingTranslation 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingTranslation401Example:
                  summary: Default updateListingTranslation 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListingTranslation500Example:
                  summary: Default updateListingTranslation 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Listing Translation
  /v3/application/shops/{shop_id}/listings/{listing_id}:
    patch:
      operationId: updateListing
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates a listing, identified by a listing ID, for a specific shop identified by a shop ID. Note that this is a PATCH method type. When activating, or manually renewing a physical listing, the shipping profile referenced by the `shipping_profile_id`, and all of its fields, along with its entries and upgrades must be complete and valid. If the shipping profile is not complete and valid, we will throw an exception with an error message that guides the request sender to update whatever data is bad.   Digital listings that are not made to order must have a file upload associated with it to be activated. While the listing is a draft, shipping profile and file upload are not required in any case."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                image_ids:
                  type: array
                  description: An array of numeric image IDs of the images in a listing, which can include up to 20 images.
                  items:
                    type: integer
                    format: int64
                    minimum: 1
                title:
                  type: string
                  description: "The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each."
                description:
                  type: string
                  description: A description string of the product for sale in the listing.
                materials:
                  type: array
                  description: 'A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.'
                  nullable: true
                  items:
                    type: string
                should_auto_renew:
                  type: boolean
                  description: When true, renews a listing for four months upon expiration.
                shipping_profile_id:
                  type: integer
                  description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
                  format: int64
                  nullable: true
                  minimum: 1
                return_policy_id:
                  type: integer
                  description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies). Required for active physical listings. This requirement does not apply to listings of EU-based shops.
                  format: int64
                  nullable: true
                  minimum: 1
                shop_section_id:
                  type: integer
                  description: The numeric ID of the [shop section](/documentation/reference#tag/Shop-Section) for this listing. Default value is null.
                  nullable: true
                item_weight:
                  type: number
                  description: The numeric weight of the product measured in units set in 'item_weight_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_length:
                  type: number
                  description: The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_width:
                  type: number
                  description: The numeric width of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_height:
                  type: number
                  description: The numeric height of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
                  format: float
                  nullable: true
                  minimum: 0
                  maximum: 1.79769313486e+308
                item_weight_unit:
                  type: string
                  description: A string defining the units used to measure the weight of the product. Default value is null.
                  nullable: true
                  enum:
                    - ''
                    - oz
                    - lb
                    - g
                    - kg
                item_dimensions_unit:
                  type: string
                  description: A string defining the units used to measure the dimensions of the product. Default value is null.
                  nullable: true
                  enum:
                    - ''
                    - in
                    - ft
                    - mm
                    - cm
                    - m
                    - yd
                    - inches
                is_taxable:
                  type: boolean
                  description: When true, applicable [shop](/documentation/reference#tag/Shop) tax rates apply to this listing at checkout.
                taxonomy_id:
                  type: integer
                  description: The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.
                  format: int64
                  minimum: 1
                tags:
                  type: array
                  description: "A comma-separated list of tag strings for the listing. When creating or updating a listing, valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}\\-'™©®]/u) Default value is null."
                  nullable: true
                  items:
                    type: string
                who_made:
                  type: string
                  description: An enumerated string indicating who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.
                  enum:
                    - i_did
                    - someone_else
                    - collective
                when_made:
                  type: string
                  description: An enumerated string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.
                  enum:
                    - made_to_order
                    - '2020_2026'
                    - '2010_2019'
                    - '2007_2009'
                    - before_2007
                    - '2000_2006'
                    - 1990s
                    - 1980s
                    - 1970s
                    - 1960s
                    - 1950s
                    - 1940s
                    - 1930s
                    - 1920s
                    - 1910s
                    - 1900s
                    - 1800s
                    - 1700s
                    - before_1700
                featured_rank:
                  type: integer
                  description: The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page.
                  nullable: true
                is_personalizable:
                  type: boolean
                  description: '[DEPRECATED] When true, this listing is personalizable. The default value is false. NOTE: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details.'
                personalization_is_required:
                  type: boolean
                  description: '[DEPRECATED] When true, this listing requires personalization. The default value is false. NOTE: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details.'
                personalization_char_count_max:
                  type: integer
                  description: "[DEPRECATED] This is an integer value representing the maximum length for the personalization message entered by the buyer. Will only change if is_personalizable is 'true'. Note: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details."
                personalization_instructions:
                  type: string
                  description: "[DEPRECATED] A string representing instructions for the buyer to enter the personalization. Will only change if is_personalizable is 'true'. Note: This field will be removed on Apr. 9th, 2026. See https://developers.etsy.com/documentation/tutorials/personalization-migration for migration details."
                state:
                  type: string
                  description: '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.'
                  enum:
                    - active
                    - inactive
                is_supply:
                  type: boolean
                  description: When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'.
                production_partner_ids:
                  type: array
                  description: An array of unique IDs of production partner ids.
                  nullable: true
                  items:
                    type: integer
                    format: int64
                    minimum: 1
                type:
                  type: string
                  description: An enumerated type string that indicates whether the listing is physical or a digital download.
                  nullable: true
                  enum:
                    - physical
                    - download
                    - both
            examples:
              UpdateListingRequestExample:
                summary: Default updateListing request
                x-microcks-default: true
                value:
                  image_ids:
                    - 1
                  title: example string
                  description: example string
                  materials:
                    - example string
                  should_auto_renew: true
                  shipping_profile_id: 1
                  return_policy_id: 1
                  shop_section_id: 1
                  item_weight: 1.0
                  item_length: 1.0
                  item_width: 1.0
                  item_height: 1.0
                  item_weight_unit: ''
                  item_dimensions_unit: ''
                  is_taxable: true
                  taxonomy_id: 1
                  tags:
                    - example string
                  who_made: i_did
                  when_made: made_to_order
                  featured_rank: 1
                  is_personalizable: true
                  personalization_is_required: true
                  personalization_char_count_max: 1
                  personalization_instructions: example string
                  state: active
                  is_supply: true
                  production_partner_ids:
                    - 1
                  type: physical
      responses:
        '200':
          description: A single ShopListing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListing'
              examples:
                UpdateListing200Example:
                  summary: Default updateListing 200 response
                  x-microcks-default: true
                  value:
                    listing_id: 123456789
                    user_id: 456789
                    shop_id: 123456
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    state: active
                    creation_timestamp: 1758153645
                    created_timestamp: 1758153645
                    ending_timestamp: 1758153645
                    original_creation_timestamp: 1758153645
                    last_modified_timestamp: 1758153645
                    updated_timestamp: 1758153645
                    state_timestamp: 1758153645
                    quantity: 1
                    shop_section_id: 1
                    featured_rank: 1
                    url: https://www.etsy.com/listing/123456789
                    num_favorers: 1
                    non_taxable: true
                    is_taxable: true
                    is_customizable: true
                    is_personalizable: true
                    listing_type: physical
                    tags:
                      - example string
                    materials:
                      - example string
                    shipping_profile_id: 1
                    return_policy_id: 1
                    processing_min: 1
                    processing_max: 1
                    who_made: i_did
                    when_made: made_to_order
                    is_supply: true
                    item_weight: 0.5
                    item_weight_unit: oz
                    item_length: 1.0
                    item_width: 1.0
                    item_height: 1.0
                    item_dimensions_unit: in
                    is_private: true
                    style:
                      - example string
                    file_data: example string
                    has_variations: true
                    should_auto_renew: true
                    language: en-US
                    price: example
                    converted_price: example
                    taxonomy_id: 1234
                    readiness_state_id: 1
                    suggested_title: Handmade Ceramic Mug — Stoneware
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListing400Example:
                  summary: Default updateListing 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListing401Example:
                  summary: Default updateListing 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListing403Example:
                  summary: Default updateListing 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListing409Example:
                  summary: Default updateListing 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListing404Example:
                  summary: Default updateListing 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateListing500Example:
                  summary: Default updateListing 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Listing
  /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images:
    get:
      operationId: getListingVariationImages
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGets all variation images on a listing."
      tags:
        - ShopListing VariationImage
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '200':
          description: A list of ListingVariationImages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingVariationImages'
              examples:
                GetListingVariationImages200Example:
                  summary: Default getListingVariationImages 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - property_id: 1
                        value_id: 1
                        value: example string
                        image_id: 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVariationImages404Example:
                  summary: Default getListingVariationImages 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVariationImages400Example:
                  summary: Default getListingVariationImages 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVariationImages403Example:
                  summary: Default getListingVariationImages 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVariationImages500Example:
                  summary: Default getListingVariationImages 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Variation Images
    post:
      operationId: updateVariationImages
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates variation images on a listing. `variation_images` is an array with inputs for the `property_id`, `value_id`, and `image_id` fields. `image_ids` are associated with a `ListingImage` on the listing associated with the provided `listing_id`. `property_id` and `value_id` pairs are associated with a `ListingProduct` on the listing associated with the provided `listing_id`. `variation_images` should not contain any duplicates. `variation_images` does not contain more than one `property_id` as variation images can only be associated on one property. The update overwrites all existing variation images on a listing, so if your request is successful, the variation images on the listing will be exactly those you specify. "
      tags:
        - ShopListing VariationImage
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - variation_images
              properties:
                variation_images:
                  type: array
                  description: A list of variation image data.
                  items:
                    type: object
                    properties:
                      property_id:
                        type: integer
                        format: int64
                        minimum: 1
                      value_id:
                        type: integer
                        format: int64
                        minimum: 1
                      image_id:
                        type: integer
                        format: int64
                        minimum: 1
                    required:
                      - property_id
                      - value_id
                      - image_id
            examples:
              UpdateVariationImagesRequestExample:
                summary: Default updateVariationImages request
                x-microcks-default: true
                value:
                  variation_images:
                    - property_id: 1
                      value_id: 1
                      image_id: 1
      responses:
        '200':
          description: A single ListingVariationImage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingVariationImages'
              examples:
                UpdateVariationImages200Example:
                  summary: Default updateVariationImages 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - property_id: 1
                        value_id: 1
                        value: example string
                        image_id: 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateVariationImages404Example:
                  summary: Default updateVariationImages 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateVariationImages400Example:
                  summary: Default updateVariationImages 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateVariationImages409Example:
                  summary: Default updateVariationImages 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateVariationImages403Example:
                  summary: Default updateVariationImages 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateVariationImages401Example:
                  summary: Default updateVariationImages 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateVariationImages500Example:
                  summary: Default updateVariationImages 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Variation Images
  /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}:
    delete:
      operationId: deleteListingVideo
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to delete a listing video. A copy of the video remains on our servers, and so a deleted video may be re-associated with the listing without re-uploading the original video; see uploadListingVideo."
      tags:
        - ShopListing Video
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: video_id
          in: path
          description: The unique ID of a video associated with a listing.
          required: true
          schema:
            type: integer
            description: The unique ID of a video associated with a listing.
            format: int64
            minimum: 1
          example: 1
      responses:
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingVideo404Example:
                  summary: Default deleteListingVideo 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingVideo400Example:
                  summary: Default deleteListingVideo 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingVideo401Example:
                  summary: Default deleteListingVideo 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingVideo403Example:
                  summary: Default deleteListingVideo 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '204':
          description: The ListingVideo resource was correctly deleted
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteListingVideo500Example:
                  summary: Default deleteListingVideo 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Listing Video
  /v3/application/listings/{listing_id}/videos/{video_id}:
    get:
      operationId: getListingVideo
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a single video associated with the given listing. Requesting a video from a listing returns an empty result."
      tags:
        - ShopListing Video
      parameters:
        - name: video_id
          in: path
          description: The unique ID of a video associated with a listing.
          required: true
          schema:
            type: integer
            description: The unique ID of a video associated with a listing.
            format: int64
            minimum: 1
          example: 1
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '200':
          description: The metadata for a video associated with a listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingVideo'
              examples:
                GetListingVideo200Example:
                  summary: Default getListingVideo 200 response
                  x-microcks-default: true
                  value:
                    video_id: 1
                    height: 1
                    width: 1
                    thumbnail_url: https://www.etsy.com/listing/123456789
                    video_url: https://www.etsy.com/listing/123456789
                    video_state: active
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideo404Example:
                  summary: Default getListingVideo 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideo400Example:
                  summary: Default getListingVideo 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideo403Example:
                  summary: Default getListingVideo 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideo401Example:
                  summary: Default getListingVideo 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideo500Example:
                  summary: Default getListingVideo 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Video
  /v3/application/listings/{listing_id}/videos:
    get:
      operationId: getListingVideos
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves all listing video resources for a listing with a specific listing ID."
      tags:
        - ShopListing Video
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      responses:
        '200':
          description: A list of videos for a listing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingVideos'
              examples:
                GetListingVideos200Example:
                  summary: Default getListingVideos 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideos404Example:
                  summary: Default getListingVideos 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideos400Example:
                  summary: Default getListingVideos 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideos403Example:
                  summary: Default getListingVideos 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingVideos500Example:
                  summary: Default getListingVideos 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listing Videos
  /v3/application/shops/{shop_id}/listings/{listing_id}/videos:
    post:
      operationId: uploadListingVideo
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUploads a new video for a listing, or associates an existing video with a specific listing. You must either provide the `video_id` of an existing video, or the name and binary file data for a video to upload. If providing a `video_id`, the video must already be associated with the same shop as the listing, but it does not need to be currently associated with the listing. "
      tags:
        - ShopListing Video
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                video_id:
                  type: integer
                  description: The unique ID of a video associated with a listing.
                  format: int64
                  minimum: 1
                video:
                  type: string
                  description: A video file to upload.
                  format: binary
                  nullable: true
                name:
                  type: string
                  description: The file name string for the video to upload.
      responses:
        '201':
          description: The metadata for a file associated with a digital listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingVideo'
              examples:
                UploadListingVideo201Example:
                  summary: Default uploadListingVideo 201 response
                  x-microcks-default: true
                  value:
                    video_id: 1
                    height: 1
                    width: 1
                    thumbnail_url: https://www.etsy.com/listing/123456789
                    video_url: https://www.etsy.com/listing/123456789
                    video_state: active
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingVideo404Example:
                  summary: Default uploadListingVideo 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingVideo400Example:
                  summary: Default uploadListingVideo 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingVideo403Example:
                  summary: Default uploadListingVideo 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingVideo401Example:
                  summary: Default uploadListingVideo 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingVideo409Example:
                  summary: Default uploadListingVideo 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UploadListingVideo500Example:
                  summary: Default uploadListingVideo 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Upload Listing Video
  /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}:
    get:
      operationId: getShopPaymentAccountLedgerEntry
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGet a single Shop Payment Account Ledger's Entry"
      tags:
        - Ledger Entry
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: ledger_entry_id
          in: path
          description: The unique ID of the shop owner ledger entry.
          required: true
          schema:
            type: integer
            description: The unique ID of the shop owner ledger entry.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single of PaymentAccountLedgerEntry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccountLedgerEntry'
              examples:
                GetShopPaymentAccountLedgerEntry200Example:
                  summary: Default getShopPaymentAccountLedgerEntry 200 response
                  x-microcks-default: true
                  value:
                    entry_id: 1
                    ledger_id: 1
                    sequence_number: 1
                    amount: 2500
                    currency: example string
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    balance: 1
                    create_date: 1
                    created_timestamp: 1758153645
                    ledger_type: example string
                    reference_type: example string
                    reference_id: example string
                    parent_entry_id: 1
                    payment_adjustments:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntry400Example:
                  summary: Default getShopPaymentAccountLedgerEntry 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntry403Example:
                  summary: Default getShopPaymentAccountLedgerEntry 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntry401Example:
                  summary: Default getShopPaymentAccountLedgerEntry 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntry500Example:
                  summary: Default getShopPaymentAccountLedgerEntry 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Payment Account Ledger Entry
  /v3/application/shops/{shop_id}/payment-account/ledger-entries:
    get:
      operationId: getShopPaymentAccountLedgerEntries
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGet a Shop Payment Account Ledger's Entries"
      tags:
        - Ledger Entry
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: min_created
          in: query
          description: The earliest unix timestamp for when a record was created.
          required: true
          schema:
            type: integer
            description: The earliest unix timestamp for when a record was created.
            minimum: 946684800
          example: 1
        - name: max_created
          in: query
          description: The latest unix timestamp for when a record was created.
          required: true
          schema:
            type: integer
            description: The latest unix timestamp for when a record was created.
            minimum: 946684800
          example: 1
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: A list of PaymentAccountLedgerEntries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccountLedgerEntries'
              examples:
                GetShopPaymentAccountLedgerEntries200Example:
                  summary: Default getShopPaymentAccountLedgerEntries 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntries400Example:
                  summary: Default getShopPaymentAccountLedgerEntries 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntries403Example:
                  summary: Default getShopPaymentAccountLedgerEntries 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntries401Example:
                  summary: Default getShopPaymentAccountLedgerEntries 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentAccountLedgerEntries500Example:
                  summary: Default getShopPaymentAccountLedgerEntries 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Payment Account Ledger Entries
  /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments:
    get:
      operationId: getPaymentAccountLedgerEntryPayments
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGet a Payment from a PaymentAccount Ledger Entry ID, if applicable"
      tags:
        - Payment
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: ledger_entry_ids
          in: query
          description: ''
          required: true
          schema:
            type: array
            items:
              type: integer
              format: int64
              minimum: 1
          example:
            - 1
      responses:
        '200':
          description: A list of Payments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments'
              examples:
                GetPaymentAccountLedgerEntryPayments200Example:
                  summary: Default getPaymentAccountLedgerEntryPayments 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPaymentAccountLedgerEntryPayments400Example:
                  summary: Default getPaymentAccountLedgerEntryPayments 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPaymentAccountLedgerEntryPayments403Example:
                  summary: Default getPaymentAccountLedgerEntryPayments 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPaymentAccountLedgerEntryPayments401Example:
                  summary: Default getPaymentAccountLedgerEntryPayments 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPaymentAccountLedgerEntryPayments500Example:
                  summary: Default getPaymentAccountLedgerEntryPayments 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Payment Account Ledger Entry Payments
  /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments:
    get:
      operationId: getShopPaymentByReceiptId
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a payment from a specific receipt, identified by `receipt_id`, from a specific shop, identified by `shop_id`"
      tags:
        - Payment
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: receipt_id
          in: path
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
            format: int64
            minimum: 1
          example: 234567890
      responses:
        '200':
          description: A single payment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments'
              examples:
                GetShopPaymentByReceiptId200Example:
                  summary: Default getShopPaymentByReceiptId 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentByReceiptId404Example:
                  summary: Default getShopPaymentByReceiptId 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentByReceiptId403Example:
                  summary: Default getShopPaymentByReceiptId 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentByReceiptId400Example:
                  summary: Default getShopPaymentByReceiptId 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentByReceiptId401Example:
                  summary: Default getShopPaymentByReceiptId 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopPaymentByReceiptId500Example:
                  summary: Default getShopPaymentByReceiptId 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Payment by Receipt Id
  /v3/application/shops/{shop_id}/payments:
    get:
      operationId: getPayments
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of payments from a shop identified by `shop_id`. You can also filter results using a list of payment IDs."
      tags:
        - Payment
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: payment_ids
          in: query
          description: A comma-separated array of Payment IDs numbers.
          required: true
          schema:
            type: array
            description: A comma-separated array of Payment IDs numbers.
            items:
              type: integer
              format: int64
              minimum: 1
          example:
            - 1
      responses:
        '200':
          description: A list of payments from a specific shop.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments'
              examples:
                GetPayments200Example:
                  summary: Default getPayments 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPayments404Example:
                  summary: Default getPayments 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPayments403Example:
                  summary: Default getPayments 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPayments400Example:
                  summary: Default getPayments 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPayments401Example:
                  summary: Default getPayments 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPayments500Example:
                  summary: Default getPayments 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Payments
  /v3/application/openapi-ping:
    get:
      operationId: ping
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCheck to confirm connectivity to the Etsy API with an application"
      tags:
        - Other
      parameters: []
      responses:
        '200':
          description: A confirmation that the current application has access to the Open API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pong'
              examples:
                Ping200Example:
                  summary: Default ping 200 response
                  x-microcks-default: true
                  value:
                    application_id: 1
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                Ping401Example:
                  summary: Default ping 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: App does not have the proper permissions to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                Ping404Example:
                  summary: Default ping 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                Ping500Example:
                  summary: Default ping 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Ping
  /v3/application/shops/{shop_id}/receipts/{receipt_id}:
    get:
      operationId: getShopReceipt
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a receipt, identified by a receipt id, from an Etsy shop. **NOTE** Access to ShopReceipt's first_line, second_line, city, state, zip, country_iso and formatted_address is contingent in some regions to a preferred partnership status with Etsy"
      tags:
        - Shop Receipt
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: receipt_id
          in: path
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
            format: int64
            minimum: 1
          example: 234567890
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A single Shop Receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceipt'
              examples:
                GetShopReceipt200Example:
                  summary: Default getShopReceipt 200 response
                  x-microcks-default: true
                  value:
                    receipt_id: 234567890
                    receipt_type: 1
                    seller_user_id: 456789
                    seller_email: seller@example.com
                    buyer_user_id: 456789
                    buyer_email: seller@example.com
                    name: Handmade Ceramic Mug
                    first_line: 123 Main St
                    second_line: Apt 4B
                    city: Brooklyn
                    state: example string
                    zip: '11201'
                    status: paid
                    formatted_address: example string
                    country_iso: US
                    payment_method: example string
                    payment_email: seller@example.com
                    message_from_seller: Thanks for your order! Shipping out tomorrow.
                    message_from_buyer: Thanks for your order! Shipping out tomorrow.
                    message_from_payment: Thanks for your order! Shipping out tomorrow.
                    is_paid: true
                    is_shipped: true
                    create_timestamp: 1758153645
                    created_timestamp: 1758153645
                    update_timestamp: 1758153645
                    updated_timestamp: 1758153645
                    is_gift: true
                    gift_message: Thanks for your order! Shipping out tomorrow.
                    gift_sender: example string
                    grandtotal: example
                    subtotal: example
                    total_price: example
                    total_shipping_cost: example
                    total_tax_cost: example
                    total_vat_cost: example
                    discount_amt: example
                    gift_wrap_price: example
                    shipments:
                      - 
                    transactions:
                      - 
                    refunds:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipt404Example:
                  summary: Default getShopReceipt 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipt403Example:
                  summary: Default getShopReceipt 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipt400Example:
                  summary: Default getShopReceipt 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipt401Example:
                  summary: Default getShopReceipt 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipt500Example:
                  summary: Default getShopReceipt 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Receipt
    put:
      operationId: updateShopReceipt
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates the status of a receipt, identified by a receipt id, from an Etsy shop. **NOTE** Access to ShopReceipt's first_line, second_line, city, state, zip, country_iso and formatted_address is contingent in some regions to a preferred partnership status with Etsy"
      tags:
        - Shop Receipt
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: receipt_id
          in: path
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
            format: int64
            minimum: 1
          example: 234567890
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                was_shipped:
                  type: boolean
                  description: When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set.
                  nullable: true
                was_paid:
                  type: boolean
                  description: When `true`, returns receipts where the seller has received payment for the receipt. When `false`, returns receipts where payment has not been received.
                  nullable: true
            examples:
              UpdateShopReceiptRequestExample:
                summary: Default updateShopReceipt request
                x-microcks-default: true
                value:
                  was_shipped: true
                  was_paid: true
      responses:
        '200':
          description: Update A Shop Receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceipt'
              examples:
                UpdateShopReceipt200Example:
                  summary: Default updateShopReceipt 200 response
                  x-microcks-default: true
                  value:
                    receipt_id: 234567890
                    receipt_type: 1
                    seller_user_id: 456789
                    seller_email: seller@example.com
                    buyer_user_id: 456789
                    buyer_email: seller@example.com
                    name: Handmade Ceramic Mug
                    first_line: 123 Main St
                    second_line: Apt 4B
                    city: Brooklyn
                    state: example string
                    zip: '11201'
                    status: paid
                    formatted_address: example string
                    country_iso: US
                    payment_method: example string
                    payment_email: seller@example.com
                    message_from_seller: Thanks for your order! Shipping out tomorrow.
                    message_from_buyer: Thanks for your order! Shipping out tomorrow.
                    message_from_payment: Thanks for your order! Shipping out tomorrow.
                    is_paid: true
                    is_shipped: true
                    create_timestamp: 1758153645
                    created_timestamp: 1758153645
                    update_timestamp: 1758153645
                    updated_timestamp: 1758153645
                    is_gift: true
                    gift_message: Thanks for your order! Shipping out tomorrow.
                    gift_sender: example string
                    grandtotal: example
                    subtotal: example
                    total_price: example
                    total_shipping_cost: example
                    total_tax_cost: example
                    total_vat_cost: example
                    discount_amt: example
                    gift_wrap_price: example
                    shipments:
                      - 
                    transactions:
                      - 
                    refunds:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReceipt404Example:
                  summary: Default updateShopReceipt 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReceipt403Example:
                  summary: Default updateShopReceipt 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReceipt400Example:
                  summary: Default updateShopReceipt 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReceipt401Example:
                  summary: Default updateShopReceipt 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReceipt500Example:
                  summary: Default updateShopReceipt 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Receipt
  /v3/application/shops/{shop_id}/receipts:
    get:
      operationId: getShopReceipts
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRequests the Shop Receipts from a specific Shop, unfiltered or filtered by receipt id range or offset, date, paid, and/or shipped purchases. **NOTE** Access to ShopReceipt's first_line, second_line, city, state, zip, country_iso and formatted_address is contingent in some regions to a preferred partnership status with Etsy"
      tags:
        - Shop Receipt
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: min_created
          in: query
          description: The earliest unix timestamp for when a record was created.
          required: false
          schema:
            type: integer
            description: The earliest unix timestamp for when a record was created.
            minimum: 946684800
            default:
          example: 1
        - name: max_created
          in: query
          description: The latest unix timestamp for when a record was created.
          required: false
          schema:
            type: integer
            description: The latest unix timestamp for when a record was created.
            minimum: 946684800
            default:
          example: 1
        - name: min_last_modified
          in: query
          description: The earliest unix timestamp for when a record last changed.
          required: false
          schema:
            type: integer
            description: The earliest unix timestamp for when a record last changed.
            minimum: 946684800
            default:
          example: 1
        - name: max_last_modified
          in: query
          description: The latest unix timestamp for when a record last changed.
          required: false
          schema:
            type: integer
            description: The latest unix timestamp for when a record last changed.
            minimum: 946684800
            default:
          example: 1
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: sort_on
          in: query
          description: The value to sort a search result of listings on.
          required: false
          schema:
            type: string
            description: The value to sort a search result of listings on.
            enum:
              - created
              - updated
              - receipt_id
            default: created
          example: created
        - name: sort_order
          in: query
          description: The ascending(up) or descending(down) order to sort receipts by.
          required: false
          schema:
            type: string
            description: The ascending(up) or descending(down) order to sort receipts by.
            enum:
              - asc
              - ascending
              - desc
              - descending
              - up
              - down
            default: desc
          example: asc
        - name: was_paid
          in: query
          description: When `true`, returns receipts where the seller has received payment for the receipt. When `false`, returns receipts where payment has not been received.
          required: false
          schema:
            type: boolean
            description: When `true`, returns receipts where the seller has received payment for the receipt. When `false`, returns receipts where payment has not been received.
            nullable: true
          example: true
        - name: was_shipped
          in: query
          description: When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set.
          required: false
          schema:
            type: boolean
            description: When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set.
            nullable: true
          example: true
        - name: was_delivered
          in: query
          description: When `true`, returns receipts that have been marked as delivered. When `false`, returns receipts where shipment has not been marked as delivered.
          required: false
          schema:
            type: boolean
            description: When `true`, returns receipts that have been marked as delivered. When `false`, returns receipts where shipment has not been marked as delivered.
            nullable: true
          example: true
        - name: was_canceled
          in: query
          description: When `true`, the endpoint will only return the canceled receipts. When `false`, the endpoint will only return non-canceled receipts.
          required: false
          schema:
            type: boolean
            description: When `true`, the endpoint will only return the canceled receipts. When `false`, the endpoint will only return non-canceled receipts.
            nullable: true
          example: true
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of Shop Receipts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceipts'
              examples:
                GetShopReceipts200Example:
                  summary: Default getShopReceipts 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipts403Example:
                  summary: Default getShopReceipts 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipts404Example:
                  summary: Default getShopReceipts 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipts400Example:
                  summary: Default getShopReceipts 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipts401Example:
                  summary: Default getShopReceipts 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceipts500Example:
                  summary: Default getShopReceipts 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Receipts
  /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings:
    get:
      operationId: getListingsByShopReceipt
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGets all listings associated with a receipt."
      tags:
        - ShopListing
      parameters:
        - name: receipt_id
          in: path
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
            format: int64
            minimum: 1
          example: 234567890
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A set of ShopListing resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListings'
              examples:
                GetListingsByShopReceipt200Example:
                  summary: Default getListingsByShopReceipt 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReceipt400Example:
                  summary: Default getListingsByShopReceipt 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReceipt403Example:
                  summary: Default getListingsByShopReceipt 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReceipt404Example:
                  summary: Default getListingsByShopReceipt 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReceipt401Example:
                  summary: Default getListingsByShopReceipt 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReceipt500Example:
                  summary: Default getListingsByShopReceipt 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listings by Shop Receipt
  /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking:
    post:
      operationId: createReceiptShipment
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nSubmits tracking information for a Shop Receipt, which creates a Shop Receipt Shipment entry for the given receipt_id. Each time you successfully submit tracking info, Etsy sends a notification email to the buyer User. When send_bcc is true, Etsy sends shipping notifications to the seller as well. When tracking_code and carrier_name aren't sent, the receipt is marked as shipped only. If the carrier is not supported, you may use `other` as the carrier name so you can provide the tracking code. **NOTES** When shipping within the United States AND the order is over $10 _or_ when shipping to India, tracking code and carrier name ARE required. Access to ShopReceipt's first_line, second_line, city, state, zip, country_iso and formatted_address is contingent in some regions to a preferred partnership status with Etsy"
      tags:
        - Shop Receipt
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: receipt_id
          in: path
          description: The receipt to submit tracking for.
          required: true
          schema:
            type: integer
            description: The receipt to submit tracking for.
            format: int64
            minimum: 1
          example: 234567890
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tracking_code:
                  type: string
                  description: The tracking code for this receipt.
                carrier_name:
                  type: string
                  description: The carrier name for this receipt.
                send_bcc:
                  type: boolean
                  description: If true, the shipping notification will be sent to the seller as well
                note_to_buyer:
                  type: string
                  description: Message to include in notification to the buyer.
                mail_class:
                  type: string
                  description: The service level of postal or carrier service selected for the shipment (e.g., First-Class, Priority, Ground, Express).
                  nullable: true
                weight:
                  type: number
                  description: The total weight of the package.
                  format: float
                  nullable: true
                weight_units:
                  type: string
                  description: Unit of measurement used for package weight (oz, grams, etc.).
                  nullable: true
                length:
                  type: number
                  description: Longest side of the package.
                  format: float
                  nullable: true
                width:
                  type: number
                  description: Second longest side of the package.
                  format: float
                  nullable: true
                height:
                  type: number
                  description: Third longest side of the package.
                  format: float
                  nullable: true
                dimension_units:
                  type: string
                  description: Unit of measurement used for package dimensions (in, cm...).
                  nullable: true
                shipping_label_cost:
                  type: number
                  description: The purchase price the seller paid for the shipping label.
                  format: float
                  nullable: true
                shipping_label_currency:
                  type: string
                  description: The currency in which the shipping label was purchased.
                  nullable: true
                revenue_eligibility:
                  type: string
                  description: A flag indicating if the shipment is tied to a revenue share agreement between Etsy and the vendor.
                  nullable: true
                ship_from_country:
                  type: string
                  description: Where the package ships from.
                  nullable: true
                ship_to_country:
                  type: string
                  description: Package destination.
                  nullable: true
                incoterm:
                  type: string
                  description: The specific incoterm (e.g., DDU, DDP) designated for the shipment.
                  nullable: true
                customs_data:
                  type: array
                  description: Contains custom data like country of origin, declared value and HS code.
                  nullable: true
                  items:
                    type: object
                    properties:
                      country_of_origin:
                        type: string
                        description: The country in which the goods originate from.
                        nullable: true
                        default:
                      declared_value:
                        type: number
                        description: The commercial value of the goods.
                        format: float
                        nullable: true
                        default:
                      HS_code:
                        type: string
                        description: The standardized global system (Harmonized System) for classifying traded products.
                        nullable: true
                        default:
                    required:
                      - country_of_origin
                      - declared_value
                      - HS_code
                duty_amount:
                  type: number
                  description: The estimated or actual amount of import duties and taxes assessed by customs for the shipment.
                  format: float
                  nullable: true
                duty_currency:
                  type: string
                  description: The currency in which the duty was paid.
                  nullable: true
                ship_date:
                  type: string
                  description: The date package was shipped.
                  nullable: true
            examples:
              CreateReceiptShipmentRequestExample:
                summary: Default createReceiptShipment request
                x-microcks-default: true
                value:
                  tracking_code: example string
                  carrier_name: example string
                  send_bcc: true
                  note_to_buyer: example string
                  mail_class: example string
                  weight: 1.0
                  weight_units: example string
                  length: 1.0
                  width: 1.0
                  height: 1.0
                  dimension_units: example string
                  shipping_label_cost: 1.0
                  shipping_label_currency: example string
                  revenue_eligibility: example string
                  ship_from_country: example string
                  ship_to_country: example string
                  incoterm: example string
                  customs_data:
                    - country_of_origin: example string
                      declared_value: 1.0
                      HS_code: example string
                  duty_amount: 1.0
                  duty_currency: example string
                  ship_date: example string
      responses:
        '200':
          description: A single ShopReceipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceipt'
              examples:
                CreateReceiptShipment200Example:
                  summary: Default createReceiptShipment 200 response
                  x-microcks-default: true
                  value:
                    receipt_id: 234567890
                    receipt_type: 1
                    seller_user_id: 456789
                    seller_email: seller@example.com
                    buyer_user_id: 456789
                    buyer_email: seller@example.com
                    name: Handmade Ceramic Mug
                    first_line: 123 Main St
                    second_line: Apt 4B
                    city: Brooklyn
                    state: example string
                    zip: '11201'
                    status: paid
                    formatted_address: example string
                    country_iso: US
                    payment_method: example string
                    payment_email: seller@example.com
                    message_from_seller: Thanks for your order! Shipping out tomorrow.
                    message_from_buyer: Thanks for your order! Shipping out tomorrow.
                    message_from_payment: Thanks for your order! Shipping out tomorrow.
                    is_paid: true
                    is_shipped: true
                    create_timestamp: 1758153645
                    created_timestamp: 1758153645
                    update_timestamp: 1758153645
                    updated_timestamp: 1758153645
                    is_gift: true
                    gift_message: Thanks for your order! Shipping out tomorrow.
                    gift_sender: example string
                    grandtotal: example
                    subtotal: example
                    total_price: example
                    total_shipping_cost: example
                    total_tax_cost: example
                    total_vat_cost: example
                    discount_amt: example
                    gift_wrap_price: example
                    shipments:
                      - 
                    transactions:
                      - 
                    refunds:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateReceiptShipment404Example:
                  summary: Default createReceiptShipment 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateReceiptShipment409Example:
                  summary: Default createReceiptShipment 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateReceiptShipment403Example:
                  summary: Default createReceiptShipment 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateReceiptShipment400Example:
                  summary: Default createReceiptShipment 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateReceiptShipment401Example:
                  summary: Default createReceiptShipment 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateReceiptShipment500Example:
                  summary: Default createReceiptShipment 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Receipt Shipment
  /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions:
    get:
      operationId: getShopReceiptTransactionsByReceipt
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the list of transactions associated with a specific receipt."
      tags:
        - Shop Receipt Transactions
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: receipt_id
          in: path
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
            format: int64
            minimum: 1
          example: 234567890
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceiptTransactions'
              examples:
                GetShopReceiptTransactionsByReceipt200Example:
                  summary: Default getShopReceiptTransactionsByReceipt 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByReceipt404Example:
                  summary: Default getShopReceiptTransactionsByReceipt 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByReceipt403Example:
                  summary: Default getShopReceiptTransactionsByReceipt 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByReceipt400Example:
                  summary: Default getShopReceiptTransactionsByReceipt 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByReceipt401Example:
                  summary: Default getShopReceiptTransactionsByReceipt 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByReceipt500Example:
                  summary: Default getShopReceiptTransactionsByReceipt 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Receipt Transactions by Receipt
  /v3/application/listings/{listing_id}/reviews:
    get:
      operationId: getReviewsByListing
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 to retrieve the reviews for a listing given its ID."
      tags:
        - Review
      parameters:
        - name: listing_id
          in: path
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          required: true
          schema:
            type: integer
            description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
            format: int64
            minimum: 1
          example: 123456789
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: min_created
          in: query
          description: The earliest unix timestamp for when a record was created.
          required: false
          schema:
            type: integer
            description: The earliest unix timestamp for when a record was created.
            nullable: true
            minimum: 946684800
          example: 1
        - name: max_created
          in: query
          description: The latest unix timestamp for when a record was created.
          required: false
          schema:
            type: integer
            description: The latest unix timestamp for when a record was created.
            nullable: true
            minimum: 946684800
          example: 1
      responses:
        '200':
          description: A set of Transaction Reviews by Listing ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingReviews'
              examples:
                GetReviewsByListing200Example:
                  summary: Default getReviewsByListing 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetReviewsByListing404Example:
                  summary: Default getReviewsByListing 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetReviewsByListing400Example:
                  summary: Default getReviewsByListing 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetReviewsByListing500Example:
                  summary: Default getReviewsByListing 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Reviews by Listing
  /v3/application/shops/{shop_id}/reviews:
    get:
      operationId: getReviewsByShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 to retrieve the reviews from a shop given its ID."
      tags:
        - Review
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: min_created
          in: query
          description: The earliest unix timestamp for when a record was created.
          required: false
          schema:
            type: integer
            description: The earliest unix timestamp for when a record was created.
            nullable: true
            minimum: 946684800
          example: 1
        - name: max_created
          in: query
          description: The latest unix timestamp for when a record was created.
          required: false
          schema:
            type: integer
            description: The latest unix timestamp for when a record was created.
            nullable: true
            minimum: 946684800
          example: 1
      responses:
        '200':
          description: A set of Transaction Reviews By Shop ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionReviews'
              examples:
                GetReviewsByShop200Example:
                  summary: Default getReviewsByShop 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetReviewsByShop404Example:
                  summary: Default getReviewsByShop 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetReviewsByShop400Example:
                  summary: Default getReviewsByShop 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetReviewsByShop500Example:
                  summary: Default getReviewsByShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Reviews by Shop
  /v3/application/seller-taxonomy/nodes:
    get:
      operationId: getSellerTaxonomyNodes
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the full hierarchy tree of seller taxonomy nodes."
      tags:
        - SellerTaxonomy
      parameters: []
      responses:
        '200':
          description: List the full hierarchy tree of seller taxonomy nodes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerTaxonomyNodes'
              examples:
                GetSellerTaxonomyNodes200Example:
                  summary: Default getSellerTaxonomyNodes 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '503':
          description: The service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetSellerTaxonomyNodes503Example:
                  summary: Default getSellerTaxonomyNodes 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetSellerTaxonomyNodes500Example:
                  summary: Default getSellerTaxonomyNodes 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Seller Taxonomy Nodes
  /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties:
    get:
      operationId: getPropertiesByTaxonomyId
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of product properties, with applicable scales and values, supported for a specific seller taxonomy ID."
      tags:
        - SellerTaxonomy
      parameters:
        - name: taxonomy_id
          in: path
          description: "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\"."
          required: true
          schema:
            type: integer
            description: "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\"."
            format: int64
            minimum: 1
          example: 1234
      responses:
        '200':
          description: A list of product properties, with applicable scales and values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxonomyNodeProperties'
              examples:
                GetPropertiesByTaxonomyId200Example:
                  summary: Default getPropertiesByTaxonomyId 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPropertiesByTaxonomyId404Example:
                  summary: Default getPropertiesByTaxonomyId 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPropertiesByTaxonomyId400Example:
                  summary: Default getPropertiesByTaxonomyId 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetPropertiesByTaxonomyId500Example:
                  summary: Default getPropertiesByTaxonomyId 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Properties by Taxonomy Id
  /v3/application/shipping-carriers:
    get:
      operationId: getShippingCarriers
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of available shipping carriers and the mail classes associated with them for a given country"
      tags:
        - Shop ShippingProfile
      parameters:
        - name: origin_country_iso
          in: query
          description: The ISO code of the country from which the listing ships.
          required: true
          schema:
            type: string
            description: The ISO code of the country from which the listing ships.
            format: ISO 3166-1 alpha-2
          example: US
      responses:
        '200':
          description: A set of ShippingCarriers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingCarriers'
              examples:
                GetShippingCarriers200Example:
                  summary: Default getShippingCarriers 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - shipping_carrier_id: 1
                        name: Handmade Ceramic Mug
                        domestic_classes:
                          - {}
                        international_classes:
                          - {}
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShippingCarriers400Example:
                  summary: Default getShippingCarriers 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShippingCarriers500Example:
                  summary: Default getShippingCarriers 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shipping Carriers
  /v3/application/shops/{shop_id}:
    get:
      operationId: getShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the shop identified by a specific shop ID."
      tags:
        - Shop
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: A single Shop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shop'
              examples:
                GetShop200Example:
                  summary: Default getShop 200 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    user_id: 456789
                    shop_name: HandmadeCrafts
                    create_date: 1
                    created_timestamp: 1758153645
                    title: Handmade Ceramic Mug — Stoneware
                    announcement: example string
                    currency_code: USD
                    is_vacation: true
                    vacation_message: Thanks for your order! Shipping out tomorrow.
                    sale_message: Thanks for your order! Shipping out tomorrow.
                    digital_sale_message: Thanks for your order! Shipping out tomorrow.
                    update_date: 1
                    updated_timestamp: 1758153645
                    listing_active_count: 1
                    digital_listing_count: 1
                    login_name: handmade_seller
                    accepts_custom_requests: true
                    policy_welcome: example string
                    policy_payment: example string
                    policy_shipping: example string
                    policy_refunds: example string
                    policy_additional: example string
                    policy_seller_info: example string
                    policy_update_date: 1
                    policy_has_private_receipt_info: true
                    has_unstructured_policies: true
                    policy_privacy: example string
                    vacation_autoreply: example string
                    url: https://www.etsy.com/listing/123456789
                    image_url_760x100: https://www.etsy.com/listing/123456789
                    num_favorers: 1
                    languages:
                      - example string
                    icon_url_fullxfull: https://www.etsy.com/listing/123456789
                    is_using_structured_policies: true
                    has_onboarded_structured_policies: true
                    include_dispute_form_link: true
                    is_direct_checkout_onboarded: true
                    is_etsy_payments_onboarded: true
                    is_calculated_eligible: true
                    is_opted_in_to_buyer_promise: true
                    is_shop_us_based: true
                    transaction_sold_count: 1
                    shipping_from_country_iso: US
                    shop_location_country_iso: US
                    review_count: 1
                    review_average: 1.0
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShop404Example:
                  summary: Default getShop 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShop400Example:
                  summary: Default getShop 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShop500Example:
                  summary: Default getShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop
    put:
      operationId: updateShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates a shop. Assumes that all string parameters are provided in the shop's primary language. Please note that the policy_additional field should only be set for shops located in the EU. Passing a value for this field for shops outside of the EU, will result in an error."
      tags:
        - Shop
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: A brief heading string for the shop's main page.
                announcement:
                  type: string
                  description: An announcement string to buyers that displays on the shop's homepage.
                sale_message:
                  type: string
                  description: A message string sent to users who complete a purchase from this shop.
                digital_sale_message:
                  type: string
                  description: A message string sent to users who purchase a digital item from this shop.
                policy_additional:
                  type: string
                  description: The shop's additional policies string (may be blank).
            examples:
              UpdateShopRequestExample:
                summary: Default updateShop request
                x-microcks-default: true
                value:
                  title: example string
                  announcement: example string
                  sale_message: example string
                  digital_sale_message: example string
                  policy_additional: example string
      responses:
        '200':
          description: A single Shop.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shop'
              examples:
                UpdateShop200Example:
                  summary: Default updateShop 200 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    user_id: 456789
                    shop_name: HandmadeCrafts
                    create_date: 1
                    created_timestamp: 1758153645
                    title: Handmade Ceramic Mug — Stoneware
                    announcement: example string
                    currency_code: USD
                    is_vacation: true
                    vacation_message: Thanks for your order! Shipping out tomorrow.
                    sale_message: Thanks for your order! Shipping out tomorrow.
                    digital_sale_message: Thanks for your order! Shipping out tomorrow.
                    update_date: 1
                    updated_timestamp: 1758153645
                    listing_active_count: 1
                    digital_listing_count: 1
                    login_name: handmade_seller
                    accepts_custom_requests: true
                    policy_welcome: example string
                    policy_payment: example string
                    policy_shipping: example string
                    policy_refunds: example string
                    policy_additional: example string
                    policy_seller_info: example string
                    policy_update_date: 1
                    policy_has_private_receipt_info: true
                    has_unstructured_policies: true
                    policy_privacy: example string
                    vacation_autoreply: example string
                    url: https://www.etsy.com/listing/123456789
                    image_url_760x100: https://www.etsy.com/listing/123456789
                    num_favorers: 1
                    languages:
                      - example string
                    icon_url_fullxfull: https://www.etsy.com/listing/123456789
                    is_using_structured_policies: true
                    has_onboarded_structured_policies: true
                    include_dispute_form_link: true
                    is_direct_checkout_onboarded: true
                    is_etsy_payments_onboarded: true
                    is_calculated_eligible: true
                    is_opted_in_to_buyer_promise: true
                    is_shop_us_based: true
                    transaction_sold_count: 1
                    shipping_from_country_iso: US
                    shop_location_country_iso: US
                    review_count: 1
                    review_average: 1.0
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShop400Example:
                  summary: Default updateShop 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShop403Example:
                  summary: Default updateShop 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShop404Example:
                  summary: Default updateShop 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShop401Example:
                  summary: Default updateShop 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShop500Example:
                  summary: Default updateShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop
  /v3/application/users/{user_id}/shops:
    get:
      operationId: getShopByOwnerUserId
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the shop identified by the shop owner's user ID."
      tags:
        - Shop
      parameters:
        - name: user_id
          in: path
          description: The numeric user ID of the [user](/documentation/reference#tag/User) who owns this shop.
          required: true
          schema:
            type: integer
            description: The numeric user ID of the [user](/documentation/reference#tag/User) who owns this shop.
            format: int64
            minimum: 1
          example: 456789
      responses:
        '200':
          description: A single Shop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shop'
              examples:
                GetShopByOwnerUserId200Example:
                  summary: Default getShopByOwnerUserId 200 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    user_id: 456789
                    shop_name: HandmadeCrafts
                    create_date: 1
                    created_timestamp: 1758153645
                    title: Handmade Ceramic Mug — Stoneware
                    announcement: example string
                    currency_code: USD
                    is_vacation: true
                    vacation_message: Thanks for your order! Shipping out tomorrow.
                    sale_message: Thanks for your order! Shipping out tomorrow.
                    digital_sale_message: Thanks for your order! Shipping out tomorrow.
                    update_date: 1
                    updated_timestamp: 1758153645
                    listing_active_count: 1
                    digital_listing_count: 1
                    login_name: handmade_seller
                    accepts_custom_requests: true
                    policy_welcome: example string
                    policy_payment: example string
                    policy_shipping: example string
                    policy_refunds: example string
                    policy_additional: example string
                    policy_seller_info: example string
                    policy_update_date: 1
                    policy_has_private_receipt_info: true
                    has_unstructured_policies: true
                    policy_privacy: example string
                    vacation_autoreply: example string
                    url: https://www.etsy.com/listing/123456789
                    image_url_760x100: https://www.etsy.com/listing/123456789
                    num_favorers: 1
                    languages:
                      - example string
                    icon_url_fullxfull: https://www.etsy.com/listing/123456789
                    is_using_structured_policies: true
                    has_onboarded_structured_policies: true
                    include_dispute_form_link: true
                    is_direct_checkout_onboarded: true
                    is_etsy_payments_onboarded: true
                    is_calculated_eligible: true
                    is_opted_in_to_buyer_promise: true
                    is_shop_us_based: true
                    transaction_sold_count: 1
                    shipping_from_country_iso: US
                    shop_location_country_iso: US
                    review_count: 1
                    review_average: 1.0
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopByOwnerUserId404Example:
                  summary: Default getShopByOwnerUserId 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopByOwnerUserId400Example:
                  summary: Default getShopByOwnerUserId 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopByOwnerUserId403Example:
                  summary: Default getShopByOwnerUserId 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopByOwnerUserId500Example:
                  summary: Default getShopByOwnerUserId 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop by Owner User Id
  /v3/application/shops/{shop_id}/holiday-preferences:
    get:
      operationId: getHolidayPreferences
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of holidays that are available to a shop to set a preference for. Currently only supported in the US and CA"
      tags:
        - Shop HolidayPreferences
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: A list of holiday preferences
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ShopHolidayPreference'
              examples:
                GetHolidayPreferences200Example:
                  summary: Default getHolidayPreferences 200 response
                  x-microcks-default: true
                  value:
                    - shop_id: 123456
                      holiday_id: 1
                      country_iso: US
                      is_working: true
                      holiday_name: Handmade Ceramic Mug
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetHolidayPreferences403Example:
                  summary: Default getHolidayPreferences 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetHolidayPreferences400Example:
                  summary: Default getHolidayPreferences 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetHolidayPreferences500Example:
                  summary: Default getHolidayPreferences 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Holiday Preferences
  /v3/application/shops/{shop_id}/holiday-preferences/{holiday_id}:
    put:
      operationId: updateHolidayPreferences
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates the preference for whether the seller will process orders or not on the holiday. Currently only supported in the US and CA"
      tags:
        - Shop HolidayPreferences
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: holiday_id
          in: path
          description: 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
          required: true
          schema:
            type: integer
            description: 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
            enum:
              - 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
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - is_working
              properties:
                is_working:
                  type: boolean
                  description: A boolean value for whether the shop will process orders on a particular holiday.
            examples:
              UpdateHolidayPreferencesRequestExample:
                summary: Default updateHolidayPreferences request
                x-microcks-default: true
                value:
                  is_working: true
      responses:
        '200':
          description: The updated holiday preferences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopHolidayPreference'
              examples:
                UpdateHolidayPreferences200Example:
                  summary: Default updateHolidayPreferences 200 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    holiday_id: 1
                    country_iso: US
                    is_working: true
                    holiday_name: Handmade Ceramic Mug
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateHolidayPreferences403Example:
                  summary: Default updateHolidayPreferences 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateHolidayPreferences400Example:
                  summary: Default updateHolidayPreferences 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateHolidayPreferences500Example:
                  summary: Default updateHolidayPreferences 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Holiday Preferences
  /v3/application/shops:
    get:
      operationId: findShops
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint for searching shops by name. Note: We make every effort to ensure that frozen or removed shops are not included in the search results. However, rarely, due to timing issues, they may appear."
      tags:
        - Shop
      parameters:
        - name: shop_name
          in: query
          description: The shop's name string.
          required: true
          schema:
            type: string
            description: The shop's name string.
          example: HandmadeCrafts
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: A list of Shops
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shops'
              examples:
                FindShops200Example:
                  summary: Default findShops 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                FindShops500Example:
                  summary: Default findShops 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Find Shops
  /v3/application/shops/{shop_id}/policies/return/consolidate:
    post:
      operationId: consolidateShopReturnPolicies
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nConsolidates Return Policies by moving all listings from a source return policy to a destination return policy, and deleting the source return policy. This is commonly used in the event that a user attempts to update a Return Policy such that its data is a duplicate of some other Return Policy, which is prevented."
      tags:
        - Shop Return Policy
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - source_return_policy_id
                - destination_return_policy_id
              properties:
                source_return_policy_id:
                  type: integer
                  description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
                  format: int64
                  minimum: 1
                destination_return_policy_id:
                  type: integer
                  description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
                  format: int64
                  minimum: 1
            examples:
              ConsolidateShopReturnPoliciesRequestExample:
                summary: Default consolidateShopReturnPolicies request
                x-microcks-default: true
                value:
                  source_return_policy_id: 1
                  destination_return_policy_id: 1
      responses:
        '200':
          description: The updated target Return Policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReturnPolicy'
              examples:
                ConsolidateShopReturnPolicies200Example:
                  summary: Default consolidateShopReturnPolicies 200 response
                  x-microcks-default: true
                  value:
                    return_policy_id: 1
                    shop_id: 123456
                    accepts_returns: true
                    accepts_exchanges: true
                    return_deadline: 1
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                ConsolidateShopReturnPolicies403Example:
                  summary: Default consolidateShopReturnPolicies 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                ConsolidateShopReturnPolicies404Example:
                  summary: Default consolidateShopReturnPolicies 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                ConsolidateShopReturnPolicies400Example:
                  summary: Default consolidateShopReturnPolicies 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                ConsolidateShopReturnPolicies401Example:
                  summary: Default consolidateShopReturnPolicies 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                ConsolidateShopReturnPolicies500Example:
                  summary: Default consolidateShopReturnPolicies 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Consolidate Shop Return Policies
  /v3/application/shops/{shop_id}/policies/return:
    post:
      operationId: createShopReturnPolicy
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a new Return Policy. Note: if either accepts_returns or accepts_exchanges is true, then a return_deadline is required."
      tags:
        - Shop Return Policy
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - accepts_returns
                - accepts_exchanges
              properties:
                accepts_returns:
                  type: boolean
                accepts_exchanges:
                  type: boolean
                return_deadline:
                  type: integer
                  description: 'The deadline for the Return Policy, measured in days. The value must be one of the following: [7, 14, 21, 30, 45, 60, 90].'
                  nullable: true
            examples:
              CreateShopReturnPolicyRequestExample:
                summary: Default createShopReturnPolicy request
                x-microcks-default: true
                value:
                  accepts_returns: true
                  accepts_exchanges: true
                  return_deadline: 1
      responses:
        '200':
          description: A single Return Policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReturnPolicy'
              examples:
                CreateShopReturnPolicy200Example:
                  summary: Default createShopReturnPolicy 200 response
                  x-microcks-default: true
                  value:
                    return_policy_id: 1
                    shop_id: 123456
                    accepts_returns: true
                    accepts_exchanges: true
                    return_deadline: 1
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReturnPolicy403Example:
                  summary: Default createShopReturnPolicy 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReturnPolicy400Example:
                  summary: Default createShopReturnPolicy 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReturnPolicy401Example:
                  summary: Default createShopReturnPolicy 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReturnPolicy500Example:
                  summary: Default createShopReturnPolicy 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Shop Return Policy
    get:
      operationId: getShopReturnPolicies
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nReturns a shop's list of existing Return Policies"
      tags:
        - Shop Return Policy
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: List of shop's Return Policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReturnPolicies'
              examples:
                GetShopReturnPolicies200Example:
                  summary: Default getShopReturnPolicies 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - return_policy_id: 1
                        shop_id: 123456
                        accepts_returns: true
                        accepts_exchanges: true
                        return_deadline: 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicies404Example:
                  summary: Default getShopReturnPolicies 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicies400Example:
                  summary: Default getShopReturnPolicies 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicies401Example:
                  summary: Default getShopReturnPolicies 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicies500Example:
                  summary: Default getShopReturnPolicies 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Return Policies
  /v3/application/shops/{shop_id}/policies/return/{return_policy_id}:
    delete:
      operationId: deleteShopReturnPolicy
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes an existing Return Policy. Deletion is only allowed for policies which have no associated listings – move them to another policy before attempting deletion."
      tags:
        - Shop Return Policy
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: return_policy_id
          in: path
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          required: true
          schema:
            type: integer
            description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
            format: int64
            minimum: 1
          example: 1
      responses:
        '204':
          description: The Return Policy was successfully deleted.
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReturnPolicy403Example:
                  summary: Default deleteShopReturnPolicy 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReturnPolicy400Example:
                  summary: Default deleteShopReturnPolicy 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReturnPolicy401Example:
                  summary: Default deleteShopReturnPolicy 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReturnPolicy500Example:
                  summary: Default deleteShopReturnPolicy 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Shop Return Policy
    get:
      operationId: getShopReturnPolicy
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves an existing Return Policy."
      tags:
        - Shop Return Policy
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: return_policy_id
          in: path
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          required: true
          schema:
            type: integer
            description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single Return Policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReturnPolicy'
              examples:
                GetShopReturnPolicy200Example:
                  summary: Default getShopReturnPolicy 200 response
                  x-microcks-default: true
                  value:
                    return_policy_id: 1
                    shop_id: 123456
                    accepts_returns: true
                    accepts_exchanges: true
                    return_deadline: 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicy404Example:
                  summary: Default getShopReturnPolicy 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicy400Example:
                  summary: Default getShopReturnPolicy 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicy401Example:
                  summary: Default getShopReturnPolicy 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReturnPolicy500Example:
                  summary: Default getShopReturnPolicy 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Return Policy
    put:
      operationId: updateShopReturnPolicy
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates an existing Return Policy. Note: if either accepts_returns or accepts_exchanges is true, then a return_deadline is required."
      tags:
        - Shop Return Policy
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: return_policy_id
          in: path
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          required: true
          schema:
            type: integer
            description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - accepts_returns
                - accepts_exchanges
              properties:
                accepts_returns:
                  type: boolean
                accepts_exchanges:
                  type: boolean
                return_deadline:
                  type: integer
                  description: 'The deadline for the Return Policy, measured in days. The value must be one of the following: [7, 14, 21, 30, 45, 60, 90].'
                  nullable: true
            examples:
              UpdateShopReturnPolicyRequestExample:
                summary: Default updateShopReturnPolicy request
                x-microcks-default: true
                value:
                  accepts_returns: true
                  accepts_exchanges: true
                  return_deadline: 1
      responses:
        '200':
          description: An updated Return Policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReturnPolicy'
              examples:
                UpdateShopReturnPolicy200Example:
                  summary: Default updateShopReturnPolicy 200 response
                  x-microcks-default: true
                  value:
                    return_policy_id: 1
                    shop_id: 123456
                    accepts_returns: true
                    accepts_exchanges: true
                    return_deadline: 1
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReturnPolicy403Example:
                  summary: Default updateShopReturnPolicy 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReturnPolicy404Example:
                  summary: Default updateShopReturnPolicy 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReturnPolicy400Example:
                  summary: Default updateShopReturnPolicy 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReturnPolicy401Example:
                  summary: Default updateShopReturnPolicy 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReturnPolicy409Example:
                  summary: Default updateShopReturnPolicy 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReturnPolicy500Example:
                  summary: Default updateShopReturnPolicy 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Return Policy
  /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings:
    get:
      operationId: getListingsByShopReturnPolicy
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nGets all listings associated with a Return Policy."
      tags:
        - ShopListing
      parameters:
        - name: return_policy_id
          in: path
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          required: true
          schema:
            type: integer
            description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
            format: int64
            minimum: 1
          example: 1
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A set of ShopListing resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListings'
              examples:
                GetListingsByShopReturnPolicy200Example:
                  summary: Default getListingsByShopReturnPolicy 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReturnPolicy400Example:
                  summary: Default getListingsByShopReturnPolicy 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReturnPolicy403Example:
                  summary: Default getListingsByShopReturnPolicy 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReturnPolicy404Example:
                  summary: Default getListingsByShopReturnPolicy 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReturnPolicy401Example:
                  summary: Default getListingsByShopReturnPolicy 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopReturnPolicy500Example:
                  summary: Default getListingsByShopReturnPolicy 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - listings_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listings by Shop Return Policy
  /v3/application/shops/{shop_id}/production-partners:
    get:
      operationId: getShopProductionPartners
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of production partners available in the specific Etsy shop identified by its shop ID."
      tags:
        - Shop ProductionPartner
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: A list of shop production partners
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopProductionPartners'
              examples:
                GetShopProductionPartners200Example:
                  summary: Default getShopProductionPartners 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopProductionPartners403Example:
                  summary: Default getShopProductionPartners 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopProductionPartners400Example:
                  summary: Default getShopProductionPartners 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopProductionPartners500Example:
                  summary: Default getShopProductionPartners 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Production Partners
  /v3/application/shops/{shop_id}/readiness-state-definitions:
    post:
      operationId: createShopReadinessStateDefinition
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a new ReadinessStateDefinition. If an existing definition matches the input values, this endpoint will throw a Conflict error, please refer to the Content-Location header to obtain the get endpoint url for the values of the existing definition. Does not affect the product offering-readiness states definition relationship."
      tags:
        - Shop ProcessingProfiles
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - readiness_state
                - min_processing_time
                - max_processing_time
              properties:
                readiness_state:
                  type: string
                  description: 'The readiness state of a product: \"1\" means \"ready_to_ship\", and \"2\" means \"made_to_order\"'
                  enum:
                    - ready_to_ship
                    - made_to_order
                min_processing_time:
                  type: integer
                  description: The minimum number of days or weeks for processing a specific product.
                  minimum: 1
                  maximum: 10
                max_processing_time:
                  type: integer
                  description: The maximum number of days or weeks for processing a specific product.
                  minimum: 1
                  maximum: 10
                processing_time_unit:
                  type: string
                  description: The unit used to represent how long a processing time is. A week is equivalent to how many days the seller works per week as stated in their processing schedule. If none is provided, the unit is set to \"days\".
                  enum:
                    - days
                    - weeks
                  default: days
            examples:
              CreateShopReadinessStateDefinitionRequestExample:
                summary: Default createShopReadinessStateDefinition request
                x-microcks-default: true
                value:
                  readiness_state: ready_to_ship
                  min_processing_time: 1
                  max_processing_time: 1
                  processing_time_unit: days
      responses:
        '201':
          description: A single ReadinessStateDefinition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopProcessingProfile'
              examples:
                CreateShopReadinessStateDefinition201Example:
                  summary: Default createShopReadinessStateDefinition 201 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    readiness_state_id: 1
                    readiness_state: ready_to_ship
                    min_processing_days: 1
                    max_processing_days: 1
                    processing_days_display_label: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReadinessStateDefinition409Example:
                  summary: Default createShopReadinessStateDefinition 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReadinessStateDefinition400Example:
                  summary: Default createShopReadinessStateDefinition 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReadinessStateDefinition401Example:
                  summary: Default createShopReadinessStateDefinition 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopReadinessStateDefinition500Example:
                  summary: Default createShopReadinessStateDefinition 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Shop Readiness State Definition
    get:
      operationId: getShopReadinessStateDefinitions
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of ProcessingProfiles available in the specific Etsy shop identified by its shop ID."
      tags:
        - Shop ProcessingProfiles
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: A list of ProcessingProfiles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopProcessingProfiles'
              examples:
                GetShopReadinessStateDefinitions200Example:
                  summary: Default getShopReadinessStateDefinitions 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - shop_id: 123456
                        readiness_state_id: 1
                        readiness_state: ready_to_ship
                        min_processing_days: 1
                        max_processing_days: 1
                        processing_days_display_label: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinitions400Example:
                  summary: Default getShopReadinessStateDefinitions 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinitions404Example:
                  summary: Default getShopReadinessStateDefinitions 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinitions401Example:
                  summary: Default getShopReadinessStateDefinitions 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinitions500Example:
                  summary: Default getShopReadinessStateDefinitions 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Readiness State Definitions
  /v3/application/shops/{shop_id}/readiness-state-definitions/{readiness_state_definition_id}:
    delete:
      operationId: deleteShopReadinessStateDefinition
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a ReadinessStateDefinition by given readiness state definition ID. If there any active offerings linked to the definition, this endpoint will throw a Bad Request error. If you want to delete a ReadinessStateDefinition that is linked to active offerings, you must link the offerings to a different readiness state definition."
      tags:
        - Shop ProcessingProfiles
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: readiness_state_definition_id
          in: path
          description: 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.
          required: true
          schema:
            type: integer
            description: 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.
            format: int64
            minimum: 1
          example: 1
      responses:
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReadinessStateDefinition403Example:
                  summary: Default deleteShopReadinessStateDefinition 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReadinessStateDefinition404Example:
                  summary: Default deleteShopReadinessStateDefinition 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '204':
          description: The ReadinessStateDefinition was successfully deleted
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReadinessStateDefinition400Example:
                  summary: Default deleteShopReadinessStateDefinition 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReadinessStateDefinition401Example:
                  summary: Default deleteShopReadinessStateDefinition 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopReadinessStateDefinition500Example:
                  summary: Default deleteShopReadinessStateDefinition 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Shop Readiness State Definition
    get:
      operationId: getShopReadinessStateDefinition
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a ProcessingProfile referenced by readiness state definition ID."
      tags:
        - Shop ProcessingProfiles
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: readiness_state_definition_id
          in: path
          description: 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.
          required: true
          schema:
            type: integer
            description: 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.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single ProcessingProfile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopProcessingProfile'
              examples:
                GetShopReadinessStateDefinition200Example:
                  summary: Default getShopReadinessStateDefinition 200 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    readiness_state_id: 1
                    readiness_state: ready_to_ship
                    min_processing_days: 1
                    max_processing_days: 1
                    processing_days_display_label: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinition400Example:
                  summary: Default getShopReadinessStateDefinition 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinition404Example:
                  summary: Default getShopReadinessStateDefinition 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinition401Example:
                  summary: Default getShopReadinessStateDefinition 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReadinessStateDefinition500Example:
                  summary: Default getShopReadinessStateDefinition 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Readiness State Definition
    put:
      operationId: updateShopReadinessStateDefinition
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates an existing ReadinessStateDefinition. If an existing definition matches the input values, this endpoint will throw a Conflict error, please refer to the Content-Location header to obtain the get endpoint url for the values of the existing definition. Does not affect the product offering-readiness states definition relationship."
      tags:
        - Shop ProcessingProfiles
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: readiness_state_definition_id
          in: path
          description: 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.
          required: true
          schema:
            type: integer
            description: 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.
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                readiness_state:
                  type: string
                  description: 'The readiness state of a product: \"1\" means \"ready_to_ship\", and \"2\" means \"made_to_order\"'
                  enum:
                    - ready_to_ship
                    - made_to_order
                min_processing_time:
                  type: integer
                  description: The minimum number of days or weeks for processing a specific product.
                  minimum: 1
                  maximum: 10
                max_processing_time:
                  type: integer
                  description: The maximum number of days or weeks for processing a specific product.
                  minimum: 1
                  maximum: 10
                processing_time_unit:
                  type: string
                  description: The unit used to represent how long a processing time is. A week is equivalent to how many days the seller works per week as stated in their processing schedule. If none is provided, the unit is set to \"days\".
                  enum:
                    - days
                    - weeks
                  default: days
            examples:
              UpdateShopReadinessStateDefinitionRequestExample:
                summary: Default updateShopReadinessStateDefinition request
                x-microcks-default: true
                value:
                  readiness_state: ready_to_ship
                  min_processing_time: 1
                  max_processing_time: 1
                  processing_time_unit: days
      responses:
        '200':
          description: The updated ReadinessStateDefinition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopProcessingProfile'
              examples:
                UpdateShopReadinessStateDefinition200Example:
                  summary: Default updateShopReadinessStateDefinition 200 response
                  x-microcks-default: true
                  value:
                    shop_id: 123456
                    readiness_state_id: 1
                    readiness_state: ready_to_ship
                    min_processing_days: 1
                    max_processing_days: 1
                    processing_days_display_label: example string
        '409':
          description: There was a request conflict with the current state of the target resource. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReadinessStateDefinition409Example:
                  summary: Default updateShopReadinessStateDefinition 409 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReadinessStateDefinition400Example:
                  summary: Default updateShopReadinessStateDefinition 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReadinessStateDefinition404Example:
                  summary: Default updateShopReadinessStateDefinition 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReadinessStateDefinition401Example:
                  summary: Default updateShopReadinessStateDefinition 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopReadinessStateDefinition500Example:
                  summary: Default updateShopReadinessStateDefinition 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Readiness State Definition
  /v3/application/shops/{shop_id}/sections:
    post:
      operationId: createShopSection
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a new section in a specific shop."
      tags:
        - Shop Section
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - title
              properties:
                title:
                  type: string
                  description: The title string for a shop section.
            examples:
              CreateShopSectionRequestExample:
                summary: Default createShopSection request
                x-microcks-default: true
                value:
                  title: example string
      responses:
        '200':
          description: A Shop Section resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopSection'
              examples:
                CreateShopSection200Example:
                  summary: Default createShopSection 200 response
                  x-microcks-default: true
                  value:
                    shop_section_id: 1
                    title: Handmade Ceramic Mug — Stoneware
                    rank: 1
                    user_id: 456789
                    active_listing_count: 1
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopSection400Example:
                  summary: Default createShopSection 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '503':
          description: This function is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopSection503Example:
                  summary: Default createShopSection 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopSection403Example:
                  summary: Default createShopSection 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopSection401Example:
                  summary: Default createShopSection 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopSection500Example:
                  summary: Default createShopSection 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Shop Section
    get:
      operationId: getShopSections
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the list of shop sections in a specific shop identified by shop ID."
      tags:
        - Shop Section
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: A list of shop sections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopSections'
              examples:
                GetShopSections200Example:
                  summary: Default getShopSections 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopSections404Example:
                  summary: Default getShopSections 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopSections400Example:
                  summary: Default getShopSections 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopSections500Example:
                  summary: Default getShopSections 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Sections
  /v3/application/shops/{shop_id}/sections/{shop_section_id}:
    delete:
      operationId: deleteShopSection
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a section in a specific shop given a valid shop_section_id."
      tags:
        - Shop Section
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shop_section_id
          in: path
          description: The numeric ID of a section in a specific Etsy shop.
          required: true
          schema:
            type: integer
            description: The numeric ID of a section in a specific Etsy shop.
            format: int64
            minimum: 1
          example: 1
      responses:
        '204':
          description: The shop section resource was correctly deleted
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopSection400Example:
                  summary: Default deleteShopSection 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '503':
          description: This function is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopSection503Example:
                  summary: Default deleteShopSection 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopSection403Example:
                  summary: Default deleteShopSection 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopSection401Example:
                  summary: Default deleteShopSection 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopSection500Example:
                  summary: Default deleteShopSection 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Shop Section
    get:
      operationId: getShopSection
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a shop section, referenced by section ID and shop ID."
      tags:
        - Shop Section
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shop_section_id
          in: path
          description: The numeric ID of a section in a specific Etsy shop.
          required: true
          schema:
            type: integer
            description: The numeric ID of a section in a specific Etsy shop.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A shop section resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopSection'
              examples:
                GetShopSection200Example:
                  summary: Default getShopSection 200 response
                  x-microcks-default: true
                  value:
                    shop_section_id: 1
                    title: Handmade Ceramic Mug — Stoneware
                    rank: 1
                    user_id: 456789
                    active_listing_count: 1
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopSection404Example:
                  summary: Default getShopSection 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopSection400Example:
                  summary: Default getShopSection 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopSection500Example:
                  summary: Default getShopSection 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Section
    put:
      operationId: updateShopSection
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates a section in a specific shop given a valid shop_section_id."
      tags:
        - Shop Section
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shop_section_id
          in: path
          description: The numeric ID of a section in a specific Etsy shop.
          required: true
          schema:
            type: integer
            description: The numeric ID of a section in a specific Etsy shop.
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - title
              properties:
                title:
                  type: string
                  description: The title string for a shop section.
            examples:
              UpdateShopSectionRequestExample:
                summary: Default updateShopSection request
                x-microcks-default: true
                value:
                  title: example string
      responses:
        '200':
          description: A Shop Section resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopSection'
              examples:
                UpdateShopSection200Example:
                  summary: Default updateShopSection 200 response
                  x-microcks-default: true
                  value:
                    shop_section_id: 1
                    title: Handmade Ceramic Mug — Stoneware
                    rank: 1
                    user_id: 456789
                    active_listing_count: 1
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopSection400Example:
                  summary: Default updateShopSection 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '503':
          description: This function is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopSection503Example:
                  summary: Default updateShopSection 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopSection403Example:
                  summary: Default updateShopSection 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopSection401Example:
                  summary: Default updateShopSection 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopSection500Example:
                  summary: Default updateShopSection 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Section
  /v3/application/shops/{shop_id}/shop-sections/listings:
    get:
      operationId: getListingsByShopSectionId
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves all the listings from the section of a specific shop."
      tags:
        - ShopListing
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shop_section_ids
          in: query
          description: A list of numeric IDS for all sections in a specific Etsy shop.
          required: true
          schema:
            type: array
            description: A list of numeric IDS for all sections in a specific Etsy shop.
            items:
              type: integer
              format: int64
              minimum: 1
          example:
            - 1
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: sort_on
          in: query
          description: '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.'
          required: false
          schema:
            type: string
            description: '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.'
            enum:
              - created
              - price
              - updated
              - score
            default: created
          example: created
        - name: sort_order
          in: query
          description: '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.).'
          required: false
          schema:
            type: string
            description: '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.).'
            enum:
              - asc
              - ascending
              - desc
              - descending
              - up
              - down
            default: desc
          example: asc
        - name: legacy
          in: query
          description: This parameter is needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter is needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of listings from a shop section.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopListings'
              examples:
                GetListingsByShopSectionId200Example:
                  summary: Default getListingsByShopSectionId 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopSectionId400Example:
                  summary: Default getListingsByShopSectionId 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetListingsByShopSectionId500Example:
                  summary: Default getListingsByShopSectionId 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Listings by Shop Section Id
  /v3/application/shops/{shop_id}/shipping-profiles:
    post:
      operationId: createShopShippingProfile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a new ShippingProfile. You can pass a country iso code or a region when creating a ShippingProfile, but not both. Only one is required. You must pass either a shipping_carrier_id AND mail_class, or both min and max_delivery_days."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - title
                - origin_country_iso
                - primary_cost
                - secondary_cost
              properties:
                title:
                  type: string
                  description: The name string of this shipping profile.
                origin_country_iso:
                  type: string
                  description: The ISO code of the country from which the listing ships.
                  format: ISO 3166-1 alpha-2
                primary_cost:
                  type: number
                  description: The cost of shipping to this country/region alone, measured in the store's default currency.
                  format: float
                  minimum: 0
                secondary_cost:
                  type: number
                  description: The cost of shipping to this country/region with another item, measured in the store's default currency.
                  format: float
                  minimum: 0
                min_processing_time:
                  type: integer
                  description: The minimum time required to process to ship listings with this shipping profile.
                  minimum: 1
                  maximum: 10
                max_processing_time:
                  type: integer
                  description: The maximum processing time the listing needs to ship.
                  minimum: 1
                  maximum: 10
                processing_time_unit:
                  type: string
                  description: The unit used to represent how long a processing time is. A week is equivalent to the set processing schedule (default to 5 business days). If none is provided, the unit is set to "business_days".
                  enum:
                    - business_days
                    - weeks
                  default: business_days
                destination_country_iso:
                  type: string
                  description: The ISO code of the country to which the listing ships. If null, request sets destination to destination_region. Required if destination_region is null or not provided.
                  format: ISO 3166-1 alpha-2
                  default:
                destination_region:
                  type: string
                  description: The code of the region to which the listing ships. A region represents a set of countries. Supported regions are Europe Union and Non-Europe Union (countries in Europe not in EU). If `none`, request sets destination to destination_country_iso. Required if destination_country_iso is null or not provided.
                  enum:
                    - eu
                    - non_eu
                    - none
                  default: none
                origin_postal_code:
                  type: string
                  description: The postal code string (not necessarily a number) for the location from which the listing ships. Required if the `origin_country_iso` supports postal codes. See the [Fulfillment Tutorial docs](https://developer.etsy.com/documentation/tutorials/fulfillment/#countries-requiring-postal-codes) for more info
                  default: ''
                shipping_carrier_id:
                  type: integer
                  description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
                  minimum: 0
                  default: 0
                mail_class:
                  type: string
                  description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
                  default:
                min_delivery_days:
                  type: integer
                  description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
                max_delivery_days:
                  type: integer
                  description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
            examples:
              CreateShopShippingProfileRequestExample:
                summary: Default createShopShippingProfile request
                x-microcks-default: true
                value:
                  title: example string
                  origin_country_iso: example string
                  primary_cost: 1.0
                  secondary_cost: 1.0
                  min_processing_time: 1
                  max_processing_time: 1
                  processing_time_unit: business_days
                  destination_country_iso: example string
                  destination_region: eu
                  origin_postal_code: example string
                  shipping_carrier_id: 1
                  mail_class: example string
                  min_delivery_days: 1
                  max_delivery_days: 1
      responses:
        '200':
          description: A single ShippingProfile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfile'
              examples:
                CreateShopShippingProfile200Example:
                  summary: Default createShopShippingProfile 200 response
                  x-microcks-default: true
                  value:
                    shipping_profile_id: 1
                    title: Handmade Ceramic Mug — Stoneware
                    user_id: 456789
                    origin_country_iso: US
                    is_deleted: true
                    shipping_profile_destinations:
                      - 
                    shipping_profile_upgrades:
                      - 
                    origin_postal_code: '11201'
                    profile_type: manual
                    domestic_handling_fee: 1.0
                    international_handling_fee: 1.0
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfile403Example:
                  summary: Default createShopShippingProfile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfile400Example:
                  summary: Default createShopShippingProfile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfile401Example:
                  summary: Default createShopShippingProfile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfile500Example:
                  summary: Default createShopShippingProfile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Shop Shipping Profile
    get:
      operationId: getShopShippingProfiles
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of shipping profiles available in the specific Etsy shop identified by its shop ID."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
      responses:
        '200':
          description: A list of shipping profiles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfiles'
              examples:
                GetShopShippingProfiles200Example:
                  summary: Default getShopShippingProfiles 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - shipping_profile_id: 1
                        title: Handmade Ceramic Mug — Stoneware
                        user_id: 456789
                        origin_country_iso: US
                        is_deleted: true
                        shipping_profile_destinations:
                          - {}
                        shipping_profile_upgrades:
                          - {}
                        origin_postal_code: '11201'
                        profile_type: manual
                        domestic_handling_fee: 1.0
                        international_handling_fee: 1.0
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfiles403Example:
                  summary: Default getShopShippingProfiles 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfiles400Example:
                  summary: Default getShopShippingProfiles 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfiles500Example:
                  summary: Default getShopShippingProfiles 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Shipping Profiles
  /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}:
    delete:
      operationId: deleteShopShippingProfile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a ShippingProfile by given id."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
      responses:
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfile403Example:
                  summary: Default deleteShopShippingProfile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfile404Example:
                  summary: Default deleteShopShippingProfile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '204':
          description: The ShopShippingProfile resource was correctly deleted
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfile400Example:
                  summary: Default deleteShopShippingProfile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfile401Example:
                  summary: Default deleteShopShippingProfile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfile500Example:
                  summary: Default deleteShopShippingProfile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Shop Shipping Profile
    get:
      operationId: getShopShippingProfile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a Shipping Profile referenced by shipping profile ID."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single ShippingProfile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfile'
              examples:
                GetShopShippingProfile200Example:
                  summary: Default getShopShippingProfile 200 response
                  x-microcks-default: true
                  value:
                    shipping_profile_id: 1
                    title: Handmade Ceramic Mug — Stoneware
                    user_id: 456789
                    origin_country_iso: US
                    is_deleted: true
                    shipping_profile_destinations:
                      - 
                    shipping_profile_upgrades:
                      - 
                    origin_postal_code: '11201'
                    profile_type: manual
                    domestic_handling_fee: 1.0
                    international_handling_fee: 1.0
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfile403Example:
                  summary: Default getShopShippingProfile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfile404Example:
                  summary: Default getShopShippingProfile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfile400Example:
                  summary: Default getShopShippingProfile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfile401Example:
                  summary: Default getShopShippingProfile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfile500Example:
                  summary: Default getShopShippingProfile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Shipping Profile
    put:
      operationId: updateShopShippingProfile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nChanges the settings in a shipping profile. You can pass a country iso code or a region when updating a ShippingProfile, but not both. Only one is required. You must pass either a shipping_carrier_id AND mail_class, or both min and max_delivery_days."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The name string of this shipping profile.
                origin_country_iso:
                  type: string
                  description: The ISO code of the country from which the listing ships.
                  format: ISO 3166-1 alpha-2
                min_processing_time:
                  type: integer
                  description: The minimum time required to process to ship listings with this shipping profile.
                  minimum: 1
                  maximum: 10
                max_processing_time:
                  type: integer
                  description: The maximum processing time the listing needs to ship.
                  minimum: 1
                  maximum: 10
                processing_time_unit:
                  type: string
                  description: The unit used to represent how long a processing time is. A week is equivalent to the set processing schedule (default to 5 business days). If none is provided, the unit is set to "business_days".
                  enum:
                    - business_days
                    - weeks
                  default: business_days
                origin_postal_code:
                  type: string
                  description: The postal code string (not necessarily a number) for the location from which the listing ships. Required if the `origin_country_iso` supports postal codes. See the [Fulfillment Tutorial docs](https://developer.etsy.com/documentation/tutorials/fulfillment/#countries-requiring-postal-codes) for more info
                  default:
            examples:
              UpdateShopShippingProfileRequestExample:
                summary: Default updateShopShippingProfile request
                x-microcks-default: true
                value:
                  title: example string
                  origin_country_iso: example string
                  min_processing_time: 1
                  max_processing_time: 1
                  processing_time_unit: business_days
                  origin_postal_code: example string
      responses:
        '200':
          description: The updated shipping profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfile'
              examples:
                UpdateShopShippingProfile200Example:
                  summary: Default updateShopShippingProfile 200 response
                  x-microcks-default: true
                  value:
                    shipping_profile_id: 1
                    title: Handmade Ceramic Mug — Stoneware
                    user_id: 456789
                    origin_country_iso: US
                    is_deleted: true
                    shipping_profile_destinations:
                      - 
                    shipping_profile_upgrades:
                      - 
                    origin_postal_code: '11201'
                    profile_type: manual
                    domestic_handling_fee: 1.0
                    international_handling_fee: 1.0
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfile404Example:
                  summary: Default updateShopShippingProfile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfile403Example:
                  summary: Default updateShopShippingProfile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfile400Example:
                  summary: Default updateShopShippingProfile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfile401Example:
                  summary: Default updateShopShippingProfile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '503':
          description: This function is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfile503Example:
                  summary: Default updateShopShippingProfile 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfile500Example:
                  summary: Default updateShopShippingProfile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Shipping Profile
  /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations:
    post:
      operationId: createShopShippingProfileDestination
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a new shipping destination, which sets the shipping cost, carrier, and class for a destination in a [shipping profile](/documentation/reference/#tag/Shop-ShippingProfile). createShopShippingProfileDestination assigns costs using the currency of the associated shop. Set the destination using either `destination_country_iso` or `destination_region`; `destination_country_iso` and `destination_region` are mutually exclusive — set one or the other. Setting both triggers error 400. If the request sets neither `destination_country_iso` nor `destination_region`, the default destination is \"everywhere\". You must also either assign both a `shipping_carrier_id` AND `mail_class` or both `min_delivery_days` AND `max_delivery_days`."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - primary_cost
                - secondary_cost
              properties:
                primary_cost:
                  type: number
                  description: The cost of shipping to this country/region alone, measured in the store's default currency.
                  format: float
                  minimum: 0
                secondary_cost:
                  type: number
                  description: The cost of shipping to this country/region with another item, measured in the store's default currency.
                  format: float
                  minimum: 0
                destination_country_iso:
                  type: string
                  description: The ISO code of the country to which the listing ships. If null, request sets destination to destination_region. Required if destination_region is null or not provided.
                  format: ISO 3166-1 alpha-2
                  default:
                destination_region:
                  type: string
                  description: The code of the region to which the listing ships. A region represents a set of countries. Supported regions are Europe Union and Non-Europe Union (countries in Europe not in EU). If `none`, request sets destination to destination_country_iso. Required if destination_country_iso is null or not provided.
                  enum:
                    - eu
                    - non_eu
                    - none
                  default: none
                shipping_carrier_id:
                  type: integer
                  description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
                  minimum: 0
                  default: 0
                mail_class:
                  type: string
                  description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
                  default:
                min_delivery_days:
                  type: integer
                  description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
                max_delivery_days:
                  type: integer
                  description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
            examples:
              CreateShopShippingProfileDestinationRequestExample:
                summary: Default createShopShippingProfileDestination request
                x-microcks-default: true
                value:
                  primary_cost: 1.0
                  secondary_cost: 1.0
                  destination_country_iso: example string
                  destination_region: eu
                  shipping_carrier_id: 1
                  mail_class: example string
                  min_delivery_days: 1
                  max_delivery_days: 1
      responses:
        '201':
          description: A single shipping destination.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfileDestination'
              examples:
                CreateShopShippingProfileDestination201Example:
                  summary: Default createShopShippingProfileDestination 201 response
                  x-microcks-default: true
                  value:
                    shipping_profile_destination_id: 1
                    shipping_profile_id: 1
                    origin_country_iso: US
                    destination_country_iso: US
                    destination_region: eu
                    primary_cost: example
                    secondary_cost: example
                    shipping_carrier_id: 1
                    mail_class: example string
                    min_delivery_days: 1
                    max_delivery_days: 1
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileDestination400Example:
                  summary: Default createShopShippingProfileDestination 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileDestination403Example:
                  summary: Default createShopShippingProfileDestination 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileDestination401Example:
                  summary: Default createShopShippingProfileDestination 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileDestination500Example:
                  summary: Default createShopShippingProfileDestination 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Shop Shipping Profile Destination
    get:
      operationId: getShopShippingProfileDestinationsByShippingProfile
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of shipping destination objects associated with a shipping profile."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: A list of shipping destination objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfileDestinations'
              examples:
                GetShopShippingProfileDestinationsByShippingProfile200Example:
                  summary: Default getShopShippingProfileDestinationsByShippingProfile 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileDestinationsByShippingProfile403Example:
                  summary: Default getShopShippingProfileDestinationsByShippingProfile 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileDestinationsByShippingProfile400Example:
                  summary: Default getShopShippingProfileDestinationsByShippingProfile 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileDestinationsByShippingProfile404Example:
                  summary: Default getShopShippingProfileDestinationsByShippingProfile 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileDestinationsByShippingProfile401Example:
                  summary: Default getShopShippingProfileDestinationsByShippingProfile 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileDestinationsByShippingProfile500Example:
                  summary: Default getShopShippingProfileDestinationsByShippingProfile 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Shipping Profile Destinations by Shipping Profile
  /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}:
    delete:
      operationId: deleteShopShippingProfileDestination
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a shipping destination and removes the destination option from every listing that uses the associated shipping profile. A shipping profile requires at least one shipping destination, so this endpoint cannot delete the final shipping destination for any shipping profile. To delete the final shipping destination from a shipping profile, you must [delete the entire shipping profile](/documentation/reference/#operation/deleteShopShippingProfile)."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
        - name: shipping_profile_destination_id
          in: path
          description: The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.
          required: true
          schema:
            type: integer
            description: The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.
            format: int64
            minimum: 1
          example: 1
      responses:
        '204':
          description: Etsy deleted the shipping profile destination.
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileDestination403Example:
                  summary: Default deleteShopShippingProfileDestination 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileDestination404Example:
                  summary: Default deleteShopShippingProfileDestination 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileDestination400Example:
                  summary: Default deleteShopShippingProfileDestination 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileDestination401Example:
                  summary: Default deleteShopShippingProfileDestination 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileDestination500Example:
                  summary: Default deleteShopShippingProfileDestination 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Shop Shipping Profile Destination
    put:
      operationId: updateShopShippingProfileDestination
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates an existing shipping destination, which can set or reassign the shipping cost, carrier, and class for a destination."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
        - name: shipping_profile_destination_id
          in: path
          description: The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.
          required: true
          schema:
            type: integer
            description: The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                primary_cost:
                  type: number
                  description: The cost of shipping to this country/region alone, measured in the store's default currency.
                  format: float
                  minimum: 0
                  default:
                secondary_cost:
                  type: number
                  description: The cost of shipping to this country/region with another item, measured in the store's default currency.
                  format: float
                  minimum: 0
                  default:
                destination_country_iso:
                  type: string
                  description: The ISO code of the country to which the listing ships. If null, request sets destination to destination_region. Required if destination_region is null or not provided.
                  format: ISO 3166-1 alpha-2
                  default:
                destination_region:
                  type: string
                  description: The code of the region to which the listing ships. A region represents a set of countries. Supported regions are Europe Union and Non-Europe Union (countries in Europe not in EU). If `none`, request sets destination to destination_country_iso. Required if destination_country_iso is null or not provided.
                  enum:
                    - eu
                    - non_eu
                    - none
                  default: none
                shipping_carrier_id:
                  type: integer
                  description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
                  minimum: 0
                  default:
                mail_class:
                  type: string
                  description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
                  default:
                min_delivery_days:
                  type: integer
                  description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
                max_delivery_days:
                  type: integer
                  description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
            examples:
              UpdateShopShippingProfileDestinationRequestExample:
                summary: Default updateShopShippingProfileDestination request
                x-microcks-default: true
                value:
                  primary_cost: 1.0
                  secondary_cost: 1.0
                  destination_country_iso: example string
                  destination_region: eu
                  shipping_carrier_id: 1
                  mail_class: example string
                  min_delivery_days: 1
                  max_delivery_days: 1
      responses:
        '200':
          description: A single shipping destination.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfileDestination'
              examples:
                UpdateShopShippingProfileDestination200Example:
                  summary: Default updateShopShippingProfileDestination 200 response
                  x-microcks-default: true
                  value:
                    shipping_profile_destination_id: 1
                    shipping_profile_id: 1
                    origin_country_iso: US
                    destination_country_iso: US
                    destination_region: eu
                    primary_cost: example
                    secondary_cost: example
                    shipping_carrier_id: 1
                    mail_class: example string
                    min_delivery_days: 1
                    max_delivery_days: 1
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileDestination400Example:
                  summary: Default updateShopShippingProfileDestination 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileDestination403Example:
                  summary: Default updateShopShippingProfileDestination 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileDestination404Example:
                  summary: Default updateShopShippingProfileDestination 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileDestination401Example:
                  summary: Default updateShopShippingProfileDestination 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '503':
          description: This function is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileDestination503Example:
                  summary: Default updateShopShippingProfileDestination 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileDestination500Example:
                  summary: Default updateShopShippingProfileDestination 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Shipping Profile Destination
  /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades:
    post:
      operationId: createShopShippingProfileUpgrade
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a new shipping profile upgrade, which can establish a price for a shipping option, such as an alternate carrier or faster delivery."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - type
                - upgrade_name
                - price
                - secondary_price
              properties:
                type:
                  type: integer
                  description: The type of the shipping upgrade. Domestic (0) or international (1).
                  enum:
                    - 0
                    - 1
                upgrade_name:
                  type: string
                  description: Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.
                price:
                  type: number
                  description: Additional cost of adding the shipping upgrade.
                  format: float
                  minimum: 0
                secondary_price:
                  type: number
                  description: Additional cost of adding the shipping upgrade for each additional item.
                  format: float
                  minimum: 0
                shipping_carrier_id:
                  type: integer
                  description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
                  minimum: 0
                  default: 0
                mail_class:
                  type: string
                  description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
                  default:
                min_delivery_days:
                  type: integer
                  description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
                max_delivery_days:
                  type: integer
                  description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
            examples:
              CreateShopShippingProfileUpgradeRequestExample:
                summary: Default createShopShippingProfileUpgrade request
                x-microcks-default: true
                value:
                  type: 0
                  upgrade_name: example string
                  price: 1.0
                  secondary_price: 1.0
                  shipping_carrier_id: 1
                  mail_class: example string
                  min_delivery_days: 1
                  max_delivery_days: 1
      responses:
        '200':
          description: A single shipping profile upgrade.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfileUpgrade'
              examples:
                CreateShopShippingProfileUpgrade200Example:
                  summary: Default createShopShippingProfileUpgrade 200 response
                  x-microcks-default: true
                  value:
                    shipping_profile_id: 1
                    upgrade_id: 1
                    upgrade_name: Handmade Ceramic Mug
                    type: 0
                    rank: 1
                    language: en-US
                    price: example
                    secondary_price: example
                    shipping_carrier_id: 1
                    mail_class: example string
                    min_delivery_days: 1
                    max_delivery_days: 1
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileUpgrade400Example:
                  summary: Default createShopShippingProfileUpgrade 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileUpgrade403Example:
                  summary: Default createShopShippingProfileUpgrade 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileUpgrade404Example:
                  summary: Default createShopShippingProfileUpgrade 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileUpgrade401Example:
                  summary: Default createShopShippingProfileUpgrade 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                CreateShopShippingProfileUpgrade500Example:
                  summary: Default createShopShippingProfileUpgrade 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Create Shop Shipping Profile Upgrade
    get:
      operationId: getShopShippingProfileUpgrades
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the list of shipping profile upgrades assigned to a specific shipping profile."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A list of shipping profile upgrades.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfileUpgrades'
              examples:
                GetShopShippingProfileUpgrades200Example:
                  summary: Default getShopShippingProfileUpgrades 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileUpgrades400Example:
                  summary: Default getShopShippingProfileUpgrades 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileUpgrades403Example:
                  summary: Default getShopShippingProfileUpgrades 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileUpgrades404Example:
                  summary: Default getShopShippingProfileUpgrades 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileUpgrades401Example:
                  summary: Default getShopShippingProfileUpgrades 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopShippingProfileUpgrades500Example:
                  summary: Default getShopShippingProfileUpgrades 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Shipping Profile Upgrades
  /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}:
    delete:
      operationId: deleteShopShippingProfileUpgrade
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a shipping profile upgrade and removes the upgrade option from every listing that uses the associated shipping profile."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the shipping profile.
          required: true
          schema:
            type: integer
            description: The numeric ID of the shipping profile.
            format: int64
            minimum: 1
          example: 1
        - name: upgrade_id
          in: path
          description: The numeric ID that is associated with a shipping upgrade
          required: true
          schema:
            type: integer
            description: The numeric ID that is associated with a shipping upgrade
            format: int64
            minimum: 1
          example: 1
      responses:
        '204':
          description: Etsy deleted the shipping profile upgrade.
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileUpgrade403Example:
                  summary: Default deleteShopShippingProfileUpgrade 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileUpgrade404Example:
                  summary: Default deleteShopShippingProfileUpgrade 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileUpgrade400Example:
                  summary: Default deleteShopShippingProfileUpgrade 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileUpgrade401Example:
                  summary: Default deleteShopShippingProfileUpgrade 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteShopShippingProfileUpgrade500Example:
                  summary: Default deleteShopShippingProfileUpgrade 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete Shop Shipping Profile Upgrade
    put:
      operationId: updateShopShippingProfileUpgrade
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nUpdates a shipping profile upgrade and updates any listings that use the shipping profile."
      tags:
        - Shop ShippingProfile
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: shipping_profile_id
          in: path
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          required: true
          schema:
            type: integer
            description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
            format: int64
            minimum: 1
          example: 1
        - name: upgrade_id
          in: path
          description: The numeric ID that is associated with a shipping upgrade
          required: true
          schema:
            type: integer
            description: The numeric ID that is associated with a shipping upgrade
            format: int64
            minimum: 1
          example: 1
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                upgrade_name:
                  type: string
                  description: Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.
                  default:
                type:
                  type: integer
                  description: The type of the shipping upgrade. Domestic (0) or international (1).
                  enum:
                    - 0
                    - 1
                price:
                  type: number
                  description: Additional cost of adding the shipping upgrade.
                  format: float
                  minimum: 0
                  default:
                secondary_price:
                  type: number
                  description: Additional cost of adding the shipping upgrade for each additional item.
                  format: float
                  minimum: 0
                  default:
                shipping_carrier_id:
                  type: integer
                  description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
                  minimum: 0
                  default:
                mail_class:
                  type: string
                  description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
                  default:
                min_delivery_days:
                  type: integer
                  description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
                max_delivery_days:
                  type: integer
                  description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
                  minimum: 1
                  maximum: 45
                  default:
            examples:
              UpdateShopShippingProfileUpgradeRequestExample:
                summary: Default updateShopShippingProfileUpgrade request
                x-microcks-default: true
                value:
                  upgrade_name: example string
                  type: 0
                  price: 1.0
                  secondary_price: 1.0
                  shipping_carrier_id: 1
                  mail_class: example string
                  min_delivery_days: 1
                  max_delivery_days: 1
      responses:
        '200':
          description: A single shipping profile upgrade.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopShippingProfileUpgrade'
              examples:
                UpdateShopShippingProfileUpgrade200Example:
                  summary: Default updateShopShippingProfileUpgrade 200 response
                  x-microcks-default: true
                  value:
                    shipping_profile_id: 1
                    upgrade_id: 1
                    upgrade_name: Handmade Ceramic Mug
                    type: 0
                    rank: 1
                    language: en-US
                    price: example
                    secondary_price: example
                    shipping_carrier_id: 1
                    mail_class: example string
                    min_delivery_days: 1
                    max_delivery_days: 1
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileUpgrade400Example:
                  summary: Default updateShopShippingProfileUpgrade 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileUpgrade403Example:
                  summary: Default updateShopShippingProfileUpgrade 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileUpgrade404Example:
                  summary: Default updateShopShippingProfileUpgrade 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileUpgrade401Example:
                  summary: Default updateShopShippingProfileUpgrade 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '503':
          description: This function is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileUpgrade503Example:
                  summary: Default updateShopShippingProfileUpgrade 503 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                UpdateShopShippingProfileUpgrade500Example:
                  summary: Default updateShopShippingProfileUpgrade 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_w
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Update Shop Shipping Profile Upgrade
  /v3/application/scopes:
    post:
      operationId: tokenScopes
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCheck the scopes of the provided token"
      tags:
        - Other
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - token
              properties:
                token:
                  type: string
            examples:
              TokenScopesRequestExample:
                summary: Default tokenScopes request
                x-microcks-default: true
                value:
                  token: example string
      responses:
        '200':
          description: A confirmation that the current application has access to the Open API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scopes'
              examples:
                TokenScopes200Example:
                  summary: Default tokenScopes 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                TokenScopes401Example:
                  summary: Default tokenScopes 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                TokenScopes500Example:
                  summary: Default tokenScopes 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Token Scopes
  /v3/application/shops/{shop_id}/transactions/{transaction_id}:
    get:
      operationId: getShopReceiptTransaction
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a transaction by transaction ID."
      tags:
        - Shop Receipt Transactions
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: transaction_id
          in: path
          description: The unique numeric ID for a transaction.
          required: true
          schema:
            type: integer
            description: The unique numeric ID for a transaction.
            format: int64
            minimum: 1
          example: 345678901
      responses:
        '200':
          description: A single transaction
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceiptTransaction'
              examples:
                GetShopReceiptTransaction200Example:
                  summary: Default getShopReceiptTransaction 200 response
                  x-microcks-default: true
                  value:
                    transaction_id: 345678901
                    title: Handmade Ceramic Mug — Stoneware
                    description: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
                    seller_user_id: 456789
                    buyer_user_id: 456789
                    create_timestamp: 1758153645
                    created_timestamp: 1758153645
                    paid_timestamp: 1758153645
                    shipped_timestamp: 1758153645
                    quantity: 1
                    listing_image_id: 1
                    receipt_id: 234567890
                    is_digital: true
                    file_data: example string
                    listing_id: 123456789
                    transaction_type: example string
                    product_id: 567890123
                    sku: SKU-12345
                    price: example
                    shipping_cost: example
                    variations:
                      - 
                    product_data:
                      - 
                    shipping_profile_id: 1
                    min_processing_days: 1
                    max_processing_days: 1
                    shipping_method: example string
                    shipping_upgrade: example string
                    expected_ship_date: 1
                    buyer_coupon: 1.0
                    shop_coupon: 1.0
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransaction404Example:
                  summary: Default getShopReceiptTransaction 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransaction403Example:
                  summary: Default getShopReceiptTransaction 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransaction400Example:
                  summary: Default getShopReceiptTransaction 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransaction401Example:
                  summary: Default getShopReceiptTransaction 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransaction500Example:
                  summary: Default getShopReceiptTransaction 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Receipt Transaction
  /v3/application/shops/{shop_id}/transactions:
    get:
      operationId: getShopReceiptTransactionsByShop
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the list of transactions associated with a shop."
      tags:
        - Shop Receipt Transactions
      parameters:
        - name: shop_id
          in: path
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          required: true
          schema:
            type: integer
            description: The unique positive non-zero numeric ID for an Etsy Shop.
            format: int64
            minimum: 1
          example: 123456
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
        - name: legacy
          in: query
          description: This parameter needed to enable new parameters and response values related to processing profiles.
          required: false
          schema:
            type: boolean
            description: This parameter needed to enable new parameters and response values related to processing profiles.
          example: true
      responses:
        '200':
          description: A list of transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopReceiptTransactions'
              examples:
                GetShopReceiptTransactionsByShop200Example:
                  summary: Default getShopReceiptTransactionsByShop 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '403':
          description: The request attempted to perform an operation it is not allowed to. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByShop403Example:
                  summary: Default getShopReceiptTransactionsByShop 403 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByShop404Example:
                  summary: Default getShopReceiptTransactionsByShop 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByShop401Example:
                  summary: Default getShopReceiptTransactionsByShop 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetShopReceiptTransactionsByShop500Example:
                  summary: Default getShopReceiptTransactionsByShop 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - transactions_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Shop Receipt Transactions by Shop
  /v3/application/user/addresses/{user_address_id}:
    delete:
      operationId: deleteUserAddress
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to delete a UserAddress for a User."
      tags:
        - UserAddress
      parameters:
        - name: user_address_id
          in: path
          description: The numeric ID of the user's address.
          required: true
          schema:
            type: integer
            description: The numeric ID of the user's address.
            format: int64
            minimum: 1
          example: 1
      responses:
        '204':
          description: The User Address resource was correctly deleted
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteUserAddress400Example:
                  summary: Default deleteUserAddress 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteUserAddress401Example:
                  summary: Default deleteUserAddress 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                DeleteUserAddress500Example:
                  summary: Default deleteUserAddress 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - address_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Delete User Address
    get:
      operationId: getUserAddress
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to retrieve a UserAddress for a User."
      tags:
        - UserAddress
      parameters:
        - name: user_address_id
          in: path
          description: The numeric ID of the user's address.
          required: true
          schema:
            type: integer
            description: The numeric ID of the user's address.
            format: int64
            minimum: 1
          example: 1
      responses:
        '200':
          description: A single UserAddress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAddress'
              examples:
                GetUserAddress200Example:
                  summary: Default getUserAddress 200 response
                  x-microcks-default: true
                  value:
                    user_address_id: 1
                    user_id: 456789
                    name: Handmade Ceramic Mug
                    first_line: 123 Main St
                    second_line: Apt 4B
                    city: Brooklyn
                    state: example string
                    zip: '11201'
                    iso_country_code: US
                    country_name: US
                    is_default_shipping_address: true
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddress400Example:
                  summary: Default getUserAddress 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddress401Example:
                  summary: Default getUserAddress 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddress404Example:
                  summary: Default getUserAddress 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddress500Example:
                  summary: Default getUserAddress 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - address_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get User Address
  /v3/application/user/addresses:
    get:
      operationId: getUserAddresses
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to retrieve UserAddresses for a User."
      tags:
        - UserAddress
      parameters:
        - name: limit
          in: query
          description: The maximum number of results to return.
          required: false
          schema:
            type: integer
            description: The maximum number of results to return.
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: offset
          in: query
          description: The number of records to skip before selecting the first result.
          required: false
          schema:
            type: integer
            description: The number of records to skip before selecting the first result.
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: A list of UserAddress records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAddresses'
              examples:
                GetUserAddresses200Example:
                  summary: Default getUserAddresses 200 response
                  x-microcks-default: true
                  value:
                    count: 1
                    results:
                      - 
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddresses401Example:
                  summary: Default getUserAddresses 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddresses404Example:
                  summary: Default getUserAddresses 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUserAddresses500Example:
                  summary: Default getUserAddresses 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - address_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get User Addresses
  /v3/application/users/{user_id}:
    get:
      operationId: getUser
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a user profile based on a unique user ID.                 Access is limited to profiles of the authenticated user                 or linked buyers. For the primary_email field, specific                 app-based permissions are required and granted case-by-case."
      tags:
        - User
      parameters:
        - name: user_id
          in: path
          description: ''
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
          example: 456789
      responses:
        '200':
          description: A single User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                GetUser200Example:
                  summary: Default getUser 200 response
                  x-microcks-default: true
                  value:
                    user_id: 456789
                    primary_email: seller@example.com
                    first_name: Handmade Ceramic Mug
                    last_name: Handmade Ceramic Mug
                    image_url_75x75: https://www.etsy.com/listing/123456789
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUser404Example:
                  summary: Default getUser 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUser400Example:
                  summary: Default getUser 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUser401Example:
                  summary: Default getUser 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetUser500Example:
                  summary: Default getUser 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - email_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get User
  /v3/application/users/me:
    get:
      operationId: getMe
      description: "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nReturns basic info for the user making the request."
      tags:
        - User
      parameters: []
      responses:
        '200':
          description: Fetches basic info about the requesting user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Self'
              examples:
                GetMe200Example:
                  summary: Default getMe 200 response
                  x-microcks-default: true
                  value:
                    user_id: 456789
                    shop_id: 123456
        '404':
          description: A resource could not be found. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetMe404Example:
                  summary: Default getMe 404 response
                  x-microcks-default: true
                  value:
                    error: example string
        '400':
          description: There was a problem with the request data. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetMe400Example:
                  summary: Default getMe 400 response
                  x-microcks-default: true
                  value:
                    error: example string
        '401':
          description: The request lacks valid authentication credentials. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetMe401Example:
                  summary: Default getMe 401 response
                  x-microcks-default: true
                  value:
                    error: example string
        '500':
          description: The server encountered an internal error. See the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
              examples:
                GetMe500Example:
                  summary: Default getMe 500 response
                  x-microcks-default: true
                  value:
                    error: example string
      security:
        - api_key: []
          oauth2:
            - shops_r
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Etsy Get Me
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
      description: Every request to a v3 API endpoint must include this data in the format `keystring:shared_secret`. Your keystring and shared secret are available on the [Your Apps](https://www.etsy.com/developers/your-apps) page.
    oauth2:
      type: oauth2
      description: Open API v3 supports authenticating via OAuth 2.0. More information about Etsy's specific implementation of OAuth2 can be found [here](/documentation/essentials/oauth2).
      flows:
        authorizationCode:
          authorizationUrl: https://www.etsy.com/oauth/connect
          tokenUrl: https://openapi.etsy.com/v3/public/oauth/token
          scopes:
            address_r: see billing and shipping addresses
            address_w: update billing and shipping addresses
            billing_r: see all billing statement data
            cart_r: read shopping carts
            cart_w: add/remove from shopping carts
            email_r: read a user profile
            favorites_r: see private favorites
            favorites_w: add/remove favorites
            feedback_r: see purchase info in feedback
            listings_d: delete listings
            listings_r: see all listings (including expired etc)
            listings_w: create/edit listings
            profile_r: see all profile data
            profile_w: update user profile, avatar, etc
            recommend_r: see recommended listings
            recommend_w: accept/reject recommended listings
            shops_r: see private shop info
            shops_w: update shop
            transactions_r: see all checkout/payment data
            transactions_w: update receipts
  schemas:
    TypeDiscriminator:
      type: object
      required:
        - __type
      properties:
        __type:
          type: string
          description: field used to determine the type of the object when deserializing union type responses
          example: example string
    BuyerTaxonomyNodes:
      type: object
      x-resource-id: BuyerTaxonomyNodes
      description: A list of taxonomy nodes from the buyer taxonomy tree.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/BuyerTaxonomyNode'
    BuyerTaxonomyNode:
      type: object
      x-resource-id: BuyerTaxonomyNode
      description: A taxonomy node in the buyer taxonomy tree.
      properties:
        id:
          type: integer
          description: "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\"."
          format: int64
          minimum: 1
          example: 1
        level:
          type: integer
          description: The integer depth of this taxonomy node in the seller taxonomy tree, with roots at level 0.
          minimum: 0
          example: 1
        name:
          type: string
          description: The name string for this taxonomy node.
          example: Handmade Ceramic Mug
        parent_id:
          type: integer
          description: The numeric taxonomy ID of the parent of this node.
          format: int64
          nullable: true
          minimum: 1
          default:
          example: 1
        children:
          type: array
          description: An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxonomy tree.
          items:
            description: An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxonomy tree.
            oneOf:
              - $ref: '#/components/schemas/BuyerTaxonomyNode'
        full_path_taxonomy_ids:
          type: array
          description: An array of `taxonomy_id`s including this node and all of its direct parents in the seller taxonomy tree up to a root node. They are listed in order from root to leaf.
          items:
            type: integer
            format: int64
            minimum: 1
    ErrorSchema:
      type: object
      x-resource-id: ErrorSchema
      required:
        - error
      properties:
        error:
          type: string
          example: example string
    BuyerTaxonomyNodeProperties:
      type: object
      x-resource-id: BuyerTaxonomyNodeProperties
      description: A list of product property definitions.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/BuyerTaxonomyNodeProperty'
    BuyerTaxonomyNodeProperty:
      type: object
      x-resource-id: BuyerTaxonomyNodeProperty
      description: A product property definition.
      properties:
        property_id:
          type: integer
          description: The unique numeric ID of this product property.
          format: int64
          minimum: 1
          example: 1
        name:
          type: string
          description: The name string for this taxonomy node.
          example: Handmade Ceramic Mug
        display_name:
          type: string
          description: The human-readable product property name string.
          example: Handmade Ceramic Mug
        scales:
          type: array
          description: A list of available scales.
          items:
            description: A list of available scales.
            oneOf:
              - $ref: '#/components/schemas/BuyerTaxonomyPropertyScale'
        is_required:
          type: boolean
          description: When true, listings assigned eligible taxonomy IDs require this property.
          example: true
        supports_attributes:
          type: boolean
          description: When true, you can use this property in listing properties.
          example: true
        supports_variations:
          type: boolean
          description: When true, you can use this property in listing inventory.
          example: true
        is_multivalued:
          type: boolean
          description: When true, you can assign multiple property values to this property
          example: true
        max_values_allowed:
          type: integer
          description: When true, you can assign multiple property values to this property
          nullable: true
          example: 1
        possible_values:
          type: array
          description: A list of supported property value strings for this property.
          items:
            description: A list of supported property value strings for this property.
            oneOf:
              - $ref: '#/components/schemas/BuyerTaxonomyPropertyValue'
        selected_values:
          type: array
          description: A list of property value strings automatically and always selected for the given property.
          items:
            description: A list of property value strings automatically and always selected for the given property.
            oneOf:
              - $ref: '#/components/schemas/BuyerTaxonomyPropertyValue'
    BuyerTaxonomyPropertyScale:
      type: object
      x-resource-id: BuyerTaxonomyPropertyScale
      description: A scale defining the assignable increments for the property values available to specific product properties.
      properties:
        scale_id:
          type: integer
          description: The unique numeric ID of a scale.
          format: int64
          minimum: 1
          example: 1
        display_name:
          type: string
          description: The name string for a scale.
          example: Handmade Ceramic Mug
        description:
          type: string
          description: The description string for a scale.
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
    BuyerTaxonomyPropertyValue:
      type: object
      x-resource-id: BuyerTaxonomyPropertyValue
      description: A property value for a specific product property, which may also employ a specific scale.
      properties:
        value_id:
          type: integer
          description: The numeric ID of this property value.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        name:
          type: string
          description: The name string of this property value.
          example: Handmade Ceramic Mug
        scale_id:
          type: integer
          description: The numeric scale ID of the scale to which this property value belongs.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        equal_to:
          type: array
          description: A list of numeric property value IDs this property value is equal to (if any).
          items:
            type: integer
            minimum: 0
    ShopListing:
      type: object
      x-resource-id: ShopListing
      description: A listing from a shop, which contains a product quantity, title, description, price, etc.
      properties:
        listing_id:
          type: integer
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          format: int64
          minimum: 1
          example: 123456789
        user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) posting the listing.
          format: int64
          minimum: 1
          example: 456789
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        title:
          type: string
          description: "The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each."
          example: Handmade Ceramic Mug — Stoneware
        description:
          type: string
          description: A description string of the product for sale in the listing.
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
        state:
          type: string
          description: '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.'
          enum:
            - active
            - inactive
            - sold_out
            - draft
            - expired
          example: active
        creation_timestamp:
          type: integer
          description: The listing's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The listing's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        ending_timestamp:
          type: integer
          description: The listing's expiration time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        original_creation_timestamp:
          type: integer
          description: The listing's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        last_modified_timestamp:
          type: integer
          description: The time of the last update to the listing, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The time of the last update to the listing, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        state_timestamp:
          type: integer
          description: The date and time of the last state change of this listing.
          nullable: true
          minimum: 946684800
          example: 1758153645
        quantity:
          type: integer
          description: 'The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the [getListingInventory](/documentation/reference#operation/getListingInventory) endpoint.'
          minimum: 0
          example: 1
        shop_section_id:
          type: integer
          description: The numeric ID of a section in a specific Etsy shop.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        featured_rank:
          type: integer
          description: The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page.
          example: 1
        url:
          type: string
          description: The full URL to the listing's page on Etsy.
          example: https://www.etsy.com/listing/123456789
        num_favorers:
          type: integer
          description: The number of users who marked this Listing a favorite.
          minimum: 0
          example: 1
        non_taxable:
          type: boolean
          description: When true, applicable [shop](/documentation/reference#tag/Shop) tax rates do not apply to this listing at checkout.
          example: true
        is_taxable:
          type: boolean
          description: When true, applicable [shop](/documentation/reference#tag/Shop) tax rates apply to this listing at checkout.
          example: true
        is_customizable:
          type: boolean
          description: When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.
          example: true
        is_personalizable:
          type: boolean
          description: When true, this listing is personalizable. The default value is false.
          example: true
        listing_type:
          type: string
          description: An enumerated type string that indicates whether the listing is physical or a digital download.
          enum:
            - physical
            - download
            - both
          example: physical
        tags:
          type: array
          description: "A comma-separated list of tag strings for the listing. When creating or updating a listing, valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}\\-'™©®]/u) Default value is null."
          items:
            type: string
        materials:
          type: array
          description: 'A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.'
          items:
            type: string
        shipping_profile_id:
          type: integer
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        return_policy_id:
          type: integer
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          format: int64
          nullable: true
          minimum: 1
          example: 1
        processing_min:
          type: integer
          description: The minimum number of days required to process this listing. Default value is null.
          nullable: true
          minimum: 0
          example: 1
        processing_max:
          type: integer
          description: The maximum number of days required to process this listing. Default value is null.
          nullable: true
          minimum: 0
          example: 1
        who_made:
          type: string
          description: An enumerated string indicating who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.
          nullable: true
          enum:
            - i_did
            - someone_else
            - collective
          example: i_did
        when_made:
          type: string
          description: An enumerated string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.
          nullable: true
          enum:
            - made_to_order
            - '2020_2026'
            - '2010_2019'
            - '2007_2009'
            - before_2007
            - '2000_2006'
            - 1990s
            - 1980s
            - 1970s
            - 1960s
            - 1950s
            - 1940s
            - 1930s
            - 1920s
            - 1910s
            - 1900s
            - 1800s
            - 1700s
            - before_1700
          example: made_to_order
        is_supply:
          type: boolean
          description: When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'.
          nullable: true
          example: true
        item_weight:
          type: number
          description: The numeric weight of the product measured in units set in 'item_weight_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 0.5
        item_weight_unit:
          type: string
          description: A string defining the units used to measure the weight of the product. Default value is null.
          nullable: true
          enum:
            - oz
            - lb
            - g
            - kg
          example: oz
        item_length:
          type: number
          description: The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 1.0
        item_width:
          type: number
          description: The numeric width of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 1.0
        item_height:
          type: number
          description: The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 1.0
        item_dimensions_unit:
          type: string
          description: A string defining the units used to measure the dimensions of the product. Default value is null.
          nullable: true
          enum:
            - in
            - ft
            - mm
            - cm
            - m
            - yd
            - inches
          example: in
        is_private:
          type: boolean
          description: When true, this is a private listing intended for a specific buyer and hidden from shop view.
          example: true
        style:
          type: array
          description: 'An array of style strings for this listing, each of which is free-form text string such as "Formal", or "Steampunk". When creating or updating a listing, the listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Each style string is limited to 45 characters. Default value is null.'
          items:
            type: string
        file_data:
          type: string
          description: A string describing the files attached to a digital listing.
          nullable: true
          example: example string
        has_variations:
          type: boolean
          description: When true, the listing has variations.
          example: true
        should_auto_renew:
          type: boolean
          description: When true, renews a listing for four months upon expiration.
          example: true
        language:
          type: string
          description: 'The IETF language tag for the default language of the listing. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`, `ru`.'
          nullable: true
          example: en-US
        price:
          description: 'The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price. The [`getListingInventory`](/documentation/reference/#operation/getListingInventory) method requests exact prices for available offerings.'
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        converted_price:
          description: The listing price converted to the currency requested via the currency parameter. Only present when the currency parameter is provided. Null if the conversion rate is unavailable.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        taxonomy_id:
          type: integer
          description: The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.
          nullable: true
          example: 1234
        readiness_state_id:
          type: integer
          description: 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.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        suggested_title:
          type: string
          description: A title string suggested by Etsy. Only available for a user's own listings, when allow_suggested_title param is present, and when a shop's language setting is English. Not all listings will have suggestions.
          nullable: true
          example: Handmade Ceramic Mug — Stoneware
    Money:
      type: object
      x-resource-id: Money
      description: A representation of an amount of money.
      properties:
        amount:
          type: integer
          description: The amount of represented by this data.
          example: 2500
        divisor:
          type: integer
          description: The divisor to render the amount.
          minimum: 0
          example: 1
        currency_code:
          type: string
          description: The ISO currency code for this data.
          example: USD
    ShopListingFile:
      type: object
      x-resource-id: ShopListingFile
      description: A file associated with a digital listing.
      properties:
        listing_file_id:
          type: integer
          description: The unique numeric ID of a file associated with a digital listing.
          format: int64
          minimum: 1
          example: 1
        listing_id:
          type: integer
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          format: int64
          minimum: 1
          example: 123456789
        rank:
          type: integer
          description: The numeric index of the display order position of this file in the listing, starting at 1.
          minimum: 0
          example: 1
        filename:
          type: string
          description: The file name string for a file associated with a digital listing.
          example: Handmade Ceramic Mug
        filesize:
          type: string
          description: A human-readable format size string for the size of a file.
          example: example string
        size_bytes:
          type: integer
          description: A number indicating the size of a file, measured in bytes.
          minimum: 0
          example: 1
        filetype:
          type: string
          description: A type string indicating a file's MIME type.
          example: example string
        create_timestamp:
          type: integer
          description: The unique numeric ID of a file associated with a digital listing.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The unique numeric ID of a file associated with a digital listing.
          minimum: 946684800
          example: 1758153645
    ShopListingFiles:
      type: object
      x-resource-id: ShopListingFiles
      description: Represents several ShopListingFiles.
      properties:
        count:
          type: integer
          description: The number of ShopListingFiles being returned..
          minimum: 0
          example: 1
        results:
          type: array
          description: An array of ShopListingFile resources.
          items:
            description: An array of ShopListingFile resources.
            oneOf:
              - $ref: '#/components/schemas/ShopListingFile'
    ShopListings:
      type: object
      x-resource-id: ShopListings
      description: A set of ShopListing resources.
      properties:
        count:
          type: integer
          description: The number of ShopListing resources found.
          minimum: 0
          example: 1
        results:
          type: array
          description: The ShopListing resources found.
          items:
            description: The ShopListing resources found.
            oneOf:
              - $ref: '#/components/schemas/ShopListing'
    ShopListingWithAssociations:
      type: object
      x-resource-id: ShopListingWithAssociations
      description: A listing from a shop, which contains a product quantity, title, description, price, etc. and additional fields which represent associations.
      properties:
        listing_id:
          type: integer
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          format: int64
          minimum: 1
          example: 123456789
        user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) posting the listing.
          format: int64
          minimum: 1
          example: 456789
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        title:
          type: string
          description: "The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each."
          example: Handmade Ceramic Mug — Stoneware
        description:
          type: string
          description: A description string of the product for sale in the listing.
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
        state:
          type: string
          description: '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.'
          enum:
            - active
            - inactive
            - sold_out
            - draft
            - expired
          example: active
        creation_timestamp:
          type: integer
          description: The listing's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The listing's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        ending_timestamp:
          type: integer
          description: The listing's expiration time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        original_creation_timestamp:
          type: integer
          description: The listing's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        last_modified_timestamp:
          type: integer
          description: The time of the last update to the listing, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The time of the last update to the listing, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        state_timestamp:
          type: integer
          description: The date and time of the last state change of this listing.
          nullable: true
          minimum: 946684800
          example: 1758153645
        quantity:
          type: integer
          description: 'The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the [getListingInventory](/documentation/reference#operation/getListingInventory) endpoint.'
          minimum: 0
          example: 1
        shop_section_id:
          type: integer
          description: The numeric ID of a section in a specific Etsy shop.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        featured_rank:
          type: integer
          description: The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page.
          example: 1
        url:
          type: string
          description: The full URL to the listing's page on Etsy.
          example: https://www.etsy.com/listing/123456789
        num_favorers:
          type: integer
          description: The number of users who marked this Listing a favorite.
          minimum: 0
          example: 1
        non_taxable:
          type: boolean
          description: When true, applicable [shop](/documentation/reference#tag/Shop) tax rates do not apply to this listing at checkout.
          example: true
        is_taxable:
          type: boolean
          description: When true, applicable [shop](/documentation/reference#tag/Shop) tax rates apply to this listing at checkout.
          example: true
        is_customizable:
          type: boolean
          description: When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.
          example: true
        is_personalizable:
          type: boolean
          description: When true, this listing is personalizable. The default value is false.
          example: true
        listing_type:
          type: string
          description: An enumerated type string that indicates whether the listing is physical or a digital download.
          enum:
            - physical
            - download
            - both
          example: physical
        tags:
          type: array
          description: "A comma-separated list of tag strings for the listing. When creating or updating a listing, valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}\\-'™©®]/u) Default value is null."
          items:
            type: string
        materials:
          type: array
          description: 'A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Default value is null.'
          items:
            type: string
        shipping_profile_id:
          type: integer
          description: The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        return_policy_id:
          type: integer
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          format: int64
          nullable: true
          minimum: 1
          example: 1
        processing_min:
          type: integer
          description: The minimum number of days required to process this listing. Default value is null.
          nullable: true
          minimum: 0
          example: 1
        processing_max:
          type: integer
          description: The maximum number of days required to process this listing. Default value is null.
          nullable: true
          minimum: 0
          example: 1
        who_made:
          type: string
          description: An enumerated string indicating who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.
          nullable: true
          enum:
            - i_did
            - someone_else
            - collective
          example: i_did
        when_made:
          type: string
          description: An enumerated string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.
          nullable: true
          enum:
            - made_to_order
            - '2020_2026'
            - '2010_2019'
            - '2007_2009'
            - before_2007
            - '2000_2006'
            - 1990s
            - 1980s
            - 1970s
            - 1960s
            - 1950s
            - 1940s
            - 1930s
            - 1920s
            - 1910s
            - 1900s
            - 1800s
            - 1700s
            - before_1700
          example: made_to_order
        is_supply:
          type: boolean
          description: When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'.
          nullable: true
          example: true
        item_weight:
          type: number
          description: The numeric weight of the product measured in units set in 'item_weight_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 0.5
        item_weight_unit:
          type: string
          description: A string defining the units used to measure the weight of the product. Default value is null.
          nullable: true
          enum:
            - oz
            - lb
            - g
            - kg
          example: oz
        item_length:
          type: number
          description: The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 1.0
        item_width:
          type: number
          description: The numeric width of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 1.0
        item_height:
          type: number
          description: The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.
          format: float
          nullable: true
          example: 1.0
        item_dimensions_unit:
          type: string
          description: A string defining the units used to measure the dimensions of the product. Default value is null.
          nullable: true
          enum:
            - in
            - ft
            - mm
            - cm
            - m
            - yd
            - inches
          example: in
        is_private:
          type: boolean
          description: When true, this is a private listing intended for a specific buyer and hidden from shop view.
          example: true
        style:
          type: array
          description: 'An array of style strings for this listing, each of which is free-form text string such as "Formal", or "Steampunk". When creating or updating a listing, the listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) Each style string is limited to 45 characters. Default value is null.'
          items:
            type: string
        file_data:
          type: string
          description: A string describing the files attached to a digital listing.
          nullable: true
          example: example string
        has_variations:
          type: boolean
          description: When true, the listing has variations.
          example: true
        should_auto_renew:
          type: boolean
          description: When true, renews a listing for four months upon expiration.
          example: true
        language:
          type: string
          description: 'The IETF language tag for the default language of the listing. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`, `ru`.'
          nullable: true
          example: en-US
        price:
          description: 'The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price. The [`getListingInventory`](/documentation/reference/#operation/getListingInventory) method requests exact prices for available offerings.'
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        converted_price:
          description: The listing price converted to the currency requested via the currency parameter. Only present when the currency parameter is provided. Null if the conversion rate is unavailable.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        taxonomy_id:
          type: integer
          description: The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.
          nullable: true
          example: 1234
        readiness_state_id:
          type: integer
          description: 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.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        suggested_title:
          type: string
          description: A title string suggested by Etsy. Only available for a user's own listings, when allow_suggested_title param is present, and when a shop's language setting is English. Not all listings will have suggestions.
          nullable: true
          example: Handmade Ceramic Mug — Stoneware
        shipping_profile:
          description: An array of data representing the shipping profile resource.
          oneOf:
            - $ref: '#/components/schemas/ShopShippingProfile'
          nullable: true
          example: example
        user:
          description: Represents a single user of the site
          oneOf:
            - $ref: '#/components/schemas/User'
          nullable: true
          example: example
        shop:
          description: A shop created by an Etsy user.
          oneOf:
            - $ref: '#/components/schemas/Shop'
          nullable: true
          example: example
        images:
          type: array
          description: Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image
          items:
            description: Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image
            oneOf:
              - $ref: '#/components/schemas/ListingImage'
        videos:
          type: array
          description: The single video associated with a listing.
          items:
            description: The single video associated with a listing.
            oneOf:
              - $ref: '#/components/schemas/ListingVideo'
        inventory:
          description: An enumerated string that attaches a valid association. Default value is null.
          oneOf:
            - $ref: '#/components/schemas/ListingInventory'
          nullable: true
          example: example
        production_partners:
          type: array
          description: Represents a list of production partners for a shop.
          items:
            description: Represents a list of production partners for a shop.
            oneOf:
              - $ref: '#/components/schemas/ShopProductionPartner'
        skus:
          type: array
          description: A list of SKU strings for the listing. SKUs will only appear if the requesting user owns the shop and a valid matching OAuth 2 token is provided. When requested without the token it will be an empty array.
          items:
            type: string
        translations:
          description: A map of translations for the listing. Default value is a map of all supported languages keyed to null.
          oneOf:
            - $ref: '#/components/schemas/ListingTranslations'
          nullable: true
          example: example
        views:
          type: integer
          description: The number of times the listing has been viewed. This value is tabulated once per day and **only for active listings**, so the value is not real-time. If `0`, the listing has either not been viewed, not yet tabulated, was not active during the last tabulation or there was an error fetching the value. If a value is expected, call `getListing` to confirm the value.
          example: 1
        personalization:
          oneOf:
            - $ref: '#/components/schemas/Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization'
          nullable: true
          example: example
        buyer_price:
          description: The buyer-facing price for a listing, including VAT, inclusive shipping (UK), and active promotions. Requires buyer_country parameter. Shows base_price, shipping_cost, original_price (display price), and discounted_price if a promotion is active. Currently only supported on the /listings/batch endpoint.
          oneOf:
            - $ref: '#/components/schemas/ListingBuyerPrice'
          nullable: true
          example: example
    ShopShippingProfile:
      type: object
      x-resource-id: ShopShippingProfile
      description: Represents a profile used to set a listing's shipping information. Please note that it's not possible to create calculated shipping templates via the API. However, you can associate calculated shipping profiles created from Shop Manager with listings using the API.
      properties:
        shipping_profile_id:
          type: integer
          description: The numeric ID of the shipping profile.
          format: int64
          minimum: 1
          example: 1
        title:
          type: string
          description: The name string of this shipping profile.
          nullable: true
          example: Handmade Ceramic Mug — Stoneware
        user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) who owns the shipping profile.
          format: int64
          minimum: 1
          example: 456789
        origin_country_iso:
          type: string
          description: The ISO code of the country from which the listing ships.
          format: ISO 3166-1 alpha-2
          example: US
        is_deleted:
          type: boolean
          description: When true, someone deleted this shipping profile.
          example: true
        shipping_profile_destinations:
          type: array
          description: A list of [shipping profile destinations](/documentation/reference/#operation/createShopShippingProfileDestination) available for this shipping profile.
          items:
            description: A list of [shipping profile destinations](/documentation/reference/#operation/createShopShippingProfileDestination) available for this shipping profile.
            oneOf:
              - $ref: '#/components/schemas/ShopShippingProfileDestination'
        shipping_profile_upgrades:
          type: array
          description: A list of [shipping profile upgrades](/documentation/reference/#operation/createShopShippingProfileUpgrade) available for this shipping profile.
          items:
            description: A list of [shipping profile upgrades](/documentation/reference/#operation/createShopShippingProfileUpgrade) available for this shipping profile.
            oneOf:
              - $ref: '#/components/schemas/ShopShippingProfileUpgrade'
        origin_postal_code:
          type: string
          description: The postal code string (not necessarily a number) for the location from which the listing ships. Required if the `origin_country_iso` supports postal codes. See the [Fulfillment Tutorial docs](https://developer.etsy.com/documentation/tutorials/fulfillment/#countries-requiring-postal-codes) for more info
          nullable: true
          example: '11201'
        profile_type:
          type: string
          enum:
            - manual
            - calculated
          default: manual
          example: manual
        domestic_handling_fee:
          type: number
          description: The domestic handling fee added to buyer's shipping total - only available for calculated shipping profiles.
          format: float
          minimum: 0
          default: 0
          example: 1.0
        international_handling_fee:
          type: number
          description: The international handling fee added to buyer's shipping total - only available for calculated shipping profiles.
          format: float
          minimum: 0
          default: 0
          example: 1.0
    ShopShippingProfileDestination:
      type: object
      x-resource-id: ShopShippingProfileDestination
      description: Represents a shipping destination assigned to a shipping profile.
      properties:
        shipping_profile_destination_id:
          type: integer
          description: The numeric ID of the shipping profile destination in the [shipping profile](/documentation/reference#tag/Shop-ShippingProfile) associated with the listing.
          format: int64
          minimum: 1
          example: 1
        shipping_profile_id:
          type: integer
          description: The numeric ID of the shipping profile.
          format: int64
          minimum: 1
          example: 1
        origin_country_iso:
          type: string
          description: The ISO code of the country from which the listing ships.
          format: ISO 3166-1 alpha-2
          example: US
        destination_country_iso:
          type: string
          description: The ISO code of the country to which the listing ships. If null, request sets destination to destination_region. Required if destination_region is null or not provided.
          example: US
        destination_region:
          type: string
          description: The code of the region to which the listing ships. A region represents a set of countries. Supported regions are Europe Union and Non-Europe Union (countries in Europe not in EU). If `none`, request sets destination to destination_country_iso. Required if destination_country_iso is null or not provided.
          enum:
            - eu
            - non_eu
            - none
          example: eu
        primary_cost:
          description: The cost of shipping to this country/region alone, measured in the store's default currency.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        secondary_cost:
          description: The cost of shipping to this country/region with another item, measured in the store's default currency.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        shipping_carrier_id:
          type: integer
          description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
          nullable: true
          example: 1
        mail_class:
          type: string
          description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
          nullable: true
          example: example string
        min_delivery_days:
          type: integer
          description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
          nullable: true
          minimum: 1
          maximum: 45
          example: 1
        max_delivery_days:
          type: integer
          description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
          nullable: true
          minimum: 1
          maximum: 45
          example: 1
    ShopShippingProfileUpgrade:
      type: object
      x-resource-id: ShopShippingProfileUpgrade
      description: A representation of a shipping profile upgrade option.
      properties:
        shipping_profile_id:
          type: integer
          description: The numeric ID of the base shipping profile.
          format: int64
          minimum: 1
          example: 1
        upgrade_id:
          type: integer
          description: The numeric ID that is associated with a shipping upgrade
          format: int64
          minimum: 1
          example: 1
        upgrade_name:
          type: string
          description: Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority.
          example: Handmade Ceramic Mug
        type:
          type: integer
          description: The type of the shipping upgrade. Domestic (0) or international (1).
          enum:
            - 0
            - 1
          example: 0
        rank:
          type: integer
          description: The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.
          minimum: 0
          example: 1
        language:
          type: string
          description: 'The IETF language tag for the language of the shipping profile. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`'
          example: en-US
        price:
          description: Additional cost of adding the shipping upgrade.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        secondary_price:
          description: Additional cost of adding the shipping upgrade for each additional item.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        shipping_carrier_id:
          type: integer
          description: The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. **Required with `mail_class`** if `min_delivery_days` and `max_delivery_days` are null.
          nullable: true
          example: 1
        mail_class:
          type: string
          description: The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. **Required with `shipping_carrier_id`** if `min_delivery_days` and `max_delivery_days` are null.
          nullable: true
          example: example string
        min_delivery_days:
          type: integer
          description: The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `max_delivery_days`** if `mail_class` is null.
          nullable: true
          minimum: 1
          maximum: 45
          example: 1
        max_delivery_days:
          type: integer
          description: The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. **Required with `min_delivery_days`** if `mail_class` is null.
          nullable: true
          minimum: 1
          maximum: 45
          example: 1
    User:
      type: object
      x-resource-id: User
      description: Represents a single user of the site
      properties:
        user_id:
          type: integer
          description: The numeric ID of a user. This number is also a valid shop ID for the user's shop.
          format: int64
          minimum: 1
          example: 456789
        primary_email:
          type: string
          description: An email address string for the user's primary email address. Access to this field is granted on a case by case basis for third-party integrations that require full access
          format: email
          nullable: true
          example: seller@example.com
        first_name:
          type: string
          description: The user's first name.
          nullable: true
          example: Handmade Ceramic Mug
        last_name:
          type: string
          description: The user's last name.
          nullable: true
          example: Handmade Ceramic Mug
        image_url_75x75:
          type: string
          description: The user's avatar URL.
          nullable: true
          example: https://www.etsy.com/listing/123456789
    Shop:
      type: object
      x-resource-id: Shop
      description: A shop created by an Etsy user.
      properties:
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        user_id:
          type: integer
          description: The numeric user ID of the [user](/documentation/reference#tag/User) who owns this shop.
          format: int64
          minimum: 1
          example: 456789
        shop_name:
          type: string
          description: The shop's name string.
          example: HandmadeCrafts
        create_date:
          type: integer
          description: The date and time this shop was created, in epoch seconds.
          minimum: 0
          example: 1
        created_timestamp:
          type: integer
          description: The date and time this shop was created, in epoch seconds.
          minimum: 0
          example: 1758153645
        title:
          type: string
          description: A brief heading string for the shop's main page.
          nullable: true
          example: Handmade Ceramic Mug — Stoneware
        announcement:
          type: string
          description: An announcement string to buyers that displays on the shop's homepage.
          nullable: true
          example: example string
        currency_code:
          type: string
          description: The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.
          example: USD
        is_vacation:
          type: boolean
          description: When true, this shop is not accepting purchases.
          example: true
        vacation_message:
          type: string
          description: The shop's message string displayed when `is_vacation` is true.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        sale_message:
          type: string
          description: A message string sent to users who complete a purchase from this shop.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        digital_sale_message:
          type: string
          description: A message string sent to users who purchase a digital item from this shop.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        update_date:
          type: integer
          description: The date and time of the last update to the shop, in epoch seconds.
          minimum: 0
          example: 1
        updated_timestamp:
          type: integer
          description: The date and time of the last update to the shop, in epoch seconds.
          minimum: 0
          example: 1758153645
        listing_active_count:
          type: integer
          description: The number of active listings in the shop.
          minimum: 0
          example: 1
        digital_listing_count:
          type: integer
          description: The number of digital listings in the shop.
          minimum: 0
          example: 1
        login_name:
          type: string
          description: The shop owner's login name string.
          example: handmade_seller
        accepts_custom_requests:
          type: boolean
          description: When true, the shop accepts customization requests.
          example: true
        policy_welcome:
          type: string
          description: The shop's policy welcome string (may be blank).
          nullable: true
          example: example string
        policy_payment:
          type: string
          description: The shop's payment policy string (may be blank).
          nullable: true
          example: example string
        policy_shipping:
          type: string
          description: The shop's shipping policy string (may be blank).
          nullable: true
          example: example string
        policy_refunds:
          type: string
          description: The shop's refund policy string (may be blank).
          nullable: true
          example: example string
        policy_additional:
          type: string
          description: The shop's additional policies string (may be blank).
          nullable: true
          example: example string
        policy_seller_info:
          type: string
          description: The shop's seller information string (may be blank).
          nullable: true
          example: example string
        policy_update_date:
          type: integer
          description: The date and time of the last update to the shop's policies, in epoch seconds.
          minimum: 0
          example: 1
        policy_has_private_receipt_info:
          type: boolean
          description: When true, EU receipts display private info.
          example: true
        has_unstructured_policies:
          type: boolean
          description: When true, the shop displays additional unstructured policy fields.
          example: true
        policy_privacy:
          type: string
          description: The shop's privacy policy string (may be blank).
          nullable: true
          example: example string
        vacation_autoreply:
          type: string
          description: The shop's automatic reply string displayed in new conversations when `is_vacation` is true.
          nullable: true
          example: example string
        url:
          type: string
          description: The URL string for this shop.
          example: https://www.etsy.com/listing/123456789
        image_url_760x100:
          type: string
          description: The URL string for this shop's banner image.
          nullable: true
          example: https://www.etsy.com/listing/123456789
        num_favorers:
          type: integer
          description: The number of users who marked this shop a favorite.
          minimum: 0
          example: 1
        languages:
          type: array
          description: A list of language strings for the shop's enrolled languages where the default shop language is the first element in the array.
          items:
            type: string
        icon_url_fullxfull:
          type: string
          description: The URL string for this shop's icon image.
          nullable: true
          example: https://www.etsy.com/listing/123456789
        is_using_structured_policies:
          type: boolean
          description: When true, the shop accepted using structured policies.
          example: true
        has_onboarded_structured_policies:
          type: boolean
          description: When true, the shop accepted OR declined after viewing structured policies onboarding.
          example: true
        include_dispute_form_link:
          type: boolean
          description: When true, this shop's policies include a link to an EU online dispute form.
          example: true
        is_direct_checkout_onboarded:
          type: boolean
          description: '(**DEPRECATED: Replaced by _is_etsy_payments_onboarded_.) When true, the shop has onboarded onto Etsy Payments.'
          example: true
        is_etsy_payments_onboarded:
          type: boolean
          description: When true, the shop has onboarded onto Etsy Payments.
          example: true
        is_calculated_eligible:
          type: boolean
          description: When true, the shop is eligible for calculated shipping profiles. (Only available in the US and Canada)
          example: true
        is_opted_in_to_buyer_promise:
          type: boolean
          description: When true, the shop opted in to buyer promise.
          example: true
        is_shop_us_based:
          type: boolean
          description: When true, the shop is based in the US.
          example: true
        transaction_sold_count:
          type: integer
          description: The total number of sales ([transactions](/documentation/reference#tag/Shop-Receipt-Transactions)) for this shop.
          minimum: 0
          example: 1
        shipping_from_country_iso:
          type: string
          description: The country ISO the shop is shipping from.
          format: ISO 3166-1 alpha-2
          nullable: true
          example: US
        shop_location_country_iso:
          type: string
          description: The country ISO where the shop is located.
          format: ISO 3166-1 alpha-2
          nullable: true
          example: US
        review_count:
          type: integer
          description: Number of reviews of shop listings in the past year.
          nullable: true
          example: 1
        review_average:
          type: number
          description: Average rating based on reviews of shop listings in the past year.
          format: float
          nullable: true
          example: 1.0
    ListingImage:
      type: object
      x-resource-id: ListingImage
      description: Reference urls and metadata for an image associated with a specific listing. The `url_fullxfull` parameter contains the URL for full-sized binary image file.
      properties:
        listing_id:
          type: integer
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          format: int64
          minimum: 1
          example: 123456789
        listing_image_id:
          type: integer
          description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
          format: int64
          minimum: 1
          example: 1
        hex_code:
          type: string
          description: The webhex string for the image's average color, in webhex notation.
          nullable: true
          example: example string
        red:
          type: integer
          description: The numeric red value equal to the image's average red value, from 0-255 (RGB color).
          nullable: true
          minimum: 0
          example: 1
        green:
          type: integer
          description: The numeric red value equal to the image's average red value, from 0-255 (RGB color).
          nullable: true
          minimum: 0
          example: 1
        blue:
          type: integer
          description: The numeric red value equal to the image's average red value, from 0-255 (RGB color).
          nullable: true
          minimum: 0
          example: 1
        hue:
          type: integer
          description: The numeric hue equal to the image's average hue, from 0-360 (HSV color).
          nullable: true
          minimum: 0
          example: 1
        saturation:
          type: integer
          description: The numeric saturation equal to the image's average saturation, from 0-100 (HSV color).
          nullable: true
          minimum: 0
          example: 1
        brightness:
          type: integer
          description: The numeric brightness equal to the image's average brightness, from 0-100 (HSV color).
          nullable: true
          minimum: 0
          example: 1
        is_black_and_white:
          type: boolean
          description: When true, the image is in black & white.
          nullable: true
          example: true
        creation_tsz:
          type: integer
          description: The listing image's creation time, in epoch seconds.
          minimum: 0
          example: 1
        created_timestamp:
          type: integer
          description: The listing image's creation time, in epoch seconds.
          minimum: 0
          example: 1758153645
        rank:
          type: integer
          description: The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.
          minimum: 0
          example: 1
        url_75x75:
          type: string
          description: The url string for a 75x75 pixel thumbnail of the image.
          example: https://www.etsy.com/listing/123456789
        url_170x135:
          type: string
          description: The url string for a 170x135 pixel thumbnail of the image.
          example: https://www.etsy.com/listing/123456789
        url_570xN:
          type: string
          description: The url string for a thumbnail of the image, no more than 570 pixels wide with variable height.
          example: https://www.etsy.com/listing/123456789
        url_fullxfull:
          type: string
          description: The url string for the full-size image, up to 3000 pixels in each dimension.
          example: https://www.etsy.com/listing/123456789
        full_height:
          type: integer
          description: The numeric height, measured in pixels, of the full-sized image referenced in url_fullxfull.
          nullable: true
          minimum: 0
          example: 1
        full_width:
          type: integer
          description: The numeric width, measured in pixels, of the full-sized image referenced in url_fullxfull.
          nullable: true
          minimum: 0
          example: 1
        alt_text:
          type: string
          description: Alt text for the listing image. Max length 500 characters.
          nullable: true
          example: example string
    ListingVideo:
      type: object
      x-resource-id: ListingVideo
      description: Reference urls and metadata for a video associated with a specific listing.
      properties:
        video_id:
          type: integer
          description: The unique ID of a video associated with a listing.
          format: int64
          minimum: 1
          example: 1
        height:
          type: integer
          description: The video height dimension in pixels.
          example: 1
        width:
          type: integer
          description: The video width dimension in pixels.
          example: 1
        thumbnail_url:
          type: string
          description: The url of the video thumbnail.
          example: https://www.etsy.com/listing/123456789
        video_url:
          type: string
          description: The url of the video file.
          example: https://www.etsy.com/listing/123456789
        video_state:
          type: string
          description: The current state of a given video. Value is one of `active`, `inactive`, `deleted` or `flagged`.
          enum:
            - active
            - inactive
            - deleted
            - flagged
          default: active
          example: active
    ListingInventory:
      type: object
      x-resource-id: ListingInventory
      description: A representation of a single listing's inventory record.
      properties:
        products:
          type: array
          description: A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
          items:
            description: A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
            oneOf:
              - $ref: '#/components/schemas/ListingInventoryProduct'
        price_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
        quantity_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
        sku_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
        readiness_state_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
            format: int64
            minimum: 1
    ListingInventoryProduct:
      type: object
      x-resource-id: ListingInventoryProduct
      description: A representation of a product for a listing.
      properties:
        product_id:
          type: integer
          description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
          format: int64
          minimum: 1
          example: 567890123
        sku:
          type: string
          description: The SKU string for the product
          example: SKU-12345
        is_deleted:
          type: boolean
          description: When true, someone deleted this product.
          example: true
        offerings:
          type: array
          description: A list of product offering entries for this product.
          items:
            description: A list of product offering entries for this product.
            oneOf:
              - $ref: '#/components/schemas/ListingInventoryProductOffering'
        property_values:
          type: array
          description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
          items:
            description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
            oneOf:
              - $ref: '#/components/schemas/ListingPropertyValue'
    ListingInventoryProductOffering:
      type: object
      x-resource-id: ListingInventoryProductOffering
      description: A representation of an offering for a listing.
      properties:
        offering_id:
          type: integer
          description: The ID for the ProductOffering
          format: int64
          minimum: 1
          example: 1
        quantity:
          type: integer
          description: The quantity the ProductOffering
          minimum: 0
          example: 1
        is_enabled:
          type: boolean
          description: Whether or not the offering can be shown to buyers.
          example: true
        is_deleted:
          type: boolean
          description: Whether or not the offering has been deleted.
          example: true
        price:
          description: Price data for this ProductOffering
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        readiness_state_id:
          type: integer
          description: Processing Profile for this ProductOffering
          format: int64
          nullable: true
          minimum: 1
          example: 1
    ListingPropertyValue:
      type: object
      x-resource-id: ListingPropertyValue
      description: A representation of structured data values.
      properties:
        property_id:
          type: integer
          description: The numeric ID of the Property.
          format: int64
          minimum: 1
          example: 1
        property_name:
          type: string
          description: The name of the Property.
          nullable: true
          example: Handmade Ceramic Mug
        scale_id:
          type: integer
          description: The numeric ID of the scale (if any).
          format: int64
          nullable: true
          minimum: 1
          example: 1
        scale_name:
          type: string
          description: The label used to describe the chosen scale (if any).
          nullable: true
          example: Handmade Ceramic Mug
        value_ids:
          type: array
          description: The numeric IDs of the Property values
          items:
            type: integer
            format: int64
            minimum: 1
        values:
          type: array
          description: The Property values
          items:
            type: string
    ShopProductionPartner:
      type: object
      x-resource-id: ShopProductionPartner
      description: Represents a description of a shop production partner.
      properties:
        production_partner_id:
          type: integer
          description: The numeric ID of a production partner.
          format: int64
          minimum: 1
          example: 1
        partner_name:
          type: string
          description: The name or title of the production partner.
          example: Handmade Ceramic Mug
        location:
          type: string
          description: A string representing the production partner location.
          example: example string
    ListingTranslations:
      type: object
      x-resource-id: ListingTranslations
      description: Container for all current supported translations of a listing. Note that Etsy periodically adds/removes languages, so this list may change in the future.
      properties:
        de:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        en-GB:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        en-IN:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        en-US:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        es:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        fr:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        it:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        ja:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        nl:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        pl:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        pt:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        ru:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
        sv:
          oneOf:
            - $ref: '#/components/schemas/ListingTranslation'
          nullable: true
          example: example
    ListingTranslation:
      type: object
      x-resource-id: ListingTranslation
      description: Represents the translation data for a Listing.
      properties:
        listing_id:
          type: integer
          description: The numeric ID for the Listing.
          format: int64
          minimum: 1
          example: 123456789
        language:
          type: string
          description: The IETF language tag (e.g. 'fr') for the language of this translation.
          example: en-US
        title:
          type: string
          description: The title of the Listing of this Translation.
          nullable: true
          example: Handmade Ceramic Mug — Stoneware
        description:
          type: string
          description: The description of the Listing of this Translation.
          nullable: true
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
        tags:
          type: array
          description: The tags of the Listing of this Translation.
          items:
            type: string
    Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization:
      type: object
      x-resource-id: Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_ListingPersonalization
      properties:
        personalization_questions:
          type: array
          items:
            $ref: '#/components/schemas/Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_PersonalizationQuestion'
    Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_PersonalizationQuestion:
      type: object
      x-resource-id: Etsy_Modules_ListingPersonalization_Api_Resources_OpenApi_PersonalizationQuestion
      properties:
        question_id:
          type: integer
          format: int64
          nullable: true
          minimum: 1
          example: 1
        question_text:
          type: string
          example: example string
        instructions:
          type: string
          nullable: true
          example: example string
        question_type:
          type: string
          example: example string
        required:
          type: boolean
          example: true
        max_allowed_characters:
          type: integer
          nullable: true
          example: 1
        max_allowed_files:
          type: integer
          nullable: true
          example: 1
        options:
          type: array
          nullable: true
          items:
            type: object
            properties:
              option_id:
                type: integer
                format: int64
                nullable: true
                minimum: 1
                example: 1
              label:
                type: string
                example: example string
            required:
              - option_id
              - label
    ListingBuyerPrice:
      type: object
      x-resource-id: ListingBuyerPrice
      description: The buyer-facing price for a listing, including VAT, inclusive shipping (UK), and active promotions.
      properties:
        base_price:
          description: The pre-discount listing price with VAT applied, excluding shipping. When a promotion is active, this is the price before the discount is applied.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        shipping_cost:
          description: The shipping cost to the buyer's country. Includes VAT where applicable. Null when shipping is free or unavailable — use is_free_shipping to distinguish.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        is_free_shipping:
          type: boolean
          description: Whether shipping is free to the buyer's country.
          example: true
        original_price:
          description: The display price. For UK buyers, includes base + shipping (DMCC). For others, base price only.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        discounted_price:
          description: The sale price. For UK buyers, includes base + shipping. For others, base price only. Null if no active promotion.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        discount_amount:
          description: The discount amount as money (original_price - discounted_price). Null if no active promotion.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        discount_percentage:
          type: integer
          description: The discount percentage (e.g. 20 for 20% off). Null if no active promotion or if the promotion is a fixed-amount discount.
          nullable: true
          example: 1
        has_discount:
          type: boolean
          description: Whether an active promotion applies to this listing.
          example: true
        discount_start_epoch:
          type: integer
          description: The start timestamp of the active promotion. Null if no active promotion.
          nullable: true
          example: 1758153645
        discount_end_epoch:
          type: integer
          description: The end timestamp of the active promotion. Null if no active promotion.
          nullable: true
          example: 1758153645
    ListingImages:
      type: object
      x-resource-id: ListingImages
      description: Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/ListingImage'
    ListingInventoryWithAssociations:
      type: object
      x-resource-id: ListingInventoryWithAssociations
      description: A representation of a single listing's inventory record with associations
      properties:
        products:
          type: array
          description: A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
          items:
            description: A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase.
            oneOf:
              - $ref: '#/components/schemas/ListingInventoryProduct'
        price_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
        quantity_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
        sku_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
        readiness_state_on_property:
          type: array
          description: An array of unique [listing property](/documentation/reference#operation/getListingInventory) 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.
          items:
            type: integer
            format: int64
            minimum: 1
        listing:
          description: An enumerated string that attaches a valid association. Default value is null.
          oneOf:
            - $ref: '#/components/schemas/ShopListing'
          example: example
    ShopListingsWithAssociations:
      type: object
      x-resource-id: ShopListingsWithAssociations
      description: A set of ShopListing resources with associations.
      properties:
        count:
          type: integer
          description: The number of ShopListing resources found.
          minimum: 0
          example: 1
        results:
          type: array
          description: The ShopListing resources found.
          items:
            description: The ShopListing resources found.
            oneOf:
              - $ref: '#/components/schemas/ShopListingWithAssociations'
    ListingPropertyValues:
      type: object
      x-resource-id: ListingPropertyValues
      description: Represents several ListingPropertyValues.
      properties:
        count:
          type: integer
          minimum: 0
          example: 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ListingPropertyValue'
    ShopReceiptTransactions:
      type: object
      x-resource-id: ShopReceiptTransactions
      description: A set of ShopReceiptTransaction resources
      properties:
        count:
          type: integer
          description: The number of ShopReceiptTransaction resources found.
          example: 1
        results:
          type: array
          description: The ShopReceiptTransaction resources found.
          items:
            description: The ShopReceiptTransaction resources found.
            oneOf:
              - $ref: '#/components/schemas/ShopReceiptTransaction'
    ShopReceiptTransaction:
      type: object
      x-resource-id: ShopReceiptTransaction
      description: A transaction object associated with a shop receipt. Etsy generates one transaction per listing purchased as recorded on the order receipt.
      properties:
        transaction_id:
          type: integer
          description: The unique numeric ID for a transaction.
          format: int64
          minimum: 1
          example: 345678901
        title:
          type: string
          description: The title string of the [listing](/documentation/reference#tag/ShopListing) purchased in this transaction.
          nullable: true
          example: Handmade Ceramic Mug — Stoneware
        description:
          type: string
          description: The description string of the [listing](/documentation/reference#tag/ShopListing) purchased in this transaction.
          nullable: true
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
        seller_user_id:
          type: integer
          description: The numeric user ID for the seller in this transaction.
          format: int64
          minimum: 1
          example: 456789
        buyer_user_id:
          type: integer
          description: The numeric user ID for the buyer in this transaction.
          format: int64
          minimum: 1
          example: 456789
        create_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        paid_timestamp:
          type: integer
          description: The transaction's paid date and time, in epoch seconds.
          nullable: true
          minimum: 946684800
          example: 1758153645
        shipped_timestamp:
          type: integer
          description: The transaction's shipping date and time, in epoch seconds.
          nullable: true
          minimum: 946684800
          example: 1758153645
        quantity:
          type: integer
          description: The numeric quantity of products purchased in this transaction.
          minimum: 0
          example: 1
        listing_image_id:
          type: integer
          description: The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        receipt_id:
          type: integer
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          format: int64
          minimum: 1
          example: 234567890
        is_digital:
          type: boolean
          description: When true, the transaction recorded the purchase of a digital listing.
          example: true
        file_data:
          type: string
          description: A string describing the files purchased in this transaction.
          example: example string
        listing_id:
          type: integer
          description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
          nullable: true
          minimum: 0
          example: 123456789
        transaction_type:
          type: string
          description: The type string for the transaction, usually "listing".
          example: example string
        product_id:
          type: integer
          description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
          format: int64
          nullable: true
          minimum: 1
          example: 567890123
        sku:
          type: string
          description: The SKU string for the product
          nullable: true
          example: SKU-12345
        price:
          description: A money object representing the price recorded the transaction.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        shipping_cost:
          description: A money object representing the shipping cost for this transaction.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        variations:
          type: array
          description: Array of variations and personalizations the buyer chose.
          items:
            description: Array of variations and personalizations the buyer chose.
            oneOf:
              - $ref: '#/components/schemas/TransactionVariations'
        product_data:
          type: array
          description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
          items:
            description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
            oneOf:
              - $ref: '#/components/schemas/ListingPropertyValue'
        shipping_profile_id:
          type: integer
          description: The ID of the shipping profile selected for this listing.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        min_processing_days:
          type: integer
          description: The minimum number of days for processing the listing.
          nullable: true
          minimum: 0
          example: 1
        max_processing_days:
          type: integer
          description: The maximum number of days for processing the listing.
          nullable: true
          minimum: 0
          example: 1
        shipping_method:
          type: string
          description: Name of the selected shipping method.
          nullable: true
          example: example string
        shipping_upgrade:
          type: string
          description: The name of the shipping upgrade selected for this listing. Default value is null.
          nullable: true
          example: example string
        expected_ship_date:
          type: integer
          description: The date & time of the expected ship date, in epoch seconds.
          nullable: true
          minimum: 946684800
          example: 1
        buyer_coupon:
          type: number
          description: The amount of the buyer coupon that was discounted in the shop's currency.
          format: float
          default: 0
          example: 1.0
        shop_coupon:
          type: number
          description: The amount of the shop coupon that was discounted in the shop's currency.
          format: float
          default: 0
          example: 1.0
    TransactionVariations:
      type: object
      x-resource-id: TransactionVariations
      description: A list of variations chosen by the buyer during checkout.
      properties:
        property_id:
          type: integer
          description: The variation property ID.
          example: 1
        value_id:
          type: integer
          description: The ID of the variation value selected.
          nullable: true
          example: 1
        formatted_name:
          type: string
          description: Formatted name of the variation.
          example: Handmade Ceramic Mug
        formatted_value:
          type: string
          description: Value of the variation entered by the buyer.
          example: example string
        question_id:
          type: integer
          description: '[Personalization only] The ID of the original personalization question.'
          nullable: true
          example: 1
    ListingVariationImages:
      type: object
      x-resource-id: ListingVariationImages
      description: Represents several ListingVariationImages.
      properties:
        count:
          type: integer
          minimum: 0
          example: 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ListingVariationImage'
    ListingVariationImage:
      type: object
      x-resource-id: ListingVariationImage
      description: A representation of the associations of variations and images on a listing.
      properties:
        property_id:
          type: integer
          description: The numeric ID of the Property.
          format: int64
          minimum: 1
          example: 1
        value_id:
          type: integer
          description: The numeric ID of the Value.
          format: int64
          minimum: 1
          example: 1
        value:
          type: string
          description: The string value of the property.
          nullable: true
          example: example string
        image_id:
          type: integer
          description: The numeric ID of the Image.
          format: int64
          minimum: 1
          example: 1
    ListingVideos:
      type: object
      x-resource-id: ListingVideos
      description: Represents a list of listing video resources, each of which contains the reference URLs for the videos.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/ListingVideo'
    PaymentAccountLedgerEntry:
      type: object
      x-resource-id: PaymentAccountLedgerEntry
      description: Represents an entry in a shop's ledger.
      properties:
        entry_id:
          type: integer
          description: The ledger entry's numeric ID.
          format: int64
          minimum: 1
          example: 1
        ledger_id:
          type: integer
          description: The ledger's numeric ID.
          format: int64
          minimum: 1
          example: 1
        sequence_number:
          type: integer
          description: The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry.
          example: 1
        amount:
          type: integer
          description: The amount of money credited to the ledger.
          example: 2500
        currency:
          type: string
          description: The currency of the entry on the ledger.
          example: example string
        description:
          type: string
          description: 'Details what kind of ledger entry this is: a payment, refund, reversal of a failed refund, disbursement, returned disbursement, recoupment, miscellaneous credit, miscellaneous debit, or bill payment.'
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
        balance:
          type: integer
          description: The amount of money in the shop's ledger the moment after this entry was applied.
          example: 1
        create_date:
          type: integer
          description: The date and time the ledger entry was created in Epoch seconds.
          minimum: 0
          example: 1
        created_timestamp:
          type: integer
          description: The date and time the ledger entry was created in Epoch seconds.
          minimum: 0
          example: 1758153645
        ledger_type:
          type: string
          description: The original reference type for the ledger entry.
          example: example string
        reference_type:
          type: string
          description: The object type the ledger entry refers to.
          example: example string
        reference_id:
          type: string
          description: The object id the ledger entry refers to.
          nullable: true
          example: example string
        parent_entry_id:
          type: integer
          description: The parent ledger entry ID used to match related entries (e.g., vat_seller_services to originating seller fees).
          minimum: 0
          example: 1
        payment_adjustments:
          type: array
          description: List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.
          items:
            description: List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.
            oneOf:
              - $ref: '#/components/schemas/PaymentAdjustment'
    PaymentAdjustment:
      type: object
      x-resource-id: PaymentAdjustment
      description: Represents a refund, which applies to a prior Etsy payment. All monetary amounts are in USD pennies unless otherwise specified.
      properties:
        payment_adjustment_id:
          type: integer
          description: The numeric ID for a payment adjustment.
          format: int64
          minimum: 1
          example: 1
        payment_id:
          type: integer
          description: A unique numeric ID for a payment to a specific Etsy [shop](/documentation/reference#tag/Shop).
          format: int64
          minimum: 1
          example: 1
        status:
          type: string
          description: The status string of the payment adjustment.
          example: example string
        is_success:
          type: boolean
          description: When true, the payment adjustment was or is likely to complete successfully.
          example: true
        user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) (seller) fulfilling the purchase.
          format: int64
          minimum: 1
          example: 456789
        reason_code:
          type: string
          description: A human-readable string describing the reason for the refund.
          example: example string
        total_adjustment_amount:
          type: integer
          description: The total numeric amount of the refund in the payment currency.
          nullable: true
          minimum: 0
          example: 2500
        shop_total_adjustment_amount:
          type: integer
          description: The numeric amount of the refund in the shop currency.
          nullable: true
          minimum: 0
          example: 2500
        buyer_total_adjustment_amount:
          type: integer
          description: The numeric amount of the refund in the buyer currency.
          nullable: true
          minimum: 0
          example: 2500
        total_fee_adjustment_amount:
          type: integer
          description: The numeric amount of card processing fees associated with a payment adjustment.
          nullable: true
          minimum: 0
          example: 2500
        create_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        update_timestamp:
          type: integer
          description: The date and time of the last change to the payment adjustment in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The date and time of the last change to the payment adjustment in epoch seconds.
          minimum: 946684800
          example: 1758153645
        payment_adjustment_items:
          type: array
          description: List of payment adjustment line items.
          items:
            description: List of payment adjustment line items.
            oneOf:
              - $ref: '#/components/schemas/PaymentAdjustmentItem'
    PaymentAdjustmentItem:
      type: object
      x-resource-id: PaymentAdjustmentItem
      description: A payment adjustment line item for a payment adjustment.
      properties:
        payment_adjustment_id:
          type: integer
          description: The numeric ID for a payment adjustment.
          format: int64
          minimum: 1
          example: 1
        payment_adjustment_item_id:
          type: integer
          description: Unique ID for the adjustment line item.
          format: int64
          minimum: 1
          example: 1
        adjustment_type:
          type: string
          description: String indicating the type of adjustment for this line item.
          nullable: true
          example: example string
        amount:
          type: integer
          description: Integer value for the amount of the adjustment in original currency.
          default: 0
          example: 2500
        shop_amount:
          type: integer
          description: Integer value for the amount of the adjustment in currency for the shop.
          default: 0
          example: 2500
        transaction_id:
          type: integer
          description: The unique numeric ID for a transaction.
          format: int64
          nullable: true
          minimum: 1
          example: 345678901
        bill_payment_id:
          type: integer
          description: Unique ID for the bill payment adjustment.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        created_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The update date and time the payment adjustment in epoch seconds.
          minimum: 946684800
          example: 1758153645
    PaymentAccountLedgerEntries:
      type: object
      x-resource-id: PaymentAccountLedgerEntries
      description: A set of PaymentAccountLedgerEntry resources
      properties:
        count:
          type: integer
          description: The number of PaymentAccountLedgerEntry resources found.
          minimum: 0
          example: 1
        results:
          type: array
          description: The PaymentAccountLedgerEntry resources found.
          items:
            description: The PaymentAccountLedgerEntry resources found.
            oneOf:
              - $ref: '#/components/schemas/PaymentAccountLedgerEntry'
    Payments:
      type: object
      x-resource-id: Payments
      description: Represents several payments made with Etsy Payments. All monetary amounts are in USD pennies unless otherwise specified.
      properties:
        count:
          type: integer
          description: The number of payments in the response.
          minimum: 0
          example: 1
        results:
          type: array
          description: A list of payments.
          items:
            description: A list of payments.
            oneOf:
              - $ref: '#/components/schemas/Payment'
    Payment:
      type: object
      x-resource-id: Payment
      description: Represents a payment made with Etsy Payments. All monetary amounts are in USD pennies unless otherwise specified.
      properties:
        payment_id:
          type: integer
          description: A unique numeric ID for a payment to a specific Etsy [shop](/documentation/reference#tag/Shop).
          format: int64
          minimum: 1
          example: 1
        buyer_user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) who paid the purchase.
          format: int64
          minimum: 1
          example: 456789
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        receipt_id:
          type: integer
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          format: int64
          minimum: 1
          example: 234567890
        amount_gross:
          description: An integer equal to gross amount of the order, in pennies, including shipping and taxes.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        amount_fees:
          description: An integer equal to the original card processing fee of the order in pennies.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        amount_net:
          description: An integer equal to the payment value, in pennies, less fees (`amount_gross` - `amount_fees`).
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        posted_gross:
          description: The total gross value of the payment posted once the purchase ships. This is equal to the `amount_gross` UNLESS the seller issues a refund prior to shipping. We consider "shipping" to be the event which "posts" to the ledger. Therefore, if the seller refunds first, we reduce the `amount_gross` first and post then that amount. The seller never sees the refunded amount in their ledger. This is equal to the "Credit" amount in the ledger entry.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        posted_fees:
          description: The total value of the fees posted once the purchase ships. Etsy refunds a proportional amount of the fees when a seller refunds a buyer. When the seller issues a refund prior to shipping, the posted amount is less than the original.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        posted_net:
          description: The total value of the payment at the time of posting, less fees. (`posted_gross` - `posted_fees`)
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        adjusted_gross:
          description: The gross payment amount after the seller refunds a payment, partially or fully.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        adjusted_fees:
          description: The new fee amount after a seller refunds a payment, partially or fully.
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        adjusted_net:
          description: The total value of the payment after refunds, less fees (`adjusted_gross` - `adjusted_fees`).
          oneOf:
            - $ref: '#/components/schemas/Money'
          nullable: true
          example: example
        currency:
          type: string
          description: The ISO (alphabetic) code string for the payment's currency.
          example: example string
        shop_currency:
          type: string
          description: The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.
          nullable: true
          example: example string
        buyer_currency:
          type: string
          description: The currency string of the buyer.
          nullable: true
          example: example string
        shipping_user_id:
          type: integer
          description: The numeric ID of the user to which the seller ships the order.
          format: int64
          nullable: true
          minimum: 1
          example: 456789
        shipping_address_id:
          type: integer
          description: The numeric id identifying the shipping address.
          format: int64
          minimum: 1
          example: 1
        billing_address_id:
          type: integer
          description: The numeric ID identifying the billing address of the buyer.
          minimum: 0
          maximum: 9223372036854775807
          example: 1
        status:
          type: string
          description: A string indicating the current status of the payment, most commonly "settled" or "authed".
          example: example string
        shipped_timestamp:
          type: integer
          description: The transaction's shipping date and time, in epoch seconds.
          nullable: true
          minimum: 946684800
          example: 1758153645
        create_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The transaction's creation date and time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        update_timestamp:
          type: integer
          description: The date and time of the last change to the payment adjustment in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The date and time of the last change to the payment adjustment in epoch seconds.
          minimum: 946684800
          example: 1758153645
        payment_adjustments:
          type: array
          description: List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.
          items:
            description: List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.
            oneOf:
              - $ref: '#/components/schemas/PaymentAdjustment'
    Pong:
      type: object
      x-resource-id: Pong
      description: A confirmation that the current application has access to the Open API
      properties:
        application_id:
          type: integer
          description: The authenticated application's ID
          format: int64
          minimum: 1
          example: 1
    ShopReceipt:
      type: object
      x-resource-id: ShopReceipt
      description: The record of a purchase from a shop. Shop receipts display monetary values using the shop's currency.
      properties:
        receipt_id:
          type: integer
          description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
          format: int64
          minimum: 1
          example: 234567890
        receipt_type:
          type: integer
          description: 'The numeric value for the Etsy channel that serviced the purchase: 0 or 5 for Etsy.com, 1 for a Pattern shop.'
          minimum: 0
          example: 1
        seller_user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) (seller) fulfilling the purchase.
          format: int64
          minimum: 1
          example: 456789
        seller_email:
          type: string
          description: The email address string for the seller of the listing.
          format: email
          nullable: true
          example: seller@example.com
        buyer_user_id:
          type: integer
          description: The numeric ID for the [user](/documentation/reference#tag/User) making the purchase.
          format: int64
          minimum: 1
          example: 456789
        buyer_email:
          type: string
          description: The email address string for the buyer of the listing. It will be null if access hasn't been granted. Access is case-by-case and subject to approval.
          nullable: true
          example: seller@example.com
        name:
          type: string
          description: The name string for the recipient in the shipping address.
          example: Handmade Ceramic Mug
        first_line:
          type: string
          description: The first address line string for the recipient in the shipping address.
          nullable: true
          example: 123 Main St
        second_line:
          type: string
          description: The optional second address line string for the recipient in the shipping address.
          nullable: true
          example: Apt 4B
        city:
          type: string
          description: The city string for the recipient in the shipping address.
          nullable: true
          example: Brooklyn
        state:
          type: string
          description: The state string for the recipient in the shipping address.
          nullable: true
          example: example string
        zip:
          type: string
          description: The zip code string (not necessarily a number) for the recipient in the shipping address.
          nullable: true
          example: '11201'
        status:
          type: string
          description: 'The current order status string. One of: `paid`, `completed`, `open`, `payment processing` or `canceled`.'
          enum:
            - paid
            - completed
            - open
            - payment processing
            - canceled
            - fully refunded
            - partially refunded
          example: paid
        formatted_address:
          type: string
          description: The formatted shipping address string for the recipient in the shipping address.
          nullable: true
          example: example string
        country_iso:
          type: string
          description: The ISO-3166 alpha-2 country code string for the recipient in the shipping address.
          nullable: true
          example: US
        payment_method:
          type: string
          description: "The payment method string identifying purchaser's payment method, which must be one of: 'cc' (credit card), 'paypal', 'check', 'mo' (money order), 'bt' (bank transfer), 'other', 'ideal', 'sofort', 'apple_pay', 'google', 'android_pay', 'google_pay', 'klarna', 'k_pay_in_4' (klarna), 'k_pay_in_3' (klarna), or 'k_financing' (klarna)."
          example: example string
        payment_email:
          type: string
          description: The email address string for the email address to which to send payment confirmation
          nullable: true
          example: seller@example.com
        message_from_seller:
          type: string
          description: An optional message string from the seller.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        message_from_buyer:
          type: string
          description: An optional message string from the buyer.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        message_from_payment:
          type: string
          description: The machine-generated acknowledgement string from the payment system.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        is_paid:
          type: boolean
          description: When true, buyer paid for this purchase.
          example: true
        is_shipped:
          type: boolean
          description: When true, seller shipped the products.
          example: true
        create_timestamp:
          type: integer
          description: The receipt's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The receipt's creation time, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        update_timestamp:
          type: integer
          description: The time of the last update to the receipt, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The time of the last update to the receipt, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        is_gift:
          type: boolean
          description: When true, the buyer indicated this purchase is a gift.
          example: true
        gift_message:
          type: string
          description: A gift message string the buyer requests delivered with the product.
          example: Thanks for your order! Shipping out tomorrow.
        gift_sender:
          type: string
          description: The name of the person who sent the gift.
          example: example string
        grandtotal:
          description: A number equal to the total_price minus the coupon discount plus tax and shipping costs.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        subtotal:
          description: A number equal to the total_price minus coupon discounts. Does not include tax or shipping costs.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        total_price:
          description: A number equal to the sum of the individual listings' (price * quantity). Does not include tax or shipping costs.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        total_shipping_cost:
          description: A number equal to the total shipping cost of the receipt.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        total_tax_cost:
          description: The total sales tax of the receipt.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        total_vat_cost:
          description: A number equal to the total value-added tax (VAT) of the receipt.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        discount_amt:
          description: The numeric total discounted price for the receipt when using a discount (percent or fixed) coupon. Free shipping coupons are not included in this discount amount.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        gift_wrap_price:
          description: The numeric price of gift wrap for this receipt.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        shipments:
          type: array
          description: A list of shipment statements for this receipt.
          items:
            description: A list of shipment statements for this receipt.
            oneOf:
              - $ref: '#/components/schemas/ShopReceiptShipment'
        transactions:
          type: array
          description: Array of transactions for the receipt.
          items:
            description: Array of transactions for the receipt.
            oneOf:
              - $ref: '#/components/schemas/ShopReceiptTransaction'
        refunds:
          type: array
          description: Refunds for a given receipt.
          items:
            description: Refunds for a given receipt.
            oneOf:
              - $ref: '#/components/schemas/ShopRefund'
    ShopReceiptShipment:
      type: object
      x-resource-id: ShopReceiptShipment
      description: The record of one shipment event for a ShopReceipt. A receipt may have many ShopReceiptShipment records.
      properties:
        receipt_shipping_id:
          type: integer
          description: The unique numeric ID of a Shop Receipt Shipment record.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        shipment_notification_timestamp:
          type: integer
          description: The time at which Etsy notified the buyer of the shipment event, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        carrier_name:
          type: string
          description: The name string for the carrier/company responsible for delivering the shipment.
          example: usps
        tracking_code:
          type: string
          description: The tracking code string provided by the carrier/company for the shipment.
          example: 1Z999AA10123456784
    ShopRefund:
      type: object
      x-resource-id: ShopRefund
      description: The refund record for a receipt.
      properties:
        amount:
          description: A number equal to the refund total.
          oneOf:
            - $ref: '#/components/schemas/Money'
          example: example
        created_timestamp:
          type: integer
          description: The date & time of the refund, in epoch seconds.
          minimum: 946684800
          example: 1758153645
        reason:
          type: string
          description: The reason string given for the refund.
          nullable: true
          example: example string
        note_from_issuer:
          type: string
          description: The note string created by the refund issuer.
          nullable: true
          example: Thanks for your order! Shipping out tomorrow.
        status:
          type: string
          description: The status indication string for the refund.
          nullable: true
          example: example string
    ShopReceipts:
      type: object
      x-resource-id: ShopReceipts
      description: The receipts for a specific Shop.
      properties:
        count:
          type: integer
          description: The number of Shop Receipts found.
          example: 1
        results:
          type: array
          description: List of Shop Receipt resources found, with all Shop Receipt fields for each resource.
          items:
            description: List of Shop Receipt resources found, with all Shop Receipt fields for each resource.
            oneOf:
              - $ref: '#/components/schemas/ShopReceipt'
    ListingReviews:
      type: object
      x-resource-id: ListingReviews
      description: A set of listing review records left by Users.
      properties:
        count:
          type: integer
          description: The number of TransactionReview resources found.
          minimum: 0
          example: 1
        results:
          type: array
          description: The TransactionReview resources found.
          items:
            description: The TransactionReview resources found.
            oneOf:
              - $ref: '#/components/schemas/ListingReview'
    ListingReview:
      type: object
      x-resource-id: ListingReview
      description: A listing review record left by a User.
      properties:
        shop_id:
          type: integer
          description: The shop's numeric ID.
          format: int64
          minimum: 1
          example: 123456
        listing_id:
          type: integer
          description: The ID of the ShopListing that the TransactionReview belongs to.
          format: int64
          minimum: 1
          example: 123456789
        rating:
          type: integer
          description: Rating value on scale from 1 to 5
          minimum: 1
          maximum: 5
          example: 5
        review:
          type: string
          description: A message left by the author, explaining the feedback, if provided.
          nullable: true
          example: example string
        language:
          type: string
          description: The language of the TransactionReview
          example: en-US
        image_url_fullxfull:
          type: string
          description: "The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings."
          nullable: true
          example: https://www.etsy.com/listing/123456789
        create_timestamp:
          type: integer
          description: The date and time the TransactionReview was created in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The date and time the TransactionReview was created in epoch seconds.
          minimum: 946684800
          example: 1758153645
        update_timestamp:
          type: integer
          description: The date and time the TransactionReview was updated in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The date and time the TransactionReview was updated in epoch seconds.
          minimum: 946684800
          example: 1758153645
    TransactionReviews:
      type: object
      x-resource-id: TransactionReviews
      description: A set of transaction review records left by Users.
      properties:
        count:
          type: integer
          description: The number of TransactionReview resources found.
          minimum: 0
          example: 1
        results:
          type: array
          description: The TransactionReview resources found.
          items:
            description: The TransactionReview resources found.
            oneOf:
              - $ref: '#/components/schemas/TransactionReview'
    TransactionReview:
      type: object
      x-resource-id: TransactionReview
      description: A transaction review record left by a User.
      properties:
        shop_id:
          type: integer
          description: The shop's numeric ID.
          format: int64
          minimum: 1
          example: 123456
        listing_id:
          type: integer
          description: The ID of the ShopListing that the TransactionReview belongs to.
          format: int64
          minimum: 1
          example: 123456789
        transaction_id:
          type: integer
          description: The ID of the ShopReceipt Transaction that the TransactionReview belongs to.
          format: int64
          minimum: 1
          example: 345678901
        buyer_user_id:
          type: integer
          description: "The numeric ID of the user who was the buyer in this transaction. Note: This field may be absent, depending on the buyer's privacy settings."
          format: int64
          nullable: true
          minimum: 1
          example: 456789
        rating:
          type: integer
          description: Rating value on scale from 1 to 5
          minimum: 1
          maximum: 5
          example: 5
        review:
          type: string
          description: A message left by the author, explaining the feedback, if provided.
          default: ''
          example: example string
        language:
          type: string
          description: The language of the TransactionReview
          example: en-US
        image_url_fullxfull:
          type: string
          description: "The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings."
          nullable: true
          example: https://www.etsy.com/listing/123456789
        create_timestamp:
          type: integer
          description: The date and time the TransactionReview was created in epoch seconds.
          minimum: 946684800
          example: 1758153645
        created_timestamp:
          type: integer
          description: The date and time the TransactionReview was created in epoch seconds.
          minimum: 946684800
          example: 1758153645
        update_timestamp:
          type: integer
          description: The date and time the TransactionReview was updated in epoch seconds.
          minimum: 946684800
          example: 1758153645
        updated_timestamp:
          type: integer
          description: The date and time the TransactionReview was updated in epoch seconds.
          minimum: 946684800
          example: 1758153645
    SellerTaxonomyNodes:
      type: object
      x-resource-id: SellerTaxonomyNodes
      description: A list of taxonomy nodes from the seller taxonomy tree.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/SellerTaxonomyNode'
    SellerTaxonomyNode:
      type: object
      x-resource-id: SellerTaxonomyNode
      description: A taxonomy node in the seller taxonomy tree.
      properties:
        id:
          type: integer
          description: "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\"."
          format: int64
          minimum: 1
          example: 1
        level:
          type: integer
          description: The integer depth of this taxonomy node in the seller taxonomy tree, with roots at level 0.
          minimum: 0
          example: 1
        name:
          type: string
          description: The name string for this taxonomy node.
          example: Handmade Ceramic Mug
        parent_id:
          type: integer
          description: The numeric taxonomy ID of the parent of this node.
          format: int64
          nullable: true
          minimum: 1
          default:
          example: 1
        children:
          type: array
          description: An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxonomy tree.
          items:
            description: An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxonomy tree.
            oneOf:
              - $ref: '#/components/schemas/SellerTaxonomyNode'
        full_path_taxonomy_ids:
          type: array
          description: An array of `taxonomy_id`s including this node and all of its direct parents in the seller taxonomy tree up to a root node. They are listed in order from root to leaf.
          items:
            type: integer
            format: int64
            minimum: 1
    TaxonomyNodeProperties:
      type: object
      x-resource-id: TaxonomyNodeProperties
      description: A list of product property definitions.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/TaxonomyNodeProperty'
    TaxonomyNodeProperty:
      type: object
      x-resource-id: TaxonomyNodeProperty
      description: A product property definition.
      properties:
        property_id:
          type: integer
          description: The unique numeric ID of this product property.
          format: int64
          minimum: 1
          example: 1
        name:
          type: string
          description: The name string for this taxonomy node.
          example: Handmade Ceramic Mug
        display_name:
          type: string
          description: The human-readable product property name string.
          example: Handmade Ceramic Mug
        scales:
          type: array
          description: A list of available scales.
          items:
            description: A list of available scales.
            oneOf:
              - $ref: '#/components/schemas/TaxonomyPropertyScale'
        is_required:
          type: boolean
          description: When true, listings assigned eligible taxonomy IDs require this property.
          example: true
        supports_attributes:
          type: boolean
          description: When true, you can use this property in listing properties.
          example: true
        supports_variations:
          type: boolean
          description: When true, you can use this property in listing inventory.
          example: true
        is_multivalued:
          type: boolean
          description: When true, you can assign multiple property values to this property
          example: true
        max_values_allowed:
          type: integer
          description: When true, you can assign multiple property values to this property
          nullable: true
          example: 1
        possible_values:
          type: array
          description: A list of supported property value strings for this property.
          items:
            description: A list of supported property value strings for this property.
            oneOf:
              - $ref: '#/components/schemas/TaxonomyPropertyValue'
        selected_values:
          type: array
          description: A list of property value strings automatically and always selected for the given property.
          items:
            description: A list of property value strings automatically and always selected for the given property.
            oneOf:
              - $ref: '#/components/schemas/TaxonomyPropertyValue'
    TaxonomyPropertyScale:
      type: object
      x-resource-id: TaxonomyPropertyScale
      description: A scale defining the assignable increments for the property values available to specific product properties.
      properties:
        scale_id:
          type: integer
          description: The unique numeric ID of a scale.
          format: int64
          minimum: 1
          example: 1
        display_name:
          type: string
          description: The name string for a scale.
          example: Handmade Ceramic Mug
        description:
          type: string
          description: The description string for a scale.
          example: Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio.
    TaxonomyPropertyValue:
      type: object
      x-resource-id: TaxonomyPropertyValue
      description: A property value for a specific product property, which may also employ a specific scale.
      properties:
        value_id:
          type: integer
          description: The numeric ID of this property value.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        name:
          type: string
          description: The name string of this property value.
          example: Handmade Ceramic Mug
        scale_id:
          type: integer
          description: The numeric scale ID of the scale to which this property value belongs.
          format: int64
          nullable: true
          minimum: 1
          example: 1
        equal_to:
          type: array
          description: A list of numeric property value IDs this property value is equal to (if any).
          items:
            type: integer
            minimum: 0
    ShippingCarriers:
      type: object
      x-resource-id: ShippingCarriers
      description: Represents several ShippingCarriers.
      properties:
        count:
          type: integer
          minimum: 0
          example: 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ShippingCarrier'
    ShippingCarrier:
      type: object
      x-resource-id: ShippingCarrier
      description: A supported shipping carrier, which is used to calculate an Estimated Delivery Date.
      properties:
        shipping_carrier_id:
          type: integer
          description: The numeric ID of this shipping carrier.
          format: int64
          minimum: 1
          example: 1
        name:
          type: string
          description: The name of this shipping carrier.
          example: Handmade Ceramic Mug
        domestic_classes:
          type: array
          description: Set of domestic mail classes of this shipping carrier.
          items:
            description: Set of domestic mail classes of this shipping carrier.
            oneOf:
              - $ref: '#/components/schemas/ShippingCarrierMailClass'
        international_classes:
          type: array
          description: Set of international mail classes of this shipping carrier.
          items:
            description: Set of international mail classes of this shipping carrier.
            oneOf:
              - $ref: '#/components/schemas/ShippingCarrierMailClass'
    ShippingCarrierMailClass:
      type: object
      x-resource-id: ShippingCarrierMailClass
      description: A shipping carrier's mail class, which is used to calculate an Estimated Delivery Date.
      properties:
        mail_class_key:
          type: string
          description: The unique identifier of this mail class.
          example: example string
        name:
          type: string
          description: The name of this mail class.
          example: Handmade Ceramic Mug
    ShopHolidayPreference:
      type: object
      x-resource-id: ShopHolidayPreference
      description: Represents a shop's holiday preference
      properties:
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        holiday_id:
          type: integer
          description: 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
          enum:
            - 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
          example: 1
        country_iso:
          type: string
          description: The country ISO where the shop is located.
          format: ISO 3166-1 alpha-2
          example: US
        is_working:
          type: boolean
          description: A boolean value for whether the shop will process orders on a particular holiday.
          example: true
        holiday_name:
          type: string
          description: The name of the holiday that a country observes.
          example: Handmade Ceramic Mug
    Shops:
      type: object
      x-resource-id: Shops
      description: A set of Shop records.
      properties:
        count:
          type: integer
          description: The total number of Shops
          minimum: 0
          example: 1
        results:
          type: array
          description: The Shop resources.
          items:
            description: The Shop resources.
            oneOf:
              - $ref: '#/components/schemas/Shop'
    ShopReturnPolicy:
      type: object
      x-resource-id: ShopReturnPolicy
      description: Represents a listing-level return policy.
      properties:
        return_policy_id:
          type: integer
          description: The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).
          format: int64
          minimum: 1
          example: 1
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        accepts_returns:
          type: boolean
          description: return_policy_accepts_returns
          example: true
        accepts_exchanges:
          type: boolean
          description: return_policy_accepts_exchanges
          example: true
        return_deadline:
          type: integer
          description: 'The deadline for the Return Policy, measured in days. The value must be one of the following: [7, 14, 21, 30, 45, 60, 90].'
          nullable: true
          example: 1
    ShopReturnPolicies:
      type: object
      x-resource-id: ShopReturnPolicies
      description: Represents a shop's listing-level return policies list.
      properties:
        count:
          type: integer
          minimum: 0
          example: 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ShopReturnPolicy'
    ShopProductionPartners:
      type: object
      x-resource-id: ShopProductionPartners
      description: Represents a list of shop production partners.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/ShopProductionPartner'
    ShopProcessingProfile:
      type: object
      x-resource-id: ShopProcessingProfile
      description: Represents a processing profile to set a product offering's readiness state and processing time info.
      properties:
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456
        readiness_state_id:
          type: integer
          description: 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.
          format: int64
          minimum: 1
          example: 1
        readiness_state:
          type: string
          description: 'The readiness state of a product: \"1\" means \"ready_to_ship\", and \"2\" means \"made_to_order\"'
          enum:
            - ready_to_ship
            - made_to_order
          example: ready_to_ship
        min_processing_days:
          type: integer
          description: The minimum number of days for processing a specific product.
          minimum: 0
          example: 1
        max_processing_days:
          type: integer
          description: The maximum number of days for processing a specific product.
          minimum: 0
          example: 1
        processing_days_display_label:
          type: string
          description: Translated display label string for processing days, for example "3 - 5 days".
          example: example string
    ShopProcessingProfiles:
      type: object
      x-resource-id: ShopProcessingProfiles
      description: Represents several ProcessingProfiles.
      properties:
        count:
          type: integer
          minimum: 0
          example: 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ShopProcessingProfile'
    ShopSection:
      type: object
      x-resource-id: ShopSection
      description: A section within a shop, into which a user can sort listings.
      properties:
        shop_section_id:
          type: integer
          description: The numeric ID of a section in a specific Etsy shop.
          format: int64
          minimum: 1
          example: 1
        title:
          type: string
          description: The title string for a shop section.
          example: Handmade Ceramic Mug — Stoneware
        rank:
          type: integer
          description: The positive non-zero numeric position of this section in the section display order for a shop, with rank 1 sections appearing first.
          minimum: 0
          example: 1
        user_id:
          type: integer
          description: The numeric ID of the [user](/documentation/reference#tag/User) who owns this shop section.
          format: int64
          minimum: 1
          example: 456789
        active_listing_count:
          type: integer
          description: The number of active listings in one section of a specific Etsy shop.
          minimum: 0
          example: 1
    ShopSections:
      type: object
      x-resource-id: ShopSections
      description: All the sections in a specific Shop.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/ShopSection'
    ShopShippingProfileDestinations:
      type: object
      x-resource-id: ShopShippingProfileDestinations
      description: Represents a list of shipping destination objects.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/ShopShippingProfileDestination'
    ShopShippingProfiles:
      type: object
      x-resource-id: ShopShippingProfiles
      description: Represents several ShopShippingProfiles.
      properties:
        count:
          type: integer
          minimum: 0
          example: 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ShopShippingProfile'
    ShopShippingProfileUpgrades:
      type: object
      x-resource-id: ShopShippingProfileUpgrades
      description: A list of shipping upgrade options.
      properties:
        count:
          type: integer
          description: The number of results.
          minimum: 0
          example: 1
        results:
          type: array
          description: The list of requested resources.
          items:
            description: The list of requested resources.
            oneOf:
              - $ref: '#/components/schemas/ShopShippingProfileUpgrade'
    Scopes:
      type: object
      x-resource-id: Scopes
      description: A list of scopes allowed for the token.
      properties: {}
    UserAddress:
      type: object
      x-resource-id: UserAddress
      description: Represents a user's address.
      properties:
        user_address_id:
          type: integer
          description: The numeric ID of the user's address.
          format: int64
          minimum: 1
          example: 1
        user_id:
          type: integer
          description: The user's numeric ID.
          format: int64
          minimum: 1
          example: 456789
        name:
          type: string
          description: The user's name for this address.
          example: Handmade Ceramic Mug
        first_line:
          type: string
          description: The first line of the user's address.
          example: 123 Main St
        second_line:
          type: string
          description: The second line of the user's address.
          nullable: true
          example: Apt 4B
        city:
          type: string
          description: The city field of the user's address.
          example: Brooklyn
        state:
          type: string
          description: The state field of the user's address.
          nullable: true
          example: example string
        zip:
          type: string
          description: The zip code field of the user's address.
          nullable: true
          example: '11201'
        iso_country_code:
          type: string
          description: The ISO code of the country in this address.
          nullable: true
          example: US
        country_name:
          type: string
          description: The name of the user's country.
          nullable: true
          example: US
        is_default_shipping_address:
          type: boolean
          description: Is this the user's default shipping address.
          example: true
    UserAddresses:
      type: object
      x-resource-id: UserAddresses
      description: Represents several UserAddress records.
      properties:
        count:
          type: integer
          description: The number of UserAddress records being returned.
          minimum: 0
          example: 1
        results:
          type: array
          description: An array of UserAddress resources.
          items:
            description: An array of UserAddress resources.
            oneOf:
              - $ref: '#/components/schemas/UserAddress'
    Self:
      type: object
      x-resource-id: Self
      description: Represents a single user of the site
      properties:
        user_id:
          type: integer
          description: The numeric ID of a user. This number is also a valid shop ID for the user's shop.
          format: int64
          minimum: 1
          example: 456789
        shop_id:
          type: integer
          description: The unique positive non-zero numeric ID for an Etsy Shop.
          format: int64
          minimum: 1
          example: 123456