Skip to content

StoresApi.md

Latest commit

 

History

History
2078 lines (1394 loc) · 57.9 KB

StoresApi.md

File metadata and controls

2078 lines (1394 loc) · 57.9 KB
Raw

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.archiveStore(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

assignMenu

RestApiArrayResultRestApiDefaultResponse assignMenu(storeId, menuId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let menuId = 56; // Number | 
apiInstance.assignMenu(storeId, menuId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
menuId Number

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let settings = new Flipdish.StoreCloneSettings(); // StoreCloneSettings | 
apiInstance.cloneStore(storeId, settings, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

configureStoreServiceCharge

RestApiResultServiceCharge configureStoreServiceCharge(storeId, serviceCharge)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let serviceCharge = new Flipdish.ServiceCharge(); // ServiceCharge | 
apiInstance.configureStoreServiceCharge(storeId, serviceCharge, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data, Message, ErrorCode, StackTrace

createBusinessHoursOverrideByStoreId

RestApiResultBusinessHoursOverride createBusinessHoursOverrideByStoreId(storeId, businessHoursOverride)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let businessHoursOverride = new Flipdish.BusinessHoursOverrideBase(); // BusinessHoursOverrideBase | 
apiInstance.createBusinessHoursOverrideByStoreId(storeId, businessHoursOverride, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

createStore

RestApiResultStore createStore(storeGroupId, store)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeGroupId = 56; // Number | 
let store = new Flipdish.StoreCreateBase(); // StoreCreateBase | 
apiInstance.createStore(storeGroupId, store, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeGroupId Number
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, Data

createStoreInProperty

RestApiResultStore createStoreInProperty(storeGroupId, propertyId, store, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeGroupId = 56; // Number | 
let propertyId = "propertyId_example"; // String | 
let store = new Flipdish.StoreCreateBase(); // StoreCreateBase | 
let opts = {
  'autoAssignMenu': true // Boolean | 
};
apiInstance.createStoreInProperty(storeGroupId, propertyId, store, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeGroupId Number
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, Data

deleteBusinessHoursOverride

RestApiArrayResultRestApiDefaultResponse deleteBusinessHoursOverride(storeId, businessHoursOverrideId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let businessHoursOverrideId = 56; // Number | 
apiInstance.deleteBusinessHoursOverride(storeId, businessHoursOverrideId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
businessHoursOverrideId Number

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.getBankAccountForStore(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

RestApiResultAssignedBankAccount

Authorization

oauth2

HTTP request headers

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

getBusinessHours

RestApiArrayResultBusinessHoursPeriod getBusinessHours(storeId, deliveryType)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let deliveryType = "deliveryType_example"; // String | 
apiInstance.getBusinessHours(storeId, deliveryType, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
deliveryType String

Return type

RestApiArrayResultBusinessHoursPeriod

Authorization

oauth2

HTTP request headers

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

getBusinessHoursOverrideByStoreId

RestApiPaginationResultBusinessHoursOverride getBusinessHoursOverrideByStoreId(storeId, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let opts = {
  'after': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getBusinessHoursOverrideByStoreId(storeId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
after Date [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultBusinessHoursOverride

Authorization

oauth2

HTTP request headers

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

getEndOfDayReport

RestApiResultStoreEndOfDayReport getEndOfDayReport(storeId, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let opts = {
  'date': new Date("2013-10-20T19:20:30+01:00") // Date | 
};
apiInstance.getEndOfDayReport(storeId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
date Date [optional]

Return type

RestApiResultStoreEndOfDayReport

Authorization

oauth2

HTTP request headers

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

getPreOrderConfig

RestApiResultPreOrderConfig getPreOrderConfig(storeId, deliveryType)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let deliveryType = "deliveryType_example"; // String | 
apiInstance.getPreOrderConfig(storeId, deliveryType, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
deliveryType String

Return type

RestApiResultPreOrderConfig

Authorization

oauth2

HTTP request headers

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

getPreOrderPreview

RestApiArrayResultPreOrderTime getPreOrderPreview(storeId, deliveryType, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let deliveryType = "deliveryType_example"; // String | 
let opts = {
  'preOrderConfig_leadTimeMinutes': 56, // Number | Lead Time in Minutes
  'preOrderConfig_intervalMinutes': 56, // Number | Interval in minutes
  'preOrderConfig_maxOrderAheadDays': 56, // Number | Max Days to order ahead
  'preOrderConfig_includeAsap': true, // Boolean | Show ASAP as option
  'preOrderConfig_includeMoreGranularInitialTime': true, // Boolean | Granual Init' Time
  'preOrderConfig_cutOffTimePreviousDayBasic': "preOrderConfig_cutOffTimePreviousDayBasic_example", // String | Cut off time previous day
  'preOrderConfig_cutOffTimeCurrentDayBasic': "preOrderConfig_cutOffTimeCurrentDayBasic_example", // String | Cut off time current day
  'preOrderConfig_preOrderTimeDisplayType': "preOrderConfig_preOrderTimeDisplayType_example", // String | Type of time displayed.
  'preOrderConfig_alwaysAppearOpen': true, // Boolean | Specifies whether a customer can pre-order outside the store opening hours or not.
  'preOrderConfig_requireExplicitSelectAlways': true // Boolean | Force customer to select collection time.
};
apiInstance.getPreOrderPreview(storeId, deliveryType, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
deliveryType String
preOrderConfig_leadTimeMinutes Number Lead Time in Minutes [optional]
preOrderConfig_intervalMinutes Number Interval in minutes [optional]
preOrderConfig_maxOrderAheadDays Number Max Days to order ahead [optional]
preOrderConfig_includeAsap Boolean Show ASAP as option [optional]
preOrderConfig_includeMoreGranularInitialTime Boolean Granual Init' Time [optional]
preOrderConfig_cutOffTimePreviousDayBasic String Cut off time previous day [optional]
preOrderConfig_cutOffTimeCurrentDayBasic String Cut off time current day [optional]
preOrderConfig_preOrderTimeDisplayType String Type of time displayed. [optional]
preOrderConfig_alwaysAppearOpen Boolean Specifies whether a customer can pre-order outside the store opening hours or not. [optional]
preOrderConfig_requireExplicitSelectAlways Boolean Force customer to select collection time. [optional]

Return type

RestApiArrayResultPreOrderTime

Authorization

oauth2

HTTP request headers

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

getProcessingFeeConfigsByStoreId

RestApiArrayResultProcessingFeeConfig getProcessingFeeConfigsByStoreId(storeId, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let opts = {
  'appNameId': "appNameId_example" // String | 
};
apiInstance.getProcessingFeeConfigsByStoreId(storeId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
appNameId String [optional]

Return type

RestApiArrayResultProcessingFeeConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

getProcessingFeeConfigsByStoreIdAndPaymentAccountType

RestApiResultProcessingFeeConfig getProcessingFeeConfigsByStoreIdAndPaymentAccountType(storeId, paymentAccountType, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let paymentAccountType = "paymentAccountType_example"; // String | 
let opts = {
  'appNameId': "appNameId_example" // String | 
};
apiInstance.getProcessingFeeConfigsByStoreIdAndPaymentAccountType(storeId, paymentAccountType, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data, Message, ErrorCode, StackTrace

getStoreById

RestApiResultStore getStoreById(storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.getStoreById(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

RestApiResultStore

Authorization

oauth2

HTTP request headers

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

getStoreDeliveryFeeConfig

RestApiArrayResultStoreDeliveryZoneFeeConfig getStoreDeliveryFeeConfig(storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.getStoreDeliveryFeeConfig(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

RestApiArrayResultStoreDeliveryZoneFeeConfig

Authorization

oauth2

HTTP request headers

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

getStoreFeeConfig

StoreFeeConfig getStoreFeeConfig(storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.getStoreFeeConfig(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

StoreFeeConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, FeeConfigId, StoreId, StartTime, PercentFeeCardOrders, PercentFeeCashOrders, PercentFeeCardOrdersWeb, PercentFeeCashOrdersWeb, PercentFeeCardOrdersKiosk, PercentFeeCashOrdersKiosk, FixedFeeCardOrdersKiosk, FixedFeeCashOrdersKiosk, PercentFeeCardOrdersKioskChargedToCustomerIncludingVat, FixedFeeCardOrdersKioskChargedToCustomerIncludingVat, PercentFeeCashOrdersKioskChargedToCustomerIncludingVat, FixedFeeCashOrdersKioskChargedToCustomerIncludingVat, FixedFeeCardOrders, FixedFeeCashOrders, PercentFeeCardOrdersChargedToCustomerIncludingVat, FixedFeeCardOrdersChargedToCustomerIncludingVat, PercentFeeCashOrdersChargedToCustomerIncludingVat, FixedFeeCashOrdersChargedToCustomerIncludingVat, PercentFeeTips, PercentFeeTipsCollection, PercentFeeTipsDelivery, TaxRatePercent, PercentFeeCardOrdersLocationService, PercentFeeCashOrdersLocationService, FixedFeeCardOrdersLocationService, FixedFeeCashOrdersLocationService, PercentFeeCardOrdersLocationServiceChargedToCustomerIncludingVat, PercentFeeCashOrdersLocationServiceChargedToCustomerIncludingVat, FixedFeeCardOrdersLocationServiceChargedToCustomerIncludingVat, FixedFeeCashOrdersLocationServiceChargedToCustomerIncludingVat, PercentFeeDelivery, FixedFeeDelivery, PercentFeeCardPosTransaction, FixedFeeCardPosTransaction, PercentFeeOrderWithGoogle, FixedFeeOrderWithGoogle, PercentFeeCardOrdersPhoneAgent, PercentFeeCashOrdersPhoneAgent, FixedFeeCardOrdersPhoneAgent, FixedFeeCashOrdersPhoneAgent, PercentFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat, PercentFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat, FixedFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat, FixedFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat

getStoreHeadersByAppId

RestApiPaginationResultStoreHeader getStoreHeadersByAppId(appId, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let appId = "appId_example"; // String | 
let opts = {
  'storeNameQuery': "storeNameQuery_example", // String | 
  'salesChannelType': "salesChannelType_example", // String | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getStoreHeadersByAppId(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
storeNameQuery String [optional]
salesChannelType String [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultStoreHeader

Authorization

oauth2

HTTP request headers

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

getStoreLeadTimes

RestApiResultOrderLeadTimes getStoreLeadTimes(storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.getStoreLeadTimes(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

RestApiResultOrderLeadTimes

Authorization

oauth2

HTTP request headers

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

getStoreNetSales

RestApiArrayResultStoreStatistics getStoreNetSales(appId, storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let appId = "appId_example"; // String | 
let storeId = [null]; // [Number] | 
apiInstance.getStoreNetSales(appId, storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
storeId [Number]

Return type

RestApiArrayResultStoreStatistics

Authorization

oauth2

HTTP request headers

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

getStoreServiceCharge

ServiceCharge getStoreServiceCharge(storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.getStoreServiceCharge(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

ServiceCharge

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, StoreId, PercentageValue, Enabled, IsOptional, DisplayWithProcessingFee, IncludesVouchers

getStores

RestApiPaginationResultStore getStores(opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let opts = {
  'searchQuery': "searchQuery_example", // String | 
  'page': 56, // Number | 
  'limit': 56, // Number | 
  'storeGroupId': 56 // Number | 
};
apiInstance.getStores(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
searchQuery String [optional]
page Number [optional]
limit Number [optional]
storeGroupId Number [optional]

Return type

RestApiPaginationResultStore

Authorization

oauth2

HTTP request headers

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

getStoresByAppId

RestApiPaginationResultStore getStoresByAppId(appId, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let appId = "appId_example"; // String | 
let opts = {
  'searchQuery': "searchQuery_example", // String | 
  'salesChannelType': "salesChannelType_example", // String | 
  'excludeUnpublished': true, // Boolean | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getStoresByAppId(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
searchQuery String [optional]
salesChannelType String [optional]
excludeUnpublished Boolean [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultStore

Authorization

oauth2

HTTP request headers

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

getStoresByStoreIdWithValidations

RestApiPaginationResultStoreValidationConfig getStoresByStoreIdWithValidations(storeId, appId, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = [null]; // [Number] | 
let appId = "appId_example"; // String | 
let opts = {
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getStoresByStoreIdWithValidations(storeId, appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId [Number]
appId String
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultStoreValidationConfig

Authorization

oauth2

HTTP request headers

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

publishStore

publishStore(storeId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.publishStore(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

putStoreDeliveryFeeConfig

putStoreDeliveryFeeConfig(storeId, feeConfigUpdateRequest)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let feeConfigUpdateRequest = new Flipdish.StoreDeliveryZoneFeeConfigUpdateRequest(); // StoreDeliveryZoneFeeConfigUpdateRequest | 
apiInstance.putStoreDeliveryFeeConfig(storeId, feeConfigUpdateRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
storeId Number
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: Message, ErrorCode, StackTrace, application/json, text/json, application/xml, text/xml

setBusinessHours

RestApiResultBusinessHoursPeriod setBusinessHours(storeId, deliveryType, businessHoursPeriod)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let deliveryType = "deliveryType_example"; // String | 
let businessHoursPeriod = new Flipdish.BusinessHoursPeriodBase(); // BusinessHoursPeriodBase | 
apiInstance.setBusinessHours(storeId, deliveryType, businessHoursPeriod, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

setPreOrdeEnabled

RestApiArrayResultRestApiDefaultResponse setPreOrdeEnabled(storeId, deliveryType, enabled)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let deliveryType = "deliveryType_example"; // String | 
let enabled = true; // Boolean | 
apiInstance.setPreOrdeEnabled(storeId, deliveryType, enabled, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
deliveryType String
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, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let settings = new Flipdish.StoreCollectionSettings(); // StoreCollectionSettings | 
let opts = {
  'inheritFromProperty': true // Boolean | 
};
apiInstance.setStoreCollectionSettings(storeId, settings, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data, Message, ErrorCode, StackTrace

setStoreLeadTimes

RestApiResultOrderLeadTimes setStoreLeadTimes(storeId, leadTime)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let leadTime = new Flipdish.LeadTime(); // LeadTime | 
apiInstance.setStoreLeadTimes(storeId, leadTime, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

storesSetPropertyId

Object storesSetPropertyId(storeId, propertyId)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let propertyId = "propertyId_example"; // String | 
apiInstance.storesSetPropertyId(storeId, propertyId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

let apiInstance = new Flipdish.StoresApi();
let propertyId = "propertyId_example"; // String | 
let storeId = 56; // Number | 
let salesChannelTypes = ["null"]; // [String] | 
apiInstance.supportedSalesChannelsTypes(propertyId, storeId, salesChannelTypes, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
apiInstance.unpublishStore(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
storeId Number

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

updatePreOrderConfig

RestApiArrayResultRestApiDefaultResponse updatePreOrderConfig(storeId, deliveryType, preOrderConfig)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let deliveryType = "deliveryType_example"; // String | 
let preOrderConfig = new Flipdish.PreOrderConfig(); // PreOrderConfig | 
apiInstance.updatePreOrderConfig(storeId, deliveryType, preOrderConfig, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

updateStore

RestApiResultStore updateStore(storeId, store)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let store = new Flipdish.StoreBase(); // StoreBase | 
apiInstance.updateStore(storeId, store, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

updateStoreAddress

RestApiResultStoreAddress updateStoreAddress(storeId, storeAddress)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let storeAddress = new Flipdish.StoreAddressBase(); // StoreAddressBase | 
apiInstance.updateStoreAddress(storeId, storeAddress, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

updateStoreAddressCoordinates

RestApiResultCoordinates updateStoreAddressCoordinates(storeId, coordinates, opts)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let coordinates = new Flipdish.Coordinates(); // Coordinates | 
let opts = {
  'appNameId': "appNameId_example" // String | 
};
apiInstance.updateStoreAddressCoordinates(storeId, coordinates, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
storeId Number
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, Data

updateStoreAddressForm

Object updateStoreAddressForm(storeId, address)

Example

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

let apiInstance = new Flipdish.StoresApi();
let storeId = 56; // Number | 
let address = new Flipdish.StoreAddressForm(); // StoreAddressForm | 
apiInstance.updateStoreAddressForm(storeId, address, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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