Skip to content

Latest commit

 

History

History
2609 lines (1965 loc) · 77.6 KB

StoresApi.md

File metadata and controls

2609 lines (1965 loc) · 77.6 KB

Flipdish.Api.StoresApi

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

Method HTTP request Description
ArchiveStore POST /api/v1.0/stores/{storeId}/archive
AssignMenu POST /api/v1.0/stores/{storeId}/menu/{menuId}
CloneStore POST /api/v1.0/stores/{storeId}/clone
ConfigureStoreServiceCharge POST /api/v1.0/stores/{storeId}/servicecharge
CreateBusinessHoursOverrideByStoreId POST /api/v1.0/stores/{storeId}/businesshoursoverrides
CreateStore POST /api/v1.0/stores
CreateStoreInProperty POST /api/v1.0/properties/{propertyId}/stores
DeleteBusinessHoursOverride DELETE /api/v1.0/stores/{storeId}/businesshoursoverrides/{businessHoursOverrideId}
GetBankAccountForStore GET /api/v1.0/stores/{storeId}/bankaccount
GetBusinessHours GET /api/v1.0/stores/{storeId}/availability/{deliveryType}
GetBusinessHoursOverrideByStoreId GET /api/v1.0/stores/{storeId}/businesshoursoverrides
GetEndOfDayReport GET /api/v1.0/stores/{storeId}/endofdayreport
GetPreOrderConfig GET /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}
GetPreOrderPreview GET /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/preview
GetProcessingFeeConfigsByStoreId GET /api/v1.0/stores/{storeId}/processingfeeconfigs
GetProcessingFeeConfigsByStoreIdAndPaymentAccountType GET /api/v1.0/stores/{storeId}/processingfeeconfigs/{paymentAccountType}
GetStoreById GET /api/v1.0/stores/{storeId}
GetStoreDeliveryFeeConfig GET /api/v1.0/stores/{storeId}/feeConfig/deliveryZones
GetStoreFeeConfig GET /api/v1.0/stores/{storeId}/feeConfig
GetStoreHeadersByAppId GET /api/v1.0/{appId}/stores/header
GetStoreLeadTimes GET /api/v1.0/stores/{storeId}/leadTimes
GetStoreNetSales GET /api/v1.0/{appId}/stores/stats
GetStoreServiceCharge GET /api/v1.0/stores/{storeId}/servicecharge
GetStores GET /api/v1.0/stores
GetStoresByAppId GET /api/v1.0/{appId}/stores
GetStoresByStoreIdWithValidations GET /api/v1.0/{appId}/storevalidation/kiosk
PublishStore POST /api/v1.0/stores/{storeId}/publish
PutStoreDeliveryFeeConfig PUT /api/v1.0/stores/{storeId}/feeConfig/deliveryZones
SetBusinessHours POST /api/v1.0/stores/{storeId}/availability/{deliveryType}
SetPreOrdeEnabled POST /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/enabled
SetStoreCollectionSettings POST /api/v1.0/stores/{storeId}/collectionsettings
SetStoreLeadTimes POST /api/v1.0/stores/{storeId}/leadTimes
StoresSetPropertyId POST /api/v1.0/stores/{storeId}/propertyId/{propertyId}
SupportedSalesChannelsTypes POST /api/v1.0/properties/{propertyId}/stores/{storeId}/supportedSalesChannels
UnpublishStore POST /api/v1.0/stores/{storeId}/unpublish
UpdatePreOrderConfig POST /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}
UpdateStore POST /api/v1.0/stores/{storeId}
UpdateStoreAddress POST /api/v1.0/stores/{storeId}/address
UpdateStoreAddressCoordinates POST /api/v1.0/stores/{storeId}/address/coordinates
UpdateStoreAddressForm POST /api/v1.0/stores/{storeId}/addressform

ArchiveStore

void ArchiveStore (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                apiInstance.ArchiveStore(storeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.ArchiveStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId 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]

AssignMenu

RestApiArrayResultRestApiDefaultResponse AssignMenu (int? storeId, int? menuId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var menuId = 56;  // int? | 

            try
            {
                RestApiArrayResultRestApiDefaultResponse result = apiInstance.AssignMenu(storeId, menuId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.AssignMenu: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
menuId int?

Return type

RestApiArrayResultRestApiDefaultResponse

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]

CloneStore

RestApiResultStore CloneStore (int? storeId, StoreCloneSettings settings)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var settings = new StoreCloneSettings(); // StoreCloneSettings | 

            try
            {
                RestApiResultStore result = apiInstance.CloneStore(storeId, settings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.CloneStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
settings StoreCloneSettings

Return type

RestApiResultStore

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]

ConfigureStoreServiceCharge

RestApiResultServiceCharge ConfigureStoreServiceCharge (int? storeId, ServiceCharge serviceCharge)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var serviceCharge = new ServiceCharge(); // ServiceCharge | 

            try
            {
                RestApiResultServiceCharge result = apiInstance.ConfigureStoreServiceCharge(storeId, serviceCharge);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.ConfigureStoreServiceCharge: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
serviceCharge ServiceCharge

Return type

RestApiResultServiceCharge

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]

CreateBusinessHoursOverrideByStoreId

RestApiResultBusinessHoursOverride CreateBusinessHoursOverrideByStoreId (int? storeId, BusinessHoursOverrideBase businessHoursOverride)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var businessHoursOverride = new BusinessHoursOverrideBase(); // BusinessHoursOverrideBase | 

            try
            {
                RestApiResultBusinessHoursOverride result = apiInstance.CreateBusinessHoursOverrideByStoreId(storeId, businessHoursOverride);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.CreateBusinessHoursOverrideByStoreId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
businessHoursOverride BusinessHoursOverrideBase

Return type

RestApiResultBusinessHoursOverride

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]

CreateStore

RestApiResultStore CreateStore (int? storeGroupId, StoreCreateBase store)

Example

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

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

            var apiInstance = new StoresApi();
            var storeGroupId = 56;  // int? | 
            var store = new StoreCreateBase(); // StoreCreateBase | 

            try
            {
                RestApiResultStore result = apiInstance.CreateStore(storeGroupId, store);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.CreateStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeGroupId int?
store StoreCreateBase

Return type

RestApiResultStore

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]

CreateStoreInProperty

RestApiResultStore CreateStoreInProperty (int? storeGroupId, string propertyId, StoreCreateBase store, bool? autoAssignMenu = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeGroupId = 56;  // int? | 
            var propertyId = propertyId_example;  // string | 
            var store = new StoreCreateBase(); // StoreCreateBase | 
            var autoAssignMenu = true;  // bool? |  (optional) 

            try
            {
                RestApiResultStore result = apiInstance.CreateStoreInProperty(storeGroupId, propertyId, store, autoAssignMenu);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.CreateStoreInProperty: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeGroupId int?
propertyId string
store StoreCreateBase
autoAssignMenu bool? [optional]

Return type

RestApiResultStore

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]

DeleteBusinessHoursOverride

RestApiArrayResultRestApiDefaultResponse DeleteBusinessHoursOverride (int? storeId, int? businessHoursOverrideId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var businessHoursOverrideId = 56;  // int? | 

            try
            {
                RestApiArrayResultRestApiDefaultResponse result = apiInstance.DeleteBusinessHoursOverride(storeId, businessHoursOverrideId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.DeleteBusinessHoursOverride: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
businessHoursOverrideId int?

Return type

RestApiArrayResultRestApiDefaultResponse

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]

GetBankAccountForStore

RestApiResultAssignedBankAccount GetBankAccountForStore (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultAssignedBankAccount result = apiInstance.GetBankAccountForStore(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetBankAccountForStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

RestApiResultAssignedBankAccount

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]

GetBusinessHours

RestApiArrayResultBusinessHoursPeriod GetBusinessHours (int? storeId, string deliveryType)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var deliveryType = deliveryType_example;  // string | 

            try
            {
                RestApiArrayResultBusinessHoursPeriod result = apiInstance.GetBusinessHours(storeId, deliveryType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetBusinessHours: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryType string

Return type

RestApiArrayResultBusinessHoursPeriod

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]

GetBusinessHoursOverrideByStoreId

RestApiPaginationResultBusinessHoursOverride GetBusinessHoursOverrideByStoreId (int? storeId, DateTime? after = 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 GetBusinessHoursOverrideByStoreIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var after = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultBusinessHoursOverride result = apiInstance.GetBusinessHoursOverrideByStoreId(storeId, after, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetBusinessHoursOverrideByStoreId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
after DateTime? [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultBusinessHoursOverride

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]

GetEndOfDayReport

RestApiResultStoreEndOfDayReport GetEndOfDayReport (int? storeId, DateTime? date = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var date = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 

            try
            {
                RestApiResultStoreEndOfDayReport result = apiInstance.GetEndOfDayReport(storeId, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetEndOfDayReport: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
date DateTime? [optional]

Return type

RestApiResultStoreEndOfDayReport

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]

GetPreOrderConfig

RestApiResultPreOrderConfig GetPreOrderConfig (int? storeId, string deliveryType)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var deliveryType = deliveryType_example;  // string | 

            try
            {
                RestApiResultPreOrderConfig result = apiInstance.GetPreOrderConfig(storeId, deliveryType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetPreOrderConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryType string

Return type

RestApiResultPreOrderConfig

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]

GetPreOrderPreview

RestApiArrayResultPreOrderTime GetPreOrderPreview (int? storeId, string deliveryType, int? preOrderConfigLeadTimeMinutes = null, int? preOrderConfigIntervalMinutes = null, int? preOrderConfigMaxOrderAheadDays = null, bool? preOrderConfigIncludeAsap = null, bool? preOrderConfigIncludeMoreGranularInitialTime = null, string preOrderConfigCutOffTimePreviousDayBasic = null, string preOrderConfigCutOffTimeCurrentDayBasic = null, string preOrderConfigPreOrderTimeDisplayType = null, bool? preOrderConfigAlwaysAppearOpen = null, bool? preOrderConfigRequireExplicitSelectAlways = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var deliveryType = deliveryType_example;  // string | 
            var preOrderConfigLeadTimeMinutes = 56;  // int? | Lead Time in Minutes (optional) 
            var preOrderConfigIntervalMinutes = 56;  // int? | Interval in minutes (optional) 
            var preOrderConfigMaxOrderAheadDays = 56;  // int? | Max Days to order ahead (optional) 
            var preOrderConfigIncludeAsap = true;  // bool? | Show ASAP as option (optional) 
            var preOrderConfigIncludeMoreGranularInitialTime = true;  // bool? | Granual Init' Time (optional) 
            var preOrderConfigCutOffTimePreviousDayBasic = preOrderConfigCutOffTimePreviousDayBasic_example;  // string | Cut off time previous day (optional) 
            var preOrderConfigCutOffTimeCurrentDayBasic = preOrderConfigCutOffTimeCurrentDayBasic_example;  // string | Cut off time current day (optional) 
            var preOrderConfigPreOrderTimeDisplayType = preOrderConfigPreOrderTimeDisplayType_example;  // string | Type of time displayed. (optional) 
            var preOrderConfigAlwaysAppearOpen = true;  // bool? | Specifies whether a customer can pre-order outside the store opening hours or not. (optional) 
            var preOrderConfigRequireExplicitSelectAlways = true;  // bool? | Force customer to select collection time. (optional) 

            try
            {
                RestApiArrayResultPreOrderTime result = apiInstance.GetPreOrderPreview(storeId, deliveryType, preOrderConfigLeadTimeMinutes, preOrderConfigIntervalMinutes, preOrderConfigMaxOrderAheadDays, preOrderConfigIncludeAsap, preOrderConfigIncludeMoreGranularInitialTime, preOrderConfigCutOffTimePreviousDayBasic, preOrderConfigCutOffTimeCurrentDayBasic, preOrderConfigPreOrderTimeDisplayType, preOrderConfigAlwaysAppearOpen, preOrderConfigRequireExplicitSelectAlways);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetPreOrderPreview: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryType string
preOrderConfigLeadTimeMinutes int? Lead Time in Minutes [optional]
preOrderConfigIntervalMinutes int? Interval in minutes [optional]
preOrderConfigMaxOrderAheadDays int? Max Days to order ahead [optional]
preOrderConfigIncludeAsap bool? Show ASAP as option [optional]
preOrderConfigIncludeMoreGranularInitialTime bool? Granual Init' Time [optional]
preOrderConfigCutOffTimePreviousDayBasic string Cut off time previous day [optional]
preOrderConfigCutOffTimeCurrentDayBasic string Cut off time current day [optional]
preOrderConfigPreOrderTimeDisplayType string Type of time displayed. [optional]
preOrderConfigAlwaysAppearOpen bool? Specifies whether a customer can pre-order outside the store opening hours or not. [optional]
preOrderConfigRequireExplicitSelectAlways bool? Force customer to select collection time. [optional]

Return type

RestApiArrayResultPreOrderTime

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]

GetProcessingFeeConfigsByStoreId

RestApiArrayResultProcessingFeeConfig GetProcessingFeeConfigsByStoreId (int? storeId, string appNameId = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var appNameId = appNameId_example;  // string |  (optional) 

            try
            {
                RestApiArrayResultProcessingFeeConfig result = apiInstance.GetProcessingFeeConfigsByStoreId(storeId, appNameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetProcessingFeeConfigsByStoreId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
appNameId string [optional]

Return type

RestApiArrayResultProcessingFeeConfig

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]

GetProcessingFeeConfigsByStoreIdAndPaymentAccountType

RestApiResultProcessingFeeConfig GetProcessingFeeConfigsByStoreIdAndPaymentAccountType (int? storeId, string paymentAccountType, string appNameId = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var paymentAccountType = paymentAccountType_example;  // string | 
            var appNameId = appNameId_example;  // string |  (optional) 

            try
            {
                RestApiResultProcessingFeeConfig result = apiInstance.GetProcessingFeeConfigsByStoreIdAndPaymentAccountType(storeId, paymentAccountType, appNameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetProcessingFeeConfigsByStoreIdAndPaymentAccountType: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
paymentAccountType string
appNameId string [optional]

Return type

RestApiResultProcessingFeeConfig

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]

GetStoreById

RestApiResultStore GetStoreById (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultStore result = apiInstance.GetStoreById(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

RestApiResultStore

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]

GetStoreDeliveryFeeConfig

RestApiArrayResultStoreDeliveryZoneFeeConfig GetStoreDeliveryFeeConfig (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                RestApiArrayResultStoreDeliveryZoneFeeConfig result = apiInstance.GetStoreDeliveryFeeConfig(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreDeliveryFeeConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

RestApiArrayResultStoreDeliveryZoneFeeConfig

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]

GetStoreFeeConfig

StoreFeeConfig GetStoreFeeConfig (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                StoreFeeConfig result = apiInstance.GetStoreFeeConfig(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreFeeConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

StoreFeeConfig

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]

GetStoreHeadersByAppId

RestApiPaginationResultStoreHeader GetStoreHeadersByAppId (string appId, string storeNameQuery = null, string salesChannelType = 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 GetStoreHeadersByAppIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var appId = appId_example;  // string | 
            var storeNameQuery = storeNameQuery_example;  // string |  (optional) 
            var salesChannelType = salesChannelType_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultStoreHeader result = apiInstance.GetStoreHeadersByAppId(appId, storeNameQuery, salesChannelType, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreHeadersByAppId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeNameQuery string [optional]
salesChannelType string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultStoreHeader

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]

GetStoreLeadTimes

RestApiResultOrderLeadTimes GetStoreLeadTimes (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultOrderLeadTimes result = apiInstance.GetStoreLeadTimes(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreLeadTimes: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

RestApiResultOrderLeadTimes

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]

GetStoreNetSales

RestApiArrayResultStoreStatistics GetStoreNetSales (string appId, List<int?> storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var appId = appId_example;  // string | 
            var storeId = new List<int?>(); // List<int?> | 

            try
            {
                RestApiArrayResultStoreStatistics result = apiInstance.GetStoreNetSales(appId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreNetSales: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId List<int?>

Return type

RestApiArrayResultStoreStatistics

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]

GetStoreServiceCharge

ServiceCharge GetStoreServiceCharge (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                ServiceCharge result = apiInstance.GetStoreServiceCharge(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoreServiceCharge: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

ServiceCharge

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]

GetStores

RestApiPaginationResultStore GetStores (string searchQuery = null, int? page = null, int? limit = null, int? storeGroupId = null)

Example

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

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

            var apiInstance = new StoresApi();
            var searchQuery = searchQuery_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var storeGroupId = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultStore result = apiInstance.GetStores(searchQuery, page, limit, storeGroupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStores: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

RestApiPaginationResultStore

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]

GetStoresByAppId

RestApiPaginationResultStore GetStoresByAppId (string appId, string searchQuery = null, string salesChannelType = null, bool? excludeUnpublished = 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 GetStoresByAppIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var appId = appId_example;  // string | 
            var searchQuery = searchQuery_example;  // string |  (optional) 
            var salesChannelType = salesChannelType_example;  // string |  (optional) 
            var excludeUnpublished = true;  // bool? |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultStore result = apiInstance.GetStoresByAppId(appId, searchQuery, salesChannelType, excludeUnpublished, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoresByAppId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
searchQuery string [optional]
salesChannelType string [optional]
excludeUnpublished bool? [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultStore

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]

GetStoresByStoreIdWithValidations

RestApiPaginationResultStoreValidationConfig GetStoresByStoreIdWithValidations (List<int?> storeId, string appId, 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 GetStoresByStoreIdWithValidationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var storeId = new List<int?>(); // List<int?> | 
            var appId = appId_example;  // string | 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultStoreValidationConfig result = apiInstance.GetStoresByStoreIdWithValidations(storeId, appId, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStoresByStoreIdWithValidations: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId List<int?>
appId string
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultStoreValidationConfig

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]

PublishStore

void PublishStore (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                apiInstance.PublishStore(storeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.PublishStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId 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]

PutStoreDeliveryFeeConfig

void PutStoreDeliveryFeeConfig (int? storeId, StoreDeliveryZoneFeeConfigUpdateRequest feeConfigUpdateRequest)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var feeConfigUpdateRequest = new StoreDeliveryZoneFeeConfigUpdateRequest(); // StoreDeliveryZoneFeeConfigUpdateRequest | 

            try
            {
                apiInstance.PutStoreDeliveryFeeConfig(storeId, feeConfigUpdateRequest);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.PutStoreDeliveryFeeConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
feeConfigUpdateRequest StoreDeliveryZoneFeeConfigUpdateRequest

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]

SetBusinessHours

RestApiResultBusinessHoursPeriod SetBusinessHours (int? storeId, string deliveryType, BusinessHoursPeriodBase businessHoursPeriod)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var deliveryType = deliveryType_example;  // string | 
            var businessHoursPeriod = new BusinessHoursPeriodBase(); // BusinessHoursPeriodBase | 

            try
            {
                RestApiResultBusinessHoursPeriod result = apiInstance.SetBusinessHours(storeId, deliveryType, businessHoursPeriod);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.SetBusinessHours: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryType string
businessHoursPeriod BusinessHoursPeriodBase

Return type

RestApiResultBusinessHoursPeriod

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]

SetPreOrdeEnabled

RestApiArrayResultRestApiDefaultResponse SetPreOrdeEnabled (int? storeId, string deliveryType, bool? enabled)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var deliveryType = deliveryType_example;  // string | 
            var enabled = true;  // bool? | 

            try
            {
                RestApiArrayResultRestApiDefaultResponse result = apiInstance.SetPreOrdeEnabled(storeId, deliveryType, enabled);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.SetPreOrdeEnabled: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryType string
enabled bool?

Return type

RestApiArrayResultRestApiDefaultResponse

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]

SetStoreCollectionSettings

RestApiResultRestApiDefaultResponse SetStoreCollectionSettings (int? storeId, StoreCollectionSettings settings, bool? inheritFromProperty = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var settings = new StoreCollectionSettings(); // StoreCollectionSettings | 
            var inheritFromProperty = true;  // bool? |  (optional) 

            try
            {
                RestApiResultRestApiDefaultResponse result = apiInstance.SetStoreCollectionSettings(storeId, settings, inheritFromProperty);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.SetStoreCollectionSettings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
settings StoreCollectionSettings
inheritFromProperty bool? [optional]

Return type

RestApiResultRestApiDefaultResponse

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]

SetStoreLeadTimes

RestApiResultOrderLeadTimes SetStoreLeadTimes (int? storeId, LeadTime leadTime)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var leadTime = new LeadTime(); // LeadTime | 

            try
            {
                RestApiResultOrderLeadTimes result = apiInstance.SetStoreLeadTimes(storeId, leadTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.SetStoreLeadTimes: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
leadTime LeadTime

Return type

RestApiResultOrderLeadTimes

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]

StoresSetPropertyId

Object StoresSetPropertyId (int? storeId, string propertyId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var propertyId = propertyId_example;  // string | 

            try
            {
                Object result = apiInstance.StoresSetPropertyId(storeId, propertyId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.StoresSetPropertyId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
propertyId string

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]

SupportedSalesChannelsTypes

void SupportedSalesChannelsTypes (string propertyId, int? storeId, List salesChannelTypes)

Example

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

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

            var apiInstance = new StoresApi();
            var propertyId = propertyId_example;  // string | 
            var storeId = 56;  // int? | 
            var salesChannelTypes = salesChannelTypes_example;  // List<string> | 

            try
            {
                apiInstance.SupportedSalesChannelsTypes(propertyId, storeId, salesChannelTypes);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.SupportedSalesChannelsTypes: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
propertyId string
storeId int?
salesChannelTypes List<string>

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]

UnpublishStore

void UnpublishStore (int? storeId)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 

            try
            {
                apiInstance.UnpublishStore(storeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.UnpublishStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId 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]

UpdatePreOrderConfig

RestApiArrayResultRestApiDefaultResponse UpdatePreOrderConfig (int? storeId, string deliveryType, PreOrderConfig preOrderConfig)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var deliveryType = deliveryType_example;  // string | 
            var preOrderConfig = new PreOrderConfig(); // PreOrderConfig | 

            try
            {
                RestApiArrayResultRestApiDefaultResponse result = apiInstance.UpdatePreOrderConfig(storeId, deliveryType, preOrderConfig);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.UpdatePreOrderConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
deliveryType string
preOrderConfig PreOrderConfig

Return type

RestApiArrayResultRestApiDefaultResponse

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]

UpdateStore

RestApiResultStore UpdateStore (int? storeId, StoreBase store)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var store = new StoreBase(); // StoreBase | 

            try
            {
                RestApiResultStore result = apiInstance.UpdateStore(storeId, store);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.UpdateStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
store StoreBase

Return type

RestApiResultStore

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]

UpdateStoreAddress

RestApiResultStoreAddress UpdateStoreAddress (int? storeId, StoreAddressBase storeAddress)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var storeAddress = new StoreAddressBase(); // StoreAddressBase | 

            try
            {
                RestApiResultStoreAddress result = apiInstance.UpdateStoreAddress(storeId, storeAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.UpdateStoreAddress: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
storeAddress StoreAddressBase

Return type

RestApiResultStoreAddress

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]

UpdateStoreAddressCoordinates

RestApiResultCoordinates UpdateStoreAddressCoordinates (int? storeId, Coordinates coordinates, string appNameId = null)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var coordinates = new Coordinates(); // Coordinates | 
            var appNameId = appNameId_example;  // string |  (optional) 

            try
            {
                RestApiResultCoordinates result = apiInstance.UpdateStoreAddressCoordinates(storeId, coordinates, appNameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.UpdateStoreAddressCoordinates: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
coordinates Coordinates
appNameId string [optional]

Return type

RestApiResultCoordinates

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]

UpdateStoreAddressForm

Object UpdateStoreAddressForm (int? storeId, StoreAddressForm address)

Example

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

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

            var apiInstance = new StoresApi();
            var storeId = 56;  // int? | 
            var address = new StoreAddressForm(); // StoreAddressForm | 

            try
            {
                Object result = apiInstance.UpdateStoreAddressForm(storeId, address);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.UpdateStoreAddressForm: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
address StoreAddressForm

Return type

Object

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]