Skip to content

Latest commit

 

History

History
179 lines (128 loc) · 7.78 KB

UserAddressApi.md

File metadata and controls

179 lines (128 loc) · 7.78 KB

Swagger\Client\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($user_address_id)

General ReleaseReport bug

This endpoint is ready for production use.

Open API V3 endpoint to delete a UserAddress for a User.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\UserAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_address_id = 56; // int | The numeric ID of the user's address.

try {
    $apiInstance->deleteUserAddress($user_address_id);
} catch (Exception $e) {
    echo 'Exception when calling UserAddressApi->deleteUserAddress: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_address_id int The numeric ID of the user's address.

Return type

void (empty response body)

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserAddress

\Swagger\Client\Model\UserAddress getUserAddress($user_address_id)

Feedback only Give feedback

Development for this endpoint is in progress. It will only return a 501 response.

Open API V3 endpoint to retrieve a UserAddress for a User.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\UserAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_address_id = 56; // int | The numeric ID of the user's address.

try {
    $result = $apiInstance->getUserAddress($user_address_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAddressApi->getUserAddress: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_address_id int The numeric ID of the user's address.

Return type

\Swagger\Client\Model\UserAddress

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserAddresses

\Swagger\Client\Model\UserAddresses getUserAddresses($limit, $offset)

General ReleaseReport bug

This endpoint is ready for production use.

Open API V3 endpoint to retrieve UserAddresses for a User.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\UserAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int | The maximum number of results to return.
$offset = 0; // int | The number of records to skip before selecting the first result.

try {
    $result = $apiInstance->getUserAddresses($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAddressApi->getUserAddresses: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Swagger\Client\Model\UserAddresses

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]