ShopListingVariationImageApi.md

Swagger\Client\ShopListingVariationImageApi

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

Method	HTTP request	Description
getListingVariationImages	GET /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
updateVariationImages	POST /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images

getListingVariationImages

\Swagger\Client\Model\ListingVariationImages getListingVariationImages($shop_id, $listing_id)

General ReleaseReport bug

This endpoint is ready for production use.

Gets all variation images on a listing.

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\ShopListingVariationImageApi(
    // 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
);
$shop_id = 56; // int | The unique positive non-zero numeric ID for an Etsy Shop.
$listing_id = 56; // int | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.

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

Parameters

Name	Type	Description	Notes
shop_id	int	The unique positive non-zero numeric ID for an Etsy Shop.
listing_id	int	The numeric ID for the listing associated to this transaction.

Return type

\Swagger\Client\Model\ListingVariationImages

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]

updateVariationImages

\Swagger\Client\Model\ListingVariationImages updateVariationImages($shop_id, $listing_id, $body)

General ReleaseReport bug

This endpoint is ready for production use.

Creates variation images on a listing. `variation_images` is an array with inputs for the `property_id`, `value_id`, and `image_id` fields. `image_ids` are associated with a `ListingImage` on the listing associated with the provided `listing_id`. `property_id` and `value_id` pairs are associated with a `ListingProduct` on the listing associated with the provided `listing_id`. `variation_images` should not contain any duplicates. `variation_images` does not contain more than one `property_id` as variation images can only be associated on one property. The update overwrites all existing variation images on a listing, so if your request is successful, the variation images on the listing will be exactly those you specify.

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\ShopListingVariationImageApi(
    // 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
);
$shop_id = 56; // int | The unique positive non-zero numeric ID for an Etsy Shop.
$listing_id = 56; // int | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
$body = new \Swagger\Client\Model\ListingIdVariationimagesBody(); // \Swagger\Client\Model\ListingIdVariationimagesBody | 

try {
    $result = $apiInstance->updateVariationImages($shop_id, $listing_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShopListingVariationImageApi->updateVariationImages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
shop_id	int	The unique positive non-zero numeric ID for an Etsy Shop.
listing_id	int	The numeric ID for the listing associated to this transaction.
body	\Swagger\Client\Model\ListingIdVariationimagesBody		[optional]

Return type

\Swagger\Client\Model\ListingVariationImages

Authorization

api_key, oauth2

HTTP request headers

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

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