Skip to content

Latest commit

 

History

History
223 lines (159 loc) · 8.46 KB

ChannelCatalogsCategoriesApi.md

File metadata and controls

223 lines (159 loc) · 8.46 KB

Swagger\Client\ChannelCatalogsCategoriesApi

All URIs are relative to https://api.beezup.com/v2

Method HTTP request Description
configureChannelCatalogCategory POST /user/channelCatalogs/{channelCatalogId}/categories/configure Configure channel catalog category
disableChannelCatalogCategoryMapping POST /user/channelCatalogs/{channelCatalogId}/categories/disableMapping Disable a channel catalog category mapping
getChannelCatalogCategories GET /user/channelCatalogs/{channelCatalogId}/categories Get channel catalog categories
reenableChannelCatalogCategoryMapping POST /user/channelCatalogs/{channelCatalogId}/categories/reenableMapping Reenable a channel catalog category mapping

configureChannelCatalogCategory

configureChannelCatalogCategory($channel_catalog_id, $request)

Configure channel catalog category

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\ChannelCatalogsCategoriesApi(
    // 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
);
$channel_catalog_id = "\"6d6b04de-406b-4539-8e7e-bf3e8da5dfb0\""; // string | The channel catalog identifier
$request = new \Swagger\Client\Model\ConfigureCategoryRequest(); // \Swagger\Client\Model\ConfigureCategoryRequest | 

try {
    $apiInstance->configureChannelCatalogCategory($channel_catalog_id, $request);
} catch (Exception $e) {
    echo 'Exception when calling ChannelCatalogsCategoriesApi->configureChannelCatalogCategory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
channel_catalog_id string The channel catalog identifier
request \Swagger\Client\Model\ConfigureCategoryRequest

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

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

disableChannelCatalogCategoryMapping

disableChannelCatalogCategoryMapping($channel_catalog_id)

Disable a channel catalog category mapping

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\ChannelCatalogsCategoriesApi(
    // 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
);
$channel_catalog_id = "\"6d6b04de-406b-4539-8e7e-bf3e8da5dfb0\""; // string | The channel catalog identifier

try {
    $apiInstance->disableChannelCatalogCategoryMapping($channel_catalog_id);
} catch (Exception $e) {
    echo 'Exception when calling ChannelCatalogsCategoriesApi->disableChannelCatalogCategoryMapping: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
channel_catalog_id string The channel catalog identifier

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

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

getChannelCatalogCategories

\Swagger\Client\Model\ChannelCatalogCategoryConfigurationList getChannelCatalogCategories($channel_catalog_id)

Get channel catalog categories

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\ChannelCatalogsCategoriesApi(
    // 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
);
$channel_catalog_id = "\"6d6b04de-406b-4539-8e7e-bf3e8da5dfb0\""; // string | The channel catalog identifier

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

Parameters

Name Type Description Notes
channel_catalog_id string The channel catalog identifier

Return type

\Swagger\Client\Model\ChannelCatalogCategoryConfigurationList

Authorization

api_key

HTTP request headers

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

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

reenableChannelCatalogCategoryMapping

reenableChannelCatalogCategoryMapping($channel_catalog_id)

Reenable a channel catalog category mapping

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\ChannelCatalogsCategoriesApi(
    // 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
);
$channel_catalog_id = "\"6d6b04de-406b-4539-8e7e-bf3e8da5dfb0\""; // string | The channel catalog identifier

try {
    $apiInstance->reenableChannelCatalogCategoryMapping($channel_catalog_id);
} catch (Exception $e) {
    echo 'Exception when calling ChannelCatalogsCategoriesApi->reenableChannelCatalogCategoryMapping: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
channel_catalog_id string The channel catalog identifier

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

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