Skip to content

ChannelCatalogsProductsOptimisationApi.md

Latest commit

 

History

History
122 lines (86 loc) · 4.85 KB

ChannelCatalogsProductsOptimisationApi.md

File metadata and controls

122 lines (86 loc) · 4.85 KB

Swagger\Client\ChannelCatalogsProductsOptimisationApi

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

Method HTTP request Description
disableChannelCatalogProduct POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/disable Disable channel catalog product
reenableChannelCatalogProduct POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/reenable Reenable channel catalog product

disableChannelCatalogProduct

disableChannelCatalogProduct($channel_catalog_id, $product_id)

Disable channel catalog product

By default a all your catalog products are exposed to the channel. You can disable a product by using this operation. /!\ In case of massive optimisation we recommand you to use the analytics api

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\ChannelCatalogsProductsOptimisationApi(
    // 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
$product_id = "\"578419df-1bbf-41a6-96fa-862e42182b67\""; // string | The product identifier

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

Parameters

Name Type Description Notes
channel_catalog_id string The channel catalog identifier
product_id string The product 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]

reenableChannelCatalogProduct

reenableChannelCatalogProduct($channel_catalog_id, $product_id)

Reenable channel catalog product

By default a all your catalog products are exposed to the channel. You can reenable a product by using this operation. /!\ In case of massive optimisation we recommand you to use the analytics api

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\ChannelCatalogsProductsOptimisationApi(
    // 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
$product_id = "\"578419df-1bbf-41a6-96fa-862e42182b67\""; // string | The product identifier

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

Parameters

Name Type Description Notes
channel_catalog_id string The channel catalog identifier
product_id string The product 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]