Skip to content

StoreGroupsApi.md

Latest commit

 

History

History
525 lines (393 loc) · 15 KB

StoreGroupsApi.md

File metadata and controls

525 lines (393 loc) · 15 KB

Flipdish.Api.StoreGroupsApi

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

Method HTTP request Description
AssignStoresToStoreGroup POST /api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores
CreateStoreGroup POST /api/v1.0/{appNameId}/storegroups
GetStoreGroup GET /api/v1.0/storegroups/{storeGroupId}
GetStoreGroups GET /api/v1.0/{appNameId}/storegroups
GetStoreGroupsExtended GET /api/v1.0/{appNameId}/storegroups/extended
RemoveStoreGroup DELETE /api/v1.0/storegroups/{storeGroupId}
SetCustomerMessages POST /api/v1.0/storegroups/{storeGroupId}/CustomerMessages
UpdateStoreGroup POST /api/v1.0/storegroups/{storeGroupId}

AssignStoresToStoreGroup

void AssignStoresToStoreGroup (string appId, int? storeGroupId, List<int?> storeIds)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var appId = appId_example;  // string | 
            var storeGroupId = 56;  // int? | 
            var storeIds = ;  // List<int?> | 

            try
            {
                apiInstance.AssignStoresToStoreGroup(appId, storeGroupId, storeIds);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.AssignStoresToStoreGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeGroupId int?
storeIds List<int?>

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

CreateStoreGroup

RestApiResultStoreGroup CreateStoreGroup (string appNameId, StoreGroupBase storeGroup)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var appNameId = appNameId_example;  // string | 
            var storeGroup = new StoreGroupBase(); // StoreGroupBase | 

            try
            {
                RestApiResultStoreGroup result = apiInstance.CreateStoreGroup(appNameId, storeGroup);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.CreateStoreGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appNameId string
storeGroup StoreGroupBase

Return type

RestApiResultStoreGroup

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

GetStoreGroup

RestApiResultStoreGroup GetStoreGroup (int? storeGroupId)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var storeGroupId = 56;  // int? | 

            try
            {
                RestApiResultStoreGroup result = apiInstance.GetStoreGroup(storeGroupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.GetStoreGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeGroupId int?

Return type

RestApiResultStoreGroup

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]

GetStoreGroups

RestApiPaginationResultStoreGroup GetStoreGroups (string appNameId, string searchQuery = null, int? page = null, int? limit = null)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var appNameId = appNameId_example;  // string | 
            var searchQuery = searchQuery_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultStoreGroup result = apiInstance.GetStoreGroups(appNameId, searchQuery, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.GetStoreGroups: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appNameId string
searchQuery string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultStoreGroup

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]

GetStoreGroupsExtended

RestApiPaginationResultStoreGroupExtended GetStoreGroupsExtended (string appNameId, string searchQuery = null, int? page = null, int? limit = null, int? groupingRadius = null)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var appNameId = appNameId_example;  // string | 
            var searchQuery = searchQuery_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var groupingRadius = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultStoreGroupExtended result = apiInstance.GetStoreGroupsExtended(appNameId, searchQuery, page, limit, groupingRadius);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.GetStoreGroupsExtended: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appNameId string
searchQuery string [optional]
page int? [optional]
limit int? [optional]
groupingRadius int? [optional]

Return type

RestApiPaginationResultStoreGroupExtended

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]

RemoveStoreGroup

void RemoveStoreGroup (int? storeGroupId)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var storeGroupId = 56;  // int? | 

            try
            {
                apiInstance.RemoveStoreGroup(storeGroupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.RemoveStoreGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeGroupId int?

Return type

void (empty response body)

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]

SetCustomerMessages

void SetCustomerMessages (int? storeGroupId, CustomerMessages customerMessages)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var storeGroupId = 56;  // int? | 
            var customerMessages = new CustomerMessages(); // CustomerMessages | 

            try
            {
                apiInstance.SetCustomerMessages(storeGroupId, customerMessages);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.SetCustomerMessages: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeGroupId int?
customerMessages CustomerMessages

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

UpdateStoreGroup

RestApiResultStoreGroupBase UpdateStoreGroup (int? storeGroupId, StoreGroupBase storeGroup)

Example

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

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

            var apiInstance = new StoreGroupsApi();
            var storeGroupId = 56;  // int? | 
            var storeGroup = new StoreGroupBase(); // StoreGroupBase | 

            try
            {
                RestApiResultStoreGroupBase result = apiInstance.UpdateStoreGroup(storeGroupId, storeGroup);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreGroupsApi.UpdateStoreGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeGroupId int?
storeGroup StoreGroupBase

Return type

RestApiResultStoreGroupBase

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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