Etsy · Schema

UserAddress

Represents a user's address.

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name	Type	Description
user_address_id	integer	The numeric ID of the user's address.
user_id	integer	The user's numeric ID.
name	string	The user's name for this address.
first_line	string	The first line of the user's address.
second_line	string	The second line of the user's address.
city	string	The city field of the user's address.
state	string	The state field of the user's address.
zip	string	The zip code field of the user's address.
iso_country_code	string	The ISO code of the country in this address.
country_name	string	The name of the user's country.
is_default_shipping_address	boolean	Is this the user's default shipping address.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UserAddress",
  "description": "Represents a user's address.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-user-address-schema.json",
  "type": "object",
  "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
    }
  }
}