Skip to content

Latest commit

 

History

History
297 lines (214 loc) · 13.1 KB

ShopSectionApi.md

File metadata and controls

297 lines (214 loc) · 13.1 KB

Swagger\Client\ShopSectionApi

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

Method HTTP request Description
createShopSection POST /v3/application/shops/{shop_id}/sections
deleteShopSection DELETE /v3/application/shops/{shop_id}/sections/{shop_section_id}
getShopSection GET /v3/application/shops/{shop_id}/sections/{shop_section_id}
getShopSections GET /v3/application/shops/{shop_id}/sections
updateShopSection PUT /v3/application/shops/{shop_id}/sections/{shop_section_id}

createShopSection

\Swagger\Client\Model\ShopSection createShopSection($shop_id, $title)

General ReleaseReport bug

This endpoint is ready for production use.

Creates a new section in a specific shop.

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\ShopSectionApi(
    // 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.
$title = "title_example"; // string | 

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

Parameters

Name Type Description Notes
shop_id int The unique positive non-zero numeric ID for an Etsy Shop.
title string [optional]

Return type

\Swagger\Client\Model\ShopSection

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

deleteShopSection

deleteShopSection($shop_id, $shop_section_id)

General ReleaseReport bug

This endpoint is ready for production use.

Deletes a section in a specific shop given a valid shop_section_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');
// Configure OAuth2 access token for authorization: oauth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ShopSectionApi(
    // 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.
$shop_section_id = 56; // int | The numeric ID of a section in a specific Etsy shop.

try {
    $apiInstance->deleteShopSection($shop_id, $shop_section_id);
} catch (Exception $e) {
    echo 'Exception when calling ShopSectionApi->deleteShopSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
shop_id int The unique positive non-zero numeric ID for an Etsy Shop.
shop_section_id int The numeric ID of a section in a specific Etsy shop.

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]

getShopSection

\Swagger\Client\Model\ShopSection getShopSection($shop_id, $shop_section_id)

General ReleaseReport bug

This endpoint is ready for production use.

Retrieves a shop section, referenced by section ID and shop 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\ShopSectionApi(
    // 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.
$shop_section_id = 56; // int | The numeric ID of a section in a specific Etsy shop.

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

Parameters

Name Type Description Notes
shop_id int The unique positive non-zero numeric ID for an Etsy Shop.
shop_section_id int The numeric ID of a section in a specific Etsy shop.

Return type

\Swagger\Client\Model\ShopSection

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]

getShopSections

\Swagger\Client\Model\ShopSections getShopSections($shop_id)

General ReleaseReport bug

This endpoint is ready for production use.

Retrieves the list of shop sections in a specific shop identified by shop 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\ShopSectionApi(
    // 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.

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

Parameters

Name Type Description Notes
shop_id int The unique positive non-zero numeric ID for an Etsy Shop.

Return type

\Swagger\Client\Model\ShopSections

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]

updateShopSection

\Swagger\Client\Model\ShopSection updateShopSection($shop_id, $shop_section_id, $title)

General ReleaseReport bug

This endpoint is ready for production use.

Updates a section in a specific shop given a valid shop_section_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');
// Configure OAuth2 access token for authorization: oauth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ShopSectionApi(
    // 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.
$shop_section_id = 56; // int | The numeric ID of a section in a specific Etsy shop.
$title = "title_example"; // string | 

try {
    $result = $apiInstance->updateShopSection($shop_id, $shop_section_id, $title);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShopSectionApi->updateShopSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
shop_id int The unique positive non-zero numeric ID for an Etsy Shop.
shop_section_id int The numeric ID of a section in a specific Etsy shop.
title string [optional]

Return type

\Swagger\Client\Model\ShopSection

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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