--- title: "GET /api/v1.0/stores" method: GET path: "/api/v1.0/stores" tags: ["Stores"] --- # GET /api/v1.0/stores `GET /api/v1.0/stores` ## Query parameters - `searchQuery` string - `page` integer - `limit` integer - `storeGroupId` integer ## Response `200` OK - RestApiPaginationResultStore — Rest api pagination result - `Page` integer, required — Current page index - `Limit` integer, required — Current page size - `TotalRecordCount` integer, required — Total record count - `Data` Store[], required — Generic data object. - `StoreId` integer — Store identifier - `StoreGroupId` integer — Store group id to which this store belongs - `Address` StoreAddress — Store address - `AddressId` integer — Address identifier - `Coordinates` Coordinates — Coordinates - `Latitude` number, double — Latitude - `Longitude` number, double — Longitude - `Line1` string — Address line 1 - `Postcode` string — Postcode - `City` string — City - `CountryCode` string — Country code (ISO-alpha2) - `DisplayForCustomer` string — Display for customer - `AddressFields` object — Dyanmic field/value pairs, defined by the form assigned to the given country code. - `SingleLineDisplay` string — Single line display i18n, may be empty for not supported countries - `TwoLinesDisplay` string[] — Two line display i18n, may be empty for not supported countries - `DeliveryZones` DeliveryZone[] — Delivery zones - `Id` integer — Delivery Fee Area Id - `FeeChargedToStore` number, double, nullable — Delivery Fee charged to store - `DeliveryFee` number, double — Delivery fee (will not be set below 0) - `MinimumDeliveryOrderAmount` number, double — Minimum delivery order amount (will not be set below 0) - `WellKnownText` string — Spatial data in Well Known Text format We also support CIRCLE((0 0, 200)) - (centerLong centerLat, radius in m) - `IsEnabled` boolean — Is delivery zone enabled - `ApmPhoneNumber` string — Automated Phone Marketing number - `PickupHours` BusinessHoursPeriod[] — Pickup hours - `Early` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Late` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Ranges` Range[] — Ranges - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `StartTime` string — Start time - `Period` string — Period - `StartTimeEarly` string — Start time early - `PeriodEarly` string — Period early - `DeliveryHours` BusinessHoursPeriod[] — Delivery hours - `Early` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Late` Range — A class that represents a single opening period in a day. This starts 'StartTime' after midnight and runs for a 'Period' after that, on the given DayOfWeek. - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `Ranges` Range[] — Ranges - `StartTime` string — Start time - `Period` string — Period - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of week - `StartTime` string — Start time - `Period` string — Period - `StartTimeEarly` string — Start time early - `PeriodEarly` string — Period early - `MenuId` integer — Menu identifier - `OrderConfirmationMessageOverrideDelivery` string — Overridden confirmation message for delivery orders - `OrderConfirmationMessageOverridePickup` string — Overridden confirmation message for pickup orders - `PrintoutLayoutType` 'Default' | 'Centra' | 'SmallChefNotes' | 'SmallChefNotesAndCentra', nullable — Printout layout - `StoreNotes` StoreNote[] — Store notes - `UserId` integer — User identifier - `CreateTime` string, date-time — Create time - `Note` string — Note - `MicrosoftTimeZone` string — Microsoft Time Zone Index Values (https://msdn.microsoft.com/en-us/library/ms912391) (Editable through store coordinate change) - `IanaTimeZone` string — IANA Time Zone (https://www.iana.org/time-zones) (Editable through store coordinate change) - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency (derived from Store Group) - `PreOrderDeliveryEnabled` boolean — Is PerOrder Enabled for Delivery - `PreOrderPickupEnabled` boolean — Is PerOrder Enabled for Pickup - `LogoUrl` string — Url for logo image - `FraudPreventionStrategy` string — Fraud Prevention Strategy - `AppIds` string[] — Store's app ids - `PropertyId` string — Property Id - `PhoneNumber` string — Phone number - `AlwaysAppearOpen` boolean — True if the store always appears open - `PreOrderEnabled` boolean — True if the store accepts pre-orders - `TakeOutEnabled` boolean — True if the store accepts take-out orders - `TableServiceEnabled` boolean — True if the store has table service - `DineInEnabled` boolean — True if the store accepts dine-in orders - `AllowPreOrdersAndTableService` boolean — True if both pre-orders and talbe service can be enabled - `PickupEnabled` boolean — True if the store accepts pickup orders - `DeliveryEnabled` boolean — True if the store accepts delivery orders - `CardOrderDeliveryEnabled` boolean — True if the store accepts card payment for delivery orders - `CashOrdersDeliveryEnabled` boolean — True if the store accepts cash payment for delivery orders - `CardOrdersPickupEnabled` boolean — True if the store accepts card payment for pickup orders - `CashOrdersPickupEnabled` boolean — True if the store accepts cash payment for pickup orders - `TipsEnabled` boolean — True if the store accepts tips - `AutomaticallyAcceptOrders` boolean — True if the stores orders are automatically accepted in Flipdish - `OpenForDelivery` boolean — True if the store is open for delivery - `OpenForPickup` boolean — True if the store is open for pickup - `MinimumPickupOrderAmount` number, double — Minimum pickup order amount - `RequireCustomerNameForPickup` boolean — True if customer name required for pickup orders - `GdprCustomerPhoneNumbers` boolean — Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed. - `RequireCustomerNameForDelivery` boolean — True if customer name required for delivery orders - `AllowChefNotes` boolean — True if the customer is allowed enter custom notes with their orders - `EtaInPickupConfirmationSmsEnabled` boolean — True if order confirmation sms includes estimated time when order will be ready for collection - `EtaInDeliveryConfirmationSmsEnabled` boolean — True if order confirmation sms includes estimated time when order will delivered - `IsArchived` boolean — Is the Store Archived - `IsPublished` boolean — Is the Store Published - `Name` string — Name - `EmailAddress` string — Email address (visible to customers) - `StaffLanguage` string — Staff Language (used for communication with the staff) Emails, Printouts etc - `SalesChannelTypes` string[] — Sales Channel Types - `InheritanceConfigTypes` string[] — Inheritance Config Types ## Other responses - `400` — BadRequest - `401` — Authentication has been denied for this request. - `403` — Successful authentication, but authorization has been denied for this request. --- [API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)