Skip to content

ChannelsApi.md

Latest commit

 

History

History
778 lines (582 loc) · 20.7 KB

ChannelsApi.md

File metadata and controls

778 lines (582 loc) · 20.7 KB

Flipdish.Api.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 (string appId, int? channelId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AssignAppIdToSalesChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 

            try
            {
                Object result = apiInstance.AssignAppIdToSalesChannel(appId, channelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.AssignAppIdToSalesChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
channelId 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 (int? storeId, string appId, int? channelId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AssignStoreToChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var storeId = 56;  // int? | 
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 

            try
            {
                Object result = apiInstance.AssignStoreToChannel(storeId, appId, channelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.AssignStoreToChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
appId string
channelId 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 (string appId, int? channelId, int? storeId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AttachStoreToSalesChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 
            var storeId = 56;  // int? | 

            try
            {
                Object result = apiInstance.AttachStoreToSalesChannel(appId, channelId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.AttachStoreToSalesChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
channelId int?
storeId 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 (string appId, int? channelId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DetachAllStoresFromSalesChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 

            try
            {
                Object result = apiInstance.DetachAllStoresFromSalesChannel(appId, channelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.DetachAllStoresFromSalesChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
channelId 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 (string appId, int? channelId, int? storeId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DetachStoreFromSalesChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 
            var storeId = 56;  // int? | 

            try
            {
                Object result = apiInstance.DetachStoreFromSalesChannel(appId, channelId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.DetachStoreFromSalesChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
channelId int?
storeId 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

RestApiArrayResultChannel GetAssignedChannels (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetAssignedChannelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultChannel result = apiInstance.GetAssignedChannels(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.GetAssignedChannels: " + e.Message );
            }
        }
    }
}

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

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

GetAvailableChannels

RestApiArrayResultChannel GetAvailableChannels (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetAvailableChannelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultChannel result = apiInstance.GetAvailableChannels(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.GetAvailableChannels: " + e.Message );
            }
        }
    }
}

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

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

GetChannel

RestApiResultChannel GetChannel (int? id, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var id = 56;  // int? | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultChannel result = apiInstance.GetChannel(id, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.GetChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id int?
appId string

Return type

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

RestApiArrayResultChannel GetChannels (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetChannelsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultChannel result = apiInstance.GetChannels(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.GetChannels: " + e.Message );
            }
        }
    }
}

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

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

GetStoresAssignedToChannel

RestApiArrayResultStoreChannelAssignment GetStoresAssignedToChannel (string appId, int? channelId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetStoresAssignedToChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 

            try
            {
                RestApiArrayResultStoreChannelAssignment result = apiInstance.GetStoresAssignedToChannel(appId, channelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.GetStoresAssignedToChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
channelId int?

Return type

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

Response GetStoresBySalesChannel (string appId, int? channelId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetStoresBySalesChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 

            try
            {
                Response result = apiInstance.GetStoresBySalesChannel(appId, channelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.GetStoresBySalesChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
channelId int?

Return type

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 (int? storeId, string appId, int? channelId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UnassignStoreFromChannelExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChannelsApi();
            var storeId = 56;  // int? | 
            var appId = appId_example;  // string | 
            var channelId = 56;  // int? | 

            try
            {
                Object result = apiInstance.UnassignStoreFromChannel(storeId, appId, channelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelsApi.UnassignStoreFromChannel: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
appId string
channelId 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]