Etsy UserAddress API

openapi: 3.0.2
info:
  title: Etsy Open API v3 BuyerTaxonomy UserAddress API
  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: UserAddress
paths:
  /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>


        Open 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>


        Open 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>


        Open 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:
                    - null
        '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
components:
  schemas:
    ErrorSchema:
      type: object
      x-resource-id: ErrorSchema
      required:
      - error
      properties:
        error:
          type: string
          example: example string
    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'
  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
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