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

archiveStore(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    apiInstance.archiveStore(storeId);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#archiveStore");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

assignMenu

RestApiArrayResultRestApiDefaultResponse assignMenu(storeId, menuId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
Integer menuId = 56; // Integer | 
try {
    RestApiArrayResultRestApiDefaultResponse result = apiInstance.assignMenu(storeId, menuId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#assignMenu");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
menuId	Integer

Return type

RestApiArrayResultRestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

cloneStore

RestApiResultStore cloneStore(storeId, settings)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
StoreCloneSettings settings = new StoreCloneSettings(); // StoreCloneSettings | 
try {
    RestApiResultStore result = apiInstance.cloneStore(storeId, settings);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#cloneStore");
    e.printStackTrace();
}

Parameters

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

configureStoreServiceCharge

RestApiResultServiceCharge configureStoreServiceCharge(storeId, serviceCharge)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
ServiceCharge serviceCharge = new ServiceCharge(); // ServiceCharge | 
try {
    RestApiResultServiceCharge result = apiInstance.configureStoreServiceCharge(storeId, serviceCharge);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#configureStoreServiceCharge");
    e.printStackTrace();
}

Parameters

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

createBusinessHoursOverrideByStoreId

RestApiResultBusinessHoursOverride createBusinessHoursOverrideByStoreId(storeId, businessHoursOverride)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
BusinessHoursOverrideBase businessHoursOverride = new BusinessHoursOverrideBase(); // BusinessHoursOverrideBase | 
try {
    RestApiResultBusinessHoursOverride result = apiInstance.createBusinessHoursOverrideByStoreId(storeId, businessHoursOverride);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#createBusinessHoursOverrideByStoreId");
    e.printStackTrace();
}

Parameters

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

createStore

RestApiResultStore createStore(storeGroupId, store)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeGroupId = 56; // Integer | 
StoreCreateBase store = new StoreCreateBase(); // StoreCreateBase | 
try {
    RestApiResultStore result = apiInstance.createStore(storeGroupId, store);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#createStore");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeGroupId	Integer
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

createStoreInProperty

RestApiResultStore createStoreInProperty(storeGroupId, propertyId, store, autoAssignMenu)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeGroupId = 56; // Integer | 
String propertyId = "propertyId_example"; // String | 
StoreCreateBase store = new StoreCreateBase(); // StoreCreateBase | 
Boolean autoAssignMenu = true; // Boolean | 
try {
    RestApiResultStore result = apiInstance.createStoreInProperty(storeGroupId, propertyId, store, autoAssignMenu);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#createStoreInProperty");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeGroupId	Integer
propertyId	String
store	StoreCreateBase
autoAssignMenu	Boolean	[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

deleteBusinessHoursOverride

RestApiArrayResultRestApiDefaultResponse deleteBusinessHoursOverride(storeId, businessHoursOverrideId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
Integer businessHoursOverrideId = 56; // Integer | 
try {
    RestApiArrayResultRestApiDefaultResponse result = apiInstance.deleteBusinessHoursOverride(storeId, businessHoursOverrideId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#deleteBusinessHoursOverride");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
businessHoursOverrideId	Integer

Return type

RestApiArrayResultRestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

getBankAccountForStore

RestApiResultAssignedBankAccount getBankAccountForStore(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    RestApiResultAssignedBankAccount result = apiInstance.getBankAccountForStore(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getBankAccountForStore");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

RestApiResultAssignedBankAccount

Authorization

oauth2

HTTP request headers

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

getBusinessHours

RestApiArrayResultBusinessHoursPeriod getBusinessHours(storeId, deliveryType)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String deliveryType = "deliveryType_example"; // String | 
try {
    RestApiArrayResultBusinessHoursPeriod result = apiInstance.getBusinessHours(storeId, deliveryType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getBusinessHours");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
deliveryType	String		[enum: Delivery, Pickup]

Return type

RestApiArrayResultBusinessHoursPeriod

Authorization

oauth2

HTTP request headers

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

getBusinessHoursOverrideByStoreId

RestApiPaginationResultBusinessHoursOverride getBusinessHoursOverrideByStoreId(storeId, after, page, limit)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
OffsetDateTime after = OffsetDateTime.now(); // OffsetDateTime | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultBusinessHoursOverride result = apiInstance.getBusinessHoursOverrideByStoreId(storeId, after, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getBusinessHoursOverrideByStoreId");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	Integer
after	OffsetDateTime	[optional]
page	Integer	[optional]
limit	Integer	[optional]

Return type

RestApiPaginationResultBusinessHoursOverride

Authorization

oauth2

HTTP request headers

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

getEndOfDayReport

RestApiResultStoreEndOfDayReport getEndOfDayReport(storeId, date)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
OffsetDateTime date = OffsetDateTime.now(); // OffsetDateTime | 
try {
    RestApiResultStoreEndOfDayReport result = apiInstance.getEndOfDayReport(storeId, date);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getEndOfDayReport");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
date	OffsetDateTime		[optional]

Return type

RestApiResultStoreEndOfDayReport

Authorization

oauth2

HTTP request headers

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

getPreOrderConfig

RestApiResultPreOrderConfig getPreOrderConfig(storeId, deliveryType)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String deliveryType = "deliveryType_example"; // String | 
try {
    RestApiResultPreOrderConfig result = apiInstance.getPreOrderConfig(storeId, deliveryType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getPreOrderConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
deliveryType	String		[enum: Delivery, Pickup]

Return type

RestApiResultPreOrderConfig

Authorization

oauth2

HTTP request headers

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

getPreOrderPreview

RestApiArrayResultPreOrderTime getPreOrderPreview(storeId, deliveryType, preOrderConfigLeadTimeMinutes, preOrderConfigIntervalMinutes, preOrderConfigMaxOrderAheadDays, preOrderConfigIncludeAsap, preOrderConfigIncludeMoreGranularInitialTime, preOrderConfigCutOffTimePreviousDayBasic, preOrderConfigCutOffTimeCurrentDayBasic, preOrderConfigPreOrderTimeDisplayType, preOrderConfigAlwaysAppearOpen, preOrderConfigRequireExplicitSelectAlways)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String deliveryType = "deliveryType_example"; // String | 
Integer preOrderConfigLeadTimeMinutes = 56; // Integer | Lead Time in Minutes
Integer preOrderConfigIntervalMinutes = 56; // Integer | Interval in minutes
Integer preOrderConfigMaxOrderAheadDays = 56; // Integer | Max Days to order ahead
Boolean preOrderConfigIncludeAsap = true; // Boolean | Show ASAP as option
Boolean preOrderConfigIncludeMoreGranularInitialTime = true; // Boolean | Granual Init' Time
String preOrderConfigCutOffTimePreviousDayBasic = "preOrderConfigCutOffTimePreviousDayBasic_example"; // String | Cut off time previous day
String preOrderConfigCutOffTimeCurrentDayBasic = "preOrderConfigCutOffTimeCurrentDayBasic_example"; // String | Cut off time current day
String preOrderConfigPreOrderTimeDisplayType = "preOrderConfigPreOrderTimeDisplayType_example"; // String | Type of time displayed.
Boolean preOrderConfigAlwaysAppearOpen = true; // Boolean | Specifies whether a customer can pre-order outside the store opening hours or not.
Boolean preOrderConfigRequireExplicitSelectAlways = true; // Boolean | Force customer to select collection time.
try {
    RestApiArrayResultPreOrderTime result = apiInstance.getPreOrderPreview(storeId, deliveryType, preOrderConfigLeadTimeMinutes, preOrderConfigIntervalMinutes, preOrderConfigMaxOrderAheadDays, preOrderConfigIncludeAsap, preOrderConfigIncludeMoreGranularInitialTime, preOrderConfigCutOffTimePreviousDayBasic, preOrderConfigCutOffTimeCurrentDayBasic, preOrderConfigPreOrderTimeDisplayType, preOrderConfigAlwaysAppearOpen, preOrderConfigRequireExplicitSelectAlways);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getPreOrderPreview");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
deliveryType	String		[enum: Delivery, Pickup]
preOrderConfigLeadTimeMinutes	Integer	Lead Time in Minutes	[optional]
preOrderConfigIntervalMinutes	Integer	Interval in minutes	[optional]
preOrderConfigMaxOrderAheadDays	Integer	Max Days to order ahead	[optional]
preOrderConfigIncludeAsap	Boolean	Show ASAP as option	[optional]
preOrderConfigIncludeMoreGranularInitialTime	Boolean	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] [enum: SingleTime, StartAndEndTime, DayOnly]
preOrderConfigAlwaysAppearOpen	Boolean	Specifies whether a customer can pre-order outside the store opening hours or not.	[optional]
preOrderConfigRequireExplicitSelectAlways	Boolean	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

getProcessingFeeConfigsByStoreId

RestApiArrayResultProcessingFeeConfig getProcessingFeeConfigsByStoreId(storeId, appNameId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String appNameId = "appNameId_example"; // String | 
try {
    RestApiArrayResultProcessingFeeConfig result = apiInstance.getProcessingFeeConfigsByStoreId(storeId, appNameId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getProcessingFeeConfigsByStoreId");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
appNameId	String		[optional]

Return type

RestApiArrayResultProcessingFeeConfig

Authorization

oauth2

HTTP request headers

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

getProcessingFeeConfigsByStoreIdAndPaymentAccountType

RestApiResultProcessingFeeConfig getProcessingFeeConfigsByStoreIdAndPaymentAccountType(storeId, paymentAccountType, appNameId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String paymentAccountType = "paymentAccountType_example"; // String | 
String appNameId = "appNameId_example"; // String | 
try {
    RestApiResultProcessingFeeConfig result = apiInstance.getProcessingFeeConfigsByStoreIdAndPaymentAccountType(storeId, paymentAccountType, appNameId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getProcessingFeeConfigsByStoreIdAndPaymentAccountType");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	Integer
paymentAccountType	String	[enum: Card, Cash, Ideal, Bancontact, Giropay, Eps, Emv, PayPal, PayGreen, GoogleWalletToken]
appNameId	String	[optional]

Return type

RestApiResultProcessingFeeConfig

Authorization

oauth2

HTTP request headers

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

getStoreById

RestApiResultStore getStoreById(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    RestApiResultStore result = apiInstance.getStoreById(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

RestApiResultStore

Authorization

oauth2

HTTP request headers

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

getStoreDeliveryFeeConfig

RestApiArrayResultStoreDeliveryZoneFeeConfig getStoreDeliveryFeeConfig(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    RestApiArrayResultStoreDeliveryZoneFeeConfig result = apiInstance.getStoreDeliveryFeeConfig(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreDeliveryFeeConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

RestApiArrayResultStoreDeliveryZoneFeeConfig

Authorization

oauth2

HTTP request headers

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

getStoreFeeConfig

StoreFeeConfig getStoreFeeConfig(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    StoreFeeConfig result = apiInstance.getStoreFeeConfig(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreFeeConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

StoreFeeConfig

Authorization

oauth2

HTTP request headers

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

getStoreHeadersByAppId

RestApiPaginationResultStoreHeader getStoreHeadersByAppId(appId, storeNameQuery, salesChannelType, page, limit)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
String appId = "appId_example"; // String | 
String storeNameQuery = "storeNameQuery_example"; // String | 
String salesChannelType = "salesChannelType_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultStoreHeader result = apiInstance.getStoreHeadersByAppId(appId, storeNameQuery, salesChannelType, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreHeadersByAppId");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
appId	String
storeNameQuery	String	[optional]
salesChannelType	String	[optional] [enum: Web, App, Kiosk, Pos, None]
page	Integer	[optional]
limit	Integer	[optional]

Return type

RestApiPaginationResultStoreHeader

Authorization

oauth2

HTTP request headers

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

getStoreLeadTimes

RestApiResultOrderLeadTimes getStoreLeadTimes(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    RestApiResultOrderLeadTimes result = apiInstance.getStoreLeadTimes(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreLeadTimes");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

RestApiResultOrderLeadTimes

Authorization

oauth2

HTTP request headers

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

getStoreNetSales

RestApiArrayResultStoreStatistics getStoreNetSales(appId, storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
String appId = "appId_example"; // String | 
List<Integer> storeId = Arrays.asList(56); // List<Integer> | 
try {
    RestApiArrayResultStoreStatistics result = apiInstance.getStoreNetSales(appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreNetSales");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
appId	String
storeId	List<Integer>

Return type

RestApiArrayResultStoreStatistics

Authorization

oauth2

HTTP request headers

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

getStoreServiceCharge

ServiceCharge getStoreServiceCharge(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    ServiceCharge result = apiInstance.getStoreServiceCharge(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoreServiceCharge");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

ServiceCharge

Authorization

oauth2

HTTP request headers

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

getStores

RestApiPaginationResultStore getStores(searchQuery, page, limit, storeGroupId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
String searchQuery = "searchQuery_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
Integer storeGroupId = 56; // Integer | 
try {
    RestApiPaginationResultStore result = apiInstance.getStores(searchQuery, page, limit, storeGroupId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStores");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
searchQuery	String	[optional]
page	Integer	[optional]
limit	Integer	[optional]
storeGroupId	Integer	[optional]

Return type

RestApiPaginationResultStore

Authorization

oauth2

HTTP request headers

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

getStoresByAppId

RestApiPaginationResultStore getStoresByAppId(appId, searchQuery, salesChannelType, excludeUnpublished, page, limit)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
String appId = "appId_example"; // String | 
String searchQuery = "searchQuery_example"; // String | 
String salesChannelType = "salesChannelType_example"; // String | 
Boolean excludeUnpublished = true; // Boolean | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultStore result = apiInstance.getStoresByAppId(appId, searchQuery, salesChannelType, excludeUnpublished, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoresByAppId");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
appId	String
searchQuery	String	[optional]
salesChannelType	String	[optional] [enum: Web, App, Kiosk, Pos, None]
excludeUnpublished	Boolean	[optional]
page	Integer	[optional]
limit	Integer	[optional]

Return type

RestApiPaginationResultStore

Authorization

oauth2

HTTP request headers

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

getStoresByStoreIdWithValidations

RestApiPaginationResultStoreValidationConfig getStoresByStoreIdWithValidations(storeId, appId, page, limit)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
List<Integer> storeId = Arrays.asList(56); // List<Integer> | 
String appId = "appId_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultStoreValidationConfig result = apiInstance.getStoresByStoreIdWithValidations(storeId, appId, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#getStoresByStoreIdWithValidations");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	List<Integer>
appId	String
page	Integer	[optional]
limit	Integer	[optional]

Return type

RestApiPaginationResultStoreValidationConfig

Authorization

oauth2

HTTP request headers

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

publishStore

publishStore(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    apiInstance.publishStore(storeId);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#publishStore");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

putStoreDeliveryFeeConfig

putStoreDeliveryFeeConfig(storeId, feeConfigUpdateRequest)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
StoreDeliveryZoneFeeConfigUpdateRequest feeConfigUpdateRequest = new StoreDeliveryZoneFeeConfigUpdateRequest(); // StoreDeliveryZoneFeeConfigUpdateRequest | 
try {
    apiInstance.putStoreDeliveryFeeConfig(storeId, feeConfigUpdateRequest);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#putStoreDeliveryFeeConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
feeConfigUpdateRequest	StoreDeliveryZoneFeeConfigUpdateRequest

Return type

null (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

setBusinessHours

RestApiResultBusinessHoursPeriod setBusinessHours(storeId, deliveryType, businessHoursPeriod)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String deliveryType = "deliveryType_example"; // String | 
BusinessHoursPeriodBase businessHoursPeriod = new BusinessHoursPeriodBase(); // BusinessHoursPeriodBase | 
try {
    RestApiResultBusinessHoursPeriod result = apiInstance.setBusinessHours(storeId, deliveryType, businessHoursPeriod);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#setBusinessHours");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	Integer
deliveryType	String	[enum: Delivery, Pickup]
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

setPreOrdeEnabled

RestApiArrayResultRestApiDefaultResponse setPreOrdeEnabled(storeId, deliveryType, enabled)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String deliveryType = "deliveryType_example"; // String | 
Boolean enabled = true; // Boolean | 
try {
    RestApiArrayResultRestApiDefaultResponse result = apiInstance.setPreOrdeEnabled(storeId, deliveryType, enabled);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#setPreOrdeEnabled");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	Integer
deliveryType	String	[enum: Delivery, Pickup]
enabled	Boolean

Return type

RestApiArrayResultRestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

setStoreCollectionSettings

RestApiResultRestApiDefaultResponse setStoreCollectionSettings(storeId, settings, inheritFromProperty)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
StoreCollectionSettings settings = new StoreCollectionSettings(); // StoreCollectionSettings | 
Boolean inheritFromProperty = true; // Boolean | 
try {
    RestApiResultRestApiDefaultResponse result = apiInstance.setStoreCollectionSettings(storeId, settings, inheritFromProperty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#setStoreCollectionSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	Integer
settings	StoreCollectionSettings
inheritFromProperty	Boolean	[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

setStoreLeadTimes

RestApiResultOrderLeadTimes setStoreLeadTimes(storeId, leadTime)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
LeadTime leadTime = new LeadTime(); // LeadTime | 
try {
    RestApiResultOrderLeadTimes result = apiInstance.setStoreLeadTimes(storeId, leadTime);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#setStoreLeadTimes");
    e.printStackTrace();
}

Parameters

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

storesSetPropertyId

Object storesSetPropertyId(storeId, propertyId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String propertyId = "propertyId_example"; // String | 
try {
    Object result = apiInstance.storesSetPropertyId(storeId, propertyId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#storesSetPropertyId");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer
propertyId	String

Return type

Object

Authorization

oauth2

HTTP request headers

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

supportedSalesChannelsTypes

supportedSalesChannelsTypes(propertyId, storeId, salesChannelTypes)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
String propertyId = "propertyId_example"; // String | 
Integer storeId = 56; // Integer | 
List<String> salesChannelTypes = Arrays.asList(new List<String>()); // List<String> | 
try {
    apiInstance.supportedSalesChannelsTypes(propertyId, storeId, salesChannelTypes);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#supportedSalesChannelsTypes");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
propertyId	String
storeId	Integer
salesChannelTypes	List<String>

Return type

null (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

unpublishStore

unpublishStore(storeId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
try {
    apiInstance.unpublishStore(storeId);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#unpublishStore");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
storeId	Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

updatePreOrderConfig

RestApiArrayResultRestApiDefaultResponse updatePreOrderConfig(storeId, deliveryType, preOrderConfig)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
String deliveryType = "deliveryType_example"; // String | 
PreOrderConfig preOrderConfig = new PreOrderConfig(); // PreOrderConfig | 
try {
    RestApiArrayResultRestApiDefaultResponse result = apiInstance.updatePreOrderConfig(storeId, deliveryType, preOrderConfig);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#updatePreOrderConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
storeId	Integer
deliveryType	String	[enum: Delivery, Pickup]
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

updateStore

RestApiResultStore updateStore(storeId, store)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
StoreBase store = new StoreBase(); // StoreBase | 
try {
    RestApiResultStore result = apiInstance.updateStore(storeId, store);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#updateStore");
    e.printStackTrace();
}

Parameters

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

updateStoreAddress

RestApiResultStoreAddress updateStoreAddress(storeId, storeAddress)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
StoreAddressBase storeAddress = new StoreAddressBase(); // StoreAddressBase | 
try {
    RestApiResultStoreAddress result = apiInstance.updateStoreAddress(storeId, storeAddress);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#updateStoreAddress");
    e.printStackTrace();
}

Parameters

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

updateStoreAddressCoordinates

RestApiResultCoordinates updateStoreAddressCoordinates(storeId, coordinates, appNameId)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
Coordinates coordinates = new Coordinates(); // Coordinates | 
String appNameId = "appNameId_example"; // String | 
try {
    RestApiResultCoordinates result = apiInstance.updateStoreAddressCoordinates(storeId, coordinates, appNameId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#updateStoreAddressCoordinates");
    e.printStackTrace();
}

Parameters

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

updateStoreAddressForm

Object updateStoreAddressForm(storeId, address)

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StoresApi apiInstance = new StoresApi();
Integer storeId = 56; // Integer | 
StoreAddressForm address = new StoreAddressForm(); // StoreAddressForm | 
try {
    Object result = apiInstance.updateStoreAddressForm(storeId, address);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoresApi#updateStoreAddressForm");
    e.printStackTrace();
}

Parameters

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

FilesExpand file tree

StoresApi.md

Latest commit

History

StoresApi.md

File metadata and controls

StoresApi

archiveStore

Example

Parameters

Return type

Authorization

HTTP request headers

assignMenu

Example

Parameters

Return type

Authorization

HTTP request headers

cloneStore

Example

Parameters

Return type

Authorization

HTTP request headers

configureStoreServiceCharge

Example

Parameters

Return type

Authorization

HTTP request headers

createBusinessHoursOverrideByStoreId

Example

Parameters

Return type

Authorization

HTTP request headers

createStore

Example

Parameters

Return type

Authorization

HTTP request headers

createStoreInProperty

Example

Parameters

Return type

Authorization

HTTP request headers

deleteBusinessHoursOverride

Example

Parameters

Return type

Authorization

HTTP request headers

getBankAccountForStore

Example

Parameters

Return type

Authorization

HTTP request headers

getBusinessHours

Example

Parameters

Return type

Authorization

HTTP request headers

getBusinessHoursOverrideByStoreId

Example

Parameters

Return type

Authorization

HTTP request headers

getEndOfDayReport

Example

Parameters

Return type

Authorization

HTTP request headers

getPreOrderConfig