Store.md

Store

Properties

Name	Type	Description	Notes
storeId	Integer	Store identifier	[optional]
storeGroupId	Integer	Store group id to which this store belongs	[optional]
address	StoreAddress	Store address	[optional]
deliveryZones	List<DeliveryZone>	Delivery zones	[optional]
apmPhoneNumber	String	Automated Phone Marketing number	[optional]
pickupHours	List<BusinessHoursPeriod>	Pickup hours	[optional]
deliveryHours	List<BusinessHoursPeriod>	Delivery hours	[optional]
menuId	Integer	Menu identifier	[optional]
orderConfirmationMessageOverrideDelivery	String	Overridden confirmation message for delivery orders	[optional]
orderConfirmationMessageOverridePickup	String	Overridden confirmation message for pickup orders	[optional]
printoutLayoutType	PrintoutLayoutTypeEnum	Printout layout	[optional]
storeNotes	List<StoreNote>	Store notes	[optional]
microsoftTimeZone	String	Microsoft Time Zone Index Values (https://msdn.microsoft.com/en-us/library/ms912391) (Editable through store coordinate change)	[optional]
ianaTimeZone	String	IANA Time Zone (https://www.iana.org/time-zones) (Editable through store coordinate change)	[optional]
currency	CurrencyEnum	Currency (derived from Store Group)	[optional]
preOrderDeliveryEnabled	Boolean	Is PerOrder Enabled for Delivery	[optional]
preOrderPickupEnabled	Boolean	Is PerOrder Enabled for Pickup	[optional]
logoUrl	String	Url for logo image	[optional]
fraudPreventionStrategy	String	Fraud Prevention Strategy	[optional]
appIds	List<String>	Store's app ids	[optional]
propertyId	String	Property Id	[optional]
phoneNumber	String	Phone number	[optional]
alwaysAppearOpen	Boolean	True if the store always appears open	[optional]
preOrderEnabled	Boolean	True if the store accepts pre-orders	[optional]
takeOutEnabled	Boolean	True if the store accepts take-out orders	[optional]
tableServiceEnabled	Boolean	True if the store has table service	[optional]
dineInEnabled	Boolean	True if the store accepts dine-in orders	[optional]
allowPreOrdersAndTableService	Boolean	True if both pre-orders and talbe service can be enabled	[optional]
pickupEnabled	Boolean	True if the store accepts pickup orders	[optional]
deliveryEnabled	Boolean	True if the store accepts delivery orders	[optional]
cardOrderDeliveryEnabled	Boolean	True if the store accepts card payment for delivery orders	[optional]
cashOrdersDeliveryEnabled	Boolean	True if the store accepts cash payment for delivery orders	[optional]
cardOrdersPickupEnabled	Boolean	True if the store accepts card payment for pickup orders	[optional]
cashOrdersPickupEnabled	Boolean	True if the store accepts cash payment for pickup orders	[optional]
tipsEnabled	Boolean	True if the store accepts tips	[optional]
automaticallyAcceptOrders	Boolean	True if the stores orders are automatically accepted in Flipdish	[optional]
openForDelivery	Boolean	True if the store is open for delivery	[optional]
openForPickup	Boolean	True if the store is open for pickup	[optional]
minimumPickupOrderAmount	Double	Minimum pickup order amount	[optional]
requireCustomerNameForPickup	Boolean	True if customer name required for pickup orders	[optional]
gdprCustomerPhoneNumbers	Boolean	Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed.	[optional]
requireCustomerNameForDelivery	Boolean	True if customer name required for delivery orders	[optional]
allowChefNotes	Boolean	True if the customer is allowed enter custom notes with their orders	[optional]
etaInPickupConfirmationSmsEnabled	Boolean	True if order confirmation sms includes estimated time when order will be ready for collection	[optional]
etaInDeliveryConfirmationSmsEnabled	Boolean	True if order confirmation sms includes estimated time when order will delivered	[optional]
isArchived	Boolean	Is the Store Archived	[optional]
isPublished	Boolean	Is the Store Published	[optional]
name	String	Name	[optional]
emailAddress	String	Email address (visible to customers)	[optional]
staffLanguage	String	Staff Language (used for communication with the staff) Emails, Printouts etc	[optional]
salesChannelTypes	List<SalesChannelTypesEnum>	Sales Channel Types	[optional]
inheritanceConfigTypes	List<InheritanceConfigTypesEnum>	Inheritance Config Types	[optional]

Enum: PrintoutLayoutTypeEnum

Name	Value
DEFAULT	"Default"
CENTRA	"Centra"
SMALLCHEFNOTES	"SmallChefNotes"
SMALLCHEFNOTESANDCENTRA	"SmallChefNotesAndCentra"

Enum: CurrencyEnum

Name	Value
EUR	"EUR"
USD	"USD"
GBP	"GBP"
CAD	"CAD"
AUD	"AUD"
DJF	"DJF"
ZAR	"ZAR"
ETB	"ETB"
AED	"AED"
BHD	"BHD"
DZD	"DZD"
EGP	"EGP"
IQD	"IQD"
JOD	"JOD"
KWD	"KWD"
LBP	"LBP"
LYD	"LYD"
MAD	"MAD"
OMR	"OMR"
QAR	"QAR"
SAR	"SAR"
SYP	"SYP"
TND	"TND"
YER	"YER"
CLP	"CLP"
INR	"INR"
AZN	"AZN"
RUB	"RUB"
BYN	"BYN"
BGN	"BGN"
NGN	"NGN"
BDT	"BDT"
CNY	"CNY"
BAM	"BAM"
CZK	"CZK"
DKK	"DKK"
CHF	"CHF"
MVR	"MVR"
BTN	"BTN"
XCD	"XCD"
BZD	"BZD"
HKD	"HKD"
IDR	"IDR"
JMD	"JMD"
MYR	"MYR"
NZD	"NZD"
PHP	"PHP"
SGD	"SGD"
TTD	"TTD"
XDR	"XDR"
ARS	"ARS"
BOB	"BOB"
COP	"COP"
CRC	"CRC"
CUP	"CUP"
DOP	"DOP"
GTQ	"GTQ"
HNL	"HNL"
MXN	"MXN"
NIO	"NIO"
PAB	"PAB"
PEN	"PEN"
PYG	"PYG"
UYU	"UYU"
VEF	"VEF"
IRR	"IRR"
XOF	"XOF"
CDF	"CDF"
XAF	"XAF"
HTG	"HTG"
ILS	"ILS"
HRK	"HRK"
HUF	"HUF"
AMD	"AMD"
ISK	"ISK"
JPY	"JPY"
GEL	"GEL"
KZT	"KZT"
KHR	"KHR"
KRW	"KRW"
KGS	"KGS"
LAK	"LAK"
MKD	"MKD"
MNT	"MNT"
BND	"BND"
MMK	"MMK"
NOK	"NOK"
NPR	"NPR"
PKR	"PKR"
PLN	"PLN"
AFN	"AFN"
BRL	"BRL"
MDL	"MDL"
RON	"RON"
RWF	"RWF"
SEK	"SEK"
LKR	"LKR"
SOS	"SOS"
ALL	"ALL"
RSD	"RSD"
KES	"KES"
TJS	"TJS"
THB	"THB"
ERN	"ERN"
TMT	"TMT"
BWP	"BWP"
TRY	"TRY"
UAH	"UAH"
UZS	"UZS"
VND	"VND"
MOP	"MOP"
TWD	"TWD"
BMD	"BMD"

Enum: List<SalesChannelTypesEnum>

Name	Value
WEB	"Web"
APP	"App"
KIOSK	"Kiosk"
POS	"Pos"
NONE	"None"

Enum: List<InheritanceConfigTypesEnum>

Name	Value
COLLECTIONSETTINGS	"CollectionSettings"