Skip to content

Latest commit

 

History

History
658 lines (474 loc) · 18.4 KB

ChannelsApi.md

File metadata and controls

658 lines (474 loc) · 18.4 KB

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(appId, channelId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
try {
    Object result = apiInstance.assignAppIdToSalesChannel(appId, channelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#assignAppIdToSalesChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
channelId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

assignStoreToChannel

Object assignStoreToChannel(storeId, appId, channelId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
Integer storeId = 56; // Integer | 
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
try {
    Object result = apiInstance.assignStoreToChannel(storeId, appId, channelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#assignStoreToChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer
appId String
channelId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

attachStoreToSalesChannel

Object attachStoreToSalesChannel(appId, channelId, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
Integer storeId = 56; // Integer | 
try {
    Object result = apiInstance.attachStoreToSalesChannel(appId, channelId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#attachStoreToSalesChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
channelId Integer
storeId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

detachAllStoresFromSalesChannel

Object detachAllStoresFromSalesChannel(appId, channelId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
try {
    Object result = apiInstance.detachAllStoresFromSalesChannel(appId, channelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#detachAllStoresFromSalesChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
channelId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

detachStoreFromSalesChannel

Object detachStoreFromSalesChannel(appId, channelId, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
Integer storeId = 56; // Integer | 
try {
    Object result = apiInstance.detachStoreFromSalesChannel(appId, channelId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#detachStoreFromSalesChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
channelId Integer
storeId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

getAssignedChannels

RestApiArrayResultChannel getAssignedChannels(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultChannel result = apiInstance.getAssignedChannels(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#getAssignedChannels");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultChannel

Authorization

oauth2

HTTP request headers

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

getAvailableChannels

RestApiArrayResultChannel getAvailableChannels(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultChannel result = apiInstance.getAvailableChannels(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#getAvailableChannels");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultChannel

Authorization

oauth2

HTTP request headers

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

getChannel

RestApiResultChannel getChannel(id, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
Integer id = 56; // Integer | 
String appId = "appId_example"; // String | 
try {
    RestApiResultChannel result = apiInstance.getChannel(id, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#getChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer
appId String

Return type

RestApiResultChannel

Authorization

oauth2

HTTP request headers

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

getChannels

RestApiArrayResultChannel getChannels(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultChannel result = apiInstance.getChannels(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#getChannels");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultChannel

Authorization

oauth2

HTTP request headers

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

getStoresAssignedToChannel

RestApiArrayResultStoreChannelAssignment getStoresAssignedToChannel(appId, channelId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
try {
    RestApiArrayResultStoreChannelAssignment result = apiInstance.getStoresAssignedToChannel(appId, channelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#getStoresAssignedToChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
channelId Integer

Return type

RestApiArrayResultStoreChannelAssignment

Authorization

oauth2

HTTP request headers

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

getStoresBySalesChannel

Response getStoresBySalesChannel(appId, channelId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
try {
    Response result = apiInstance.getStoresBySalesChannel(appId, channelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#getStoresBySalesChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
channelId Integer

Return type

Response

Authorization

oauth2

HTTP request headers

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

unassignStoreFromChannel

Object unassignStoreFromChannel(storeId, appId, channelId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.ChannelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ChannelsApi apiInstance = new ChannelsApi();
Integer storeId = 56; // Integer | 
String appId = "appId_example"; // String | 
Integer channelId = 56; // Integer | 
try {
    Object result = apiInstance.unassignStoreFromChannel(storeId, appId, channelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChannelsApi#unassignStoreFromChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer
appId String
channelId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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