Skip to content

ChannelsApi.md

Latest commit

 

History

History
610 lines (402 loc) · 14.8 KB

ChannelsApi.md

File metadata and controls

610 lines (402 loc) · 14.8 KB
Raw

Flipdish.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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
apiInstance.assignAppIdToSalesChannel(appId, channelId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
channelId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let storeId = 56; // Number | 
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
apiInstance.assignStoreToChannel(storeId, appId, channelId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
appId String
channelId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
let storeId = 56; // Number | 
apiInstance.attachStoreToSalesChannel(appId, channelId, storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
channelId Number
storeId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
apiInstance.detachAllStoresFromSalesChannel(appId, channelId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
channelId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
let storeId = 56; // Number | 
apiInstance.detachStoreFromSalesChannel(appId, channelId, storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
channelId Number
storeId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
apiInstance.getAssignedChannels(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
apiInstance.getAvailableChannels(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let id = 56; // Number | 
let appId = "appId_example"; // String | 
apiInstance.getChannel(id, appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
id Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
apiInstance.getChannels(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
apiInstance.getStoresAssignedToChannel(appId, channelId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
channelId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
apiInstance.getStoresBySalesChannel(appId, channelId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
channelId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ChannelsApi();
let storeId = 56; // Number | 
let appId = "appId_example"; // String | 
let channelId = 56; // Number | 
apiInstance.unassignStoreFromChannel(storeId, appId, channelId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
appId String
channelId Number

Return type

Object

Authorization

oauth2

HTTP request headers

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