Flipdish\Client\ChannelsApi

All URIs are relative to https://api.flipdish.co

Method	HTTP request	Description
assignAppIdToSalesChannel	POST /api/v1.0/{appId}/channels/{channelId}/assign-appId
assignStoreToChannel	POST /api/v1.0/{appId}/channels/assign-store
attachStoreToSalesChannel	POST /api/v1.0/{appId}/channels/{channelId}/stores/{storeId}
detachAllStoresFromSalesChannel	DELETE /api/v1.0/{appId}/channels/{channelId}/stores
detachStoreFromSalesChannel	DELETE /api/v1.0/{appId}/channels/{channelId}/stores/{storeId}
getAssignedChannels	GET /api/v1.0/{appId}/channels/assigned-channels
getAvailableChannels	GET /api/v1.0/{appId}/channels/available-channels
getChannel	GET /api/v1.0/{appId}/channels/{id}
getChannels	GET /api/v1.0/{appId}/channels
getStoresAssignedToChannel	GET /api/v1.0/{appId}/channels/{channelId}/assigned-stores
getStoresBySalesChannel	GET /api/v1.0/{appId}/channels/{channelId}/stores
unassignStoreFromChannel	DELETE /api/v1.0/{appId}/channels/unassign-store

assignAppIdToSalesChannel

object assignAppIdToSalesChannel($app_id, $channel_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 

try {
    $result = $apiInstance->assignAppIdToSalesChannel($app_id, $channel_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->assignAppIdToSalesChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
channel_id	int

Return type

object

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

assignStoreToChannel

object assignStoreToChannel($store_id, $app_id, $channel_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$store_id = 56; // int | 
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 

try {
    $result = $apiInstance->assignStoreToChannel($store_id, $app_id, $channel_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->assignStoreToChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
store_id	int
app_id	string
channel_id	int

Return type

object

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

attachStoreToSalesChannel

object attachStoreToSalesChannel($app_id, $channel_id, $store_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 
$store_id = 56; // int | 

try {
    $result = $apiInstance->attachStoreToSalesChannel($app_id, $channel_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->attachStoreToSalesChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
channel_id	int
store_id	int

Return type

object

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

detachAllStoresFromSalesChannel

object detachAllStoresFromSalesChannel($app_id, $channel_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 

try {
    $result = $apiInstance->detachAllStoresFromSalesChannel($app_id, $channel_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->detachAllStoresFromSalesChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
channel_id	int

Return type

object

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

detachStoreFromSalesChannel

object detachStoreFromSalesChannel($app_id, $channel_id, $store_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 
$store_id = 56; // int | 

try {
    $result = $apiInstance->detachStoreFromSalesChannel($app_id, $channel_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->detachStoreFromSalesChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
channel_id	int
store_id	int

Return type

object

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getAssignedChannels

\Flipdish\Client\Models\RestApiArrayResultChannel getAssignedChannels($app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\RestApiArrayResultChannel

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getAvailableChannels

\Flipdish\Client\Models\RestApiArrayResultChannel getAvailableChannels($app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\RestApiArrayResultChannel

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getChannel

\Flipdish\Client\Models\RestApiResultChannel getChannel($id, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$id = 56; // int | 
$app_id = "app_id_example"; // string | 

try {
    $result = $apiInstance->getChannel($id, $app_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->getChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
app_id	string

Return type

\Flipdish\Client\Models\RestApiResultChannel

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getChannels

\Flipdish\Client\Models\RestApiArrayResultChannel getChannels($app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\RestApiArrayResultChannel

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getStoresAssignedToChannel

\Flipdish\Client\Models\RestApiArrayResultStoreChannelAssignment getStoresAssignedToChannel($app_id, $channel_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 

try {
    $result = $apiInstance->getStoresAssignedToChannel($app_id, $channel_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->getStoresAssignedToChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
channel_id	int

Return type

\Flipdish\Client\Models\RestApiArrayResultStoreChannelAssignment

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getStoresBySalesChannel

\Flipdish\Client\Models\Response getStoresBySalesChannel($app_id, $channel_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 

try {
    $result = $apiInstance->getStoresBySalesChannel($app_id, $channel_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->getStoresBySalesChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
channel_id	int

Return type

\Flipdish\Client\Models\Response

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

unassignStoreFromChannel

object unassignStoreFromChannel($store_id, $app_id, $channel_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\ChannelsApi(
    // 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
);
$store_id = 56; // int | 
$app_id = "app_id_example"; // string | 
$channel_id = 56; // int | 

try {
    $result = $apiInstance->unassignStoreFromChannel($store_id, $app_id, $channel_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->unassignStoreFromChannel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
store_id	int
app_id	string
channel_id	int

Return type

object

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

FilesExpand file tree

ChannelsApi.md

Latest commit

History

ChannelsApi.md

File metadata and controls

Flipdish\Client\ChannelsApi

assignAppIdToSalesChannel

Example

Parameters

Return type

Authorization

HTTP request headers

assignStoreToChannel

Example

Parameters

Return type

Authorization

HTTP request headers

attachStoreToSalesChannel

Example

Parameters

Return type

Authorization

HTTP request headers

detachAllStoresFromSalesChannel

Example

Parameters

Return type

Authorization

HTTP request headers

detachStoreFromSalesChannel

Example

Parameters

Return type

Authorization

HTTP request headers

getAssignedChannels

Example

Parameters

Return type

Authorization

HTTP request headers

getAvailableChannels

Example

Parameters

Return type

Authorization

HTTP request headers

getChannel

Example

Parameters

Return type

Authorization

HTTP request headers

getChannels

Example

Parameters

Return type

Authorization

HTTP request headers

getStoresAssignedToChannel

Example

Parameters

Return type

Authorization

HTTP request headers

getStoresBySalesChannel

Example

Parameters

Return type

Authorization

HTTP request headers

unassignStoreFromChannel

Example

Parameters

Return type

Authorization

HTTP request headers