Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 3.06 KB

ListedProductsApi.md

File metadata and controls

74 lines (51 loc) · 3.06 KB
Raw

FriendsOfCE\Channel\ApiClient\ListedProductsApi

All URIs are relative to https://demo.channelengine.net/api, except if the operation defines another base path.

Method HTTP request Description
listedProductGetByFilter() GET /v2/channels/{channelId}/products Get Listed Products

listedProductGetByFilter()

listedProductGetByFilter($channelId, $merchantProductNos, $page): \FriendsOfCE\Channel\ApiClient\Model\CollectionOfChannelListedProductResponse

Get Listed Products

Gets the status of products listed for channel (export status) and on a channel (channel status).
Includes products that were previously deleted from but are now set to be created again.
In response most common identifiers are provided, like Ean, MerchantProductNo (sku)
and also ChannelProductNo which is unique product reference used by the Channel.
Note: not all channels provide adequate options to retrieve the status on the channel.

Example

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


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\ListedProductsApi(
    // 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
);
$channelId = 56; // int | The id of a channel
$merchantProductNos = array('merchantProductNos_example'); // string[] | The unique product references used by the Merchant (SKUs)
$page = 56; // int | The page to filter on. Starts at 1.

try {
    $result = $apiInstance->listedProductGetByFilter($channelId, $merchantProductNos, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListedProductsApi->listedProductGetByFilter: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
channelId int The id of a channel
merchantProductNos string[] The unique product references used by the Merchant (SKUs) [optional]
page int The page to filter on. Starts at 1. [optional]

Return type

\FriendsOfCE\Channel\ApiClient\Model\CollectionOfChannelListedProductResponse

Authorization

apiKey

HTTP request headers

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

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