etsy

UserAddressApi

All URIs are relative to https://openapi.etsy.com

Method	HTTP request	Description
deleteUserAddress	DELETE /v3/application/user/addresses/{user_address_id}
getUserAddress	GET /v3/application/user/addresses/{user_address_id}
getUserAddresses	GET /v3/application/user/addresses

deleteUserAddress

deleteUserAddress(userAddressId)

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

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = UserAddressApi()
val userAddressId : kotlin.Long = 789 // kotlin.Long | The numeric ID of the user's address.
try {
    apiInstance.deleteUserAddress(userAddressId)
} catch (e: ClientException) {
    println("4xx response calling UserAddressApi#deleteUserAddress")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UserAddressApi#deleteUserAddress")
    e.printStackTrace()
}

Parameters

| Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | userAddressId | kotlin.Long| The numeric ID of the user's address. | |

Return type

null (empty response body)

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserAddress

UserAddress getUserAddress(userAddressId)

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

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = UserAddressApi()
val userAddressId : kotlin.Long = 789 // kotlin.Long | The numeric ID of the user's address.
try {
    val result : UserAddress = apiInstance.getUserAddress(userAddressId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UserAddressApi#getUserAddress")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UserAddressApi#getUserAddress")
    e.printStackTrace()
}

Parameters

| Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | userAddressId | kotlin.Long| The numeric ID of the user's address. | |

Return type

UserAddress

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserAddresses

UserAddresses getUserAddresses(limit, offset)

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

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = UserAddressApi()
val limit : kotlin.Int = 56 // kotlin.Int | The maximum number of results to return.
val offset : kotlin.Int = 56 // kotlin.Int | The number of records to skip before selecting the first result.
try {
    val result : UserAddresses = apiInstance.getUserAddresses(limit, offset)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UserAddressApi#getUserAddresses")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UserAddressApi#getUserAddresses")
    e.printStackTrace()
}

Parameters

| limit | kotlin.Int| The maximum number of results to return. | [optional] [default to 25] | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | offset | kotlin.Int| The number of records to skip before selecting the first result. | [optional] [default to 0] |

Return type

UserAddresses

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

This site is open source. Improve this page.