Skip to content

Latest commit

 

History

History
244 lines (177 loc) · 11.6 KB

ShopListingVideoApi.md

File metadata and controls

244 lines (177 loc) · 11.6 KB

Swagger\Client\ShopListingVideoApi

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

Method HTTP request Description
deleteListingVideo DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}
getListingVideo GET /v3/application/listings/{listing_id}/videos/{video_id}
getListingVideos GET /v3/application/listings/{listing_id}/videos
uploadListingVideo POST /v3/application/shops/{shop_id}/listings/{listing_id}/videos

deleteListingVideo

deleteListingVideo($shop_id, $listing_id, $video_id)

General ReleaseReport bug

This endpoint is ready for production use.

Open API V3 endpoint to delete a listing video. A copy of the video remains on our servers, and so a deleted video may be re-associated with the listing without re-uploading the original video; see uploadListingVideo.

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\ShopListingVideoApi(
    // 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.
$video_id = 56; // int | The unique ID of a video associated with a listing.

try {
    $apiInstance->deleteListingVideo($shop_id, $listing_id, $video_id);
} catch (Exception $e) {
    echo 'Exception when calling ShopListingVideoApi->deleteListingVideo: ', $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.
video_id int The unique ID of a video associated with a listing.

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]

getListingVideo

\Swagger\Client\Model\ListingVideo getListingVideo($video_id, $listing_id)

General ReleaseReport bug

This endpoint is ready for production use.

Retrieves a single video associated with the given listing. Requesting a video from a listing returns an empty result.

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\ShopListingVideoApi(
    // 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
);
$video_id = 56; // int | The unique ID of a video associated with a listing.
$listing_id = 56; // int | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.

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

Parameters

Name Type Description Notes
video_id int The unique ID of a video associated with a listing.
listing_id int The numeric ID for the listing associated to this transaction.

Return type

\Swagger\Client\Model\ListingVideo

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]

getListingVideos

\Swagger\Client\Model\ListingVideos getListingVideos($listing_id)

General ReleaseReport bug

This endpoint is ready for production use.

Retrieves all listing video resources for a listing with a specific listing 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\ShopListingVideoApi(
    // 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
);
$listing_id = 56; // int | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.

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

Parameters

Name Type Description Notes
listing_id int The numeric ID for the listing associated to this transaction.

Return type

\Swagger\Client\Model\ListingVideos

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]

uploadListingVideo

\Swagger\Client\Model\ListingVideo uploadListingVideo($shop_id, $listing_id, $video_id, $video, $name)

General ReleaseReport bug

This endpoint is ready for production use.

Uploads a new video for a listing, or associates an existing video with a specific listing. You must either provide the `video_id` of an existing video, or the name and binary file data for a video to upload.

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\ShopListingVideoApi(
    // 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.
$video_id = 56; // int | 
$video = "video_example"; // string | 
$name = "name_example"; // string | 

try {
    $result = $apiInstance->uploadListingVideo($shop_id, $listing_id, $video_id, $video, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShopListingVideoApi->uploadListingVideo: ', $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.
video_id int [optional]
video string****string [optional]
name string [optional]

Return type

\Swagger\Client\Model\ListingVideo

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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