BuyerTaxonomyApi.md

Swagger\Client\BuyerTaxonomyApi

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

Method	HTTP request	Description
getBuyerTaxonomyNodes	GET /v3/application/buyer-taxonomy/nodes
getPropertiesByBuyerTaxonomyId	GET /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties

getBuyerTaxonomyNodes

\Swagger\Client\Model\BuyerTaxonomyNodes getBuyerTaxonomyNodes()

General ReleaseReport bug

This endpoint is ready for production use.

Retrieves the full hierarchy tree of buyer taxonomy nodes.

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');

$apiInstance = new Swagger\Client\Api\BuyerTaxonomyApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\BuyerTaxonomyNodes

Authorization

api_key

HTTP request headers

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

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

getPropertiesByBuyerTaxonomyId

\Swagger\Client\Model\BuyerTaxonomyNodeProperties getPropertiesByBuyerTaxonomyId($taxonomy_id)

General ReleaseReport bug

This endpoint is ready for production use.

Retrieves a list of product properties, with applicable scales and values, supported for a specific buyer taxonomy ID.

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');

$apiInstance = new Swagger\Client\Api\BuyerTaxonomyApi(
    // 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
);
$taxonomy_id = 56; // int | 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\".

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

Parameters

Name	Type	Description	Notes
taxonomy_id	int	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".

Return type

\Swagger\Client\Model\BuyerTaxonomyNodeProperties

Authorization

api_key

HTTP request headers

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

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