--- title: "getLocationsByPageV1" method: GET path: "/cruise/location/v1/getLocationsByPage" tags: ["Location Service"] --- # getLocationsByPageV1 `GET /cruise/location/v1/getLocationsByPage` ## Request - Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known) - URL: `//webservices-test.net-chef.com/cruise/location/v1/getLocationsByPage` - Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid` Retrieve a list of Locations by page number. ## Query parameters - `activeFlag` boolean - `corporate` boolean - `locationCode` string - `minutesSinceUpdate` integer - `market` string - `city` string - `stateProvince` string - `country` string - `franchiseCode` string - `exportCode` string - `payrollExportCode` string - `sortBy` 'locationCode ' | 'locationName' | 'city' | 'lastUpdated' | 'lastEditDate' | 'createDate' | 'lastEditUser' | 'market' | 'franchiseCode' - `sortOrder` 'ASC' | 'DESC' - `pageNumber` integer - `pageSize` integer - `includeNull` boolean ## Headers - `authenticationtoken` string, required - `password` string, required - `sitename` string, required - `userid` string, required - `X-B3-TraceId` string ## Response `200` Success - LocationBatchResponseDto[] - `hasNext` boolean - `totalPages` integer - `locationDetails` LocationDetailsGet[] - `locationAltAddressDetails` LocationAltAddrDetailDto[] - `acapCode` string: "ACAP Code" from Location setup screen. - `accoCode` string: "ACCO Code" from Location setup screen. - `altAddressOne` string: "Alt. Address 1" from Location setup screen. - `altAddressTwo` string: "Alt. Address 2" from Location setup screen. - `altPhone` string: "Alt. Phone" from Location setup screen. - `cdpEMail` string: "CDP E-Mail" from Location setup screen. - `city` string: "City" from Location setup screen. - `companyNameForPO` string: "Company Name for PO" from Location setup screen. - `exportCode` string: "Export Code" from Location setup screen. - `importCode` string: "Import Code" from Location setup screen. - `locationCode` string, required: "Location Code" from Location setup screen. - `payrollExportCode` string: "Payroll Export Code" from Location setup screen. - `stateProvince` string, required: "State/Province" from Location setup screen. - `zip` string, required: "Zip Code" from Location setup screen. - `locationCode` string, required: Company "Code" from Company setup screen. - `locationConceptInfoDetails` LocationConceptInfoDetailDto[] - `conceptCode` string, required: "Concept Code" from Location setup screen. - `conceptName` string, required: "Concept Name" from Location setup screen. - `locationCode` string, required: "Location Code" from Location setup screen. - `remove` 'N' | 'Y': "Delete" flag (Y/N). If set to ‘Y’, it will delete this Concept from the Location record - `locationDeliverInfoDetails` LocationDeliverInfoDetailDto[] - `activeFlag` 'N' | 'Y': "Active Flag" from Location setup screen - `delete` 'N' | 'Y': "Delete Flag" from Location setup screen - `deliverToCode` string, required: "Deliver To Code" from Location setup screen - `deliverToName` string, required: "Deliver To Name" from Location setup screen - `locationCode` string, required: "Location Code" from Location setup screen - `locationDetailDetails` LocationDetailDetailDtoGet[] - `allowAutoPost` 'N' | 'Y', required: 'Auto-Post' flag from Location setup screen. - `allowAutoTransfer` 'N' | 'Y': 'Allow Auto-Transfer' flag from Location setup screen. - `autoCreatePOSRecipe` 'N' | 'Y': 'Allow Menu Mix File to Create Recipes for Unknown POS Recipes' from Location setup screen. - `autoPostDaysOffset` integer: Offset from Post Date ___ Days from Location setup screen. - `autoPostMethod` 'A' | 'X': Auto-Post Method from Location setup screen ‘A’ for Auto-Post Inventory or ‘X’ for Auto-Post Inventory By Exception. - `autoPostTime` object: Auto-Post Time from Location setup screen. - `autoPrepForDepletion` 'N' | 'Y': 'Auto-Daily Prep for sales depletion flag' from Location setup screen. - `baseCurrency` string: 'Base Currency' Code from Location setup screen. - `biziqCompDate` string, date-time: The date on which BizIQ year over year comparisons start for the location, in 'YYYYMMDD' format. - `borrowCnsEndDate` string, date-time: 'Use Historical Consumption from' Date from Location setup screen. - `borrowCnsLocationCode` string: 'Use Historical Consumption from' Location Code from Location setup screen. - `buffetQuantityAlertPercent` integer: Buffet Quantity Alert (%) from Location setup screen. - `dailyPrepReview` 'N' | 'Y': 'Daily Prep Review' flag from Location setup screen. - `earliestPostDateTimeBasedOn` 'C' | 'E': 'Earliest Post Date/Time based on' setting from Location setup screen. ‘C’ for Closing Time or ‘E’ for End of Business Day. - `gmtOffset` integer: GMT Offset from Location setup screen. - `grandOpeningDate` string, date-time: Opening Date from Location setup screen. - `inventoryAutoFlag` string: Indicates whether the last inventory post was completed via Auto-Post (Y/N). - `inventoryDataEntryDate` string, date-time: Displays the date of the last inventory data entry, in UTC format. - `inventoryPostUpFlag` string: Indicates whether the last inventory post was completed via Post Up (Y/N). - `inventoryUserId` string: Displays the User ID of the user that completed the last inventory. - `laborAutoFlag` string: Indicates whether the last labor post was completed via Auto-Post (Y/N). - `laborDataEntryDate` string, date-time: Displays the date of the last labor review, in UTC format. - `laborPostUpFlag` string: Indicates whether the last labor post was completed via Post Up (Y/N). - `laborUserId` string: Displays the User ID of the user that completed the last labor review. - `lastInventoryPost` string, date-time: Displays the date of the last inventory post. - `lastLaborPost` string, date-time: Displays the date of the last labor post. - `locationCode` string, required: Location Code from Location setup screen. - `lotTracking` 'N' | 'Y': Lot Tracking Flag from Location setup screen. - `market` string: Market Name from Location setup screen. - `missingPrepCheck` 'N' | 'Y': 'Check for Missing Prep in Final for Post' flag from Location setup screen. - `optimalDaysOnHand` integer: Optimal Days On Hand from Location setup screen. - `ownershipEntity` string: Ownership Entity from Location setup screen. - `posFilePath` string: POS File Path from Location setup screen. - `posType` string: POS Type from Location setup screen. - `productionQuantityAlertPercent` integer: Production Quantity Alert (%) from Location setup screen. - `purchaseType` 'C' | 'D' | 'M': Purchase Type from Location setup screen. ‘M’ for Master Order, ‘D’ for Direct (Vendor) Order, or 'C' for Combination. - `secMrktPurchase` 'N' | 'Y': 'Allow purchase from secondary Market Vendors' flag from Location setup screen. - `smartPicklist` 'N' | 'Y': 'Smart Picklist' flag from Location setup screen. - `software` string: Accounting Software from Location setup screen. - `timezone` integer: Time Zone setting from Location setup screen. - `locationHoursOfOperationDetails` LocationHoursOfOperationDetailDto[] - `closingTime` string: "Closing Time " from Location setup screen. - `closingTimeCleanup` string: "Closing Time (Cleanup)" from Location setup screen. - `corporateFlag` 'N' | 'Y', required: "Corporate" flag from Location setup screen. - `dayOfWeek` integer, required: "Day Of Week" from Location setup screen. '1'– Sun, '2'– Mon, '3'– Tue, '4'- Wed, '5'– Thur, '6'– Fri, '7'– Sat. - `locationCode` string, required: Location " Code" from Location setup screen. - `openingTime` string: "Opening Time " from Location setup screen. - `openingTimeSetup` string: "Opening Time (Setup)" from Location setup screen. - `locationLaborDetails` LocationLaborDetailDto[] - `businessDayBegins` string: "Business Day Begin Time" from Location setup screen. - `corporateFlag` 'N' | 'Y', required: "Corporate" flag from Location setup screen. - `locationCode` string, required: Location "Code" from Location setup screen. - `locationNameAddressDetails` LocationNameAddrDetailDto[] - `activeFlag` 'N' | 'Y': "Active" flag from Location setup screen. - `addressOne` string, required: "Address 1" from Location setup screen. - `addressTwo` string: "Address 2" from Location setup screen. - `city` string, required: "City" from Location setup screen. - `country` string: "Country" from Location setup screen. - `eMail` string: "E-Mail" from Location setup screen. - `fax` string: "Fax" from Location setup screen. - `franchiseCode` string: "Franchise Code" from Location setup screen. - `locationADRemoteName` string: "AD Location Name" from Location setup screen. - `locationCode` string, required: "Location Code" from Location setup screen. - `locationName` string, required: "Location Name" from Location setup screen. - `phone` string: "Phone" from Location setup screen. - `prefix` string - `stateProvince` string: "State/Province" from Location setup screen. - `zip` string: "Zip Code" from Location setup screen. - `locationPostDetails` LocationPostDetailDto[] - `enabledFlag` 'N' | 'Y', required: "Enabled" flag from Location setup screen. - `locationCode` string, required: Location "Code" from Location setup screen. - `postingGrp` string, required: "Posting Group ID" from Location setup screen. - `locationSafeLogDetails` LocationSafeLogDetailDto[] - `locationCode` string, required: Location "Code" from Location setup screen. - `safeLogName` string, required: "Safe Log Name" from Location Safe Log screen. - `expectedValue` number, required: "Expected Value" from Location Safe Log screen. - `currencyCode` string, required: "Currency Code" from Location Safe Log screen. Supported values include USD, CAD, GBP, EUR, AUD, AED, and SAR. - `activeFlag` 'N' | 'Y': "Active Flag" from Location Safe Log screen. - `noteRequiredForVarianceFlag` 'N' | 'Y': "Note Required" flag from Location Safe Log screen. If 'Y', user must include a note with each Safe Log entry. - `varianceThreshold` integer: "Note Variance" from Location Safe Log screen; indicates the acceptable threshold for a discrepancy between the Expected and Actual values. - `locationTimeClockInTwxDetails` LocationTimeClockInTwxDetailDto[] - `allowTimeClockInMTX` boolean: "allowTimeClockInMTX" from Location Labor setup screen - `allowTimeClockInTWX` boolean: "allowTimeClockInTWX" from Location Labor setup screen - `locationCode` string, required: "Location Code" from Location setup screen - `minutesEarly` integer: "minutesEarly" from Location Labor setup screen - `minutesLate` integer: "minutesLate" from Location Labor setup screen - `prefix` string - `contentReportingEmail` string: "Inappropriate Content Reporting Emails" from Location -> Labor setup screen - `locationUdaDetails` LocationUdaDetailDto[] - `dataType` string, required: "dataType" from Location setup screen - `lastTouchDate` string, date-time, required: "lastTouchDate" from Location setup screen - `locationCode` string, required: "locationCode" from Location setup screen - `prefix` string - `replicatedFlag` boolean, required: "replicatedFlag" from Location setup screen - `requiredFlag` 'N' | 'Y', required: "requiredFlag" from Location setup screen - `udaCode` string, required: "udaCode" from Location setup screen - `udaDescription` string, required: "udaDescription" from Location setup screen - `udaGroup` string, required: "udaGroup" from Location setup screen - `udaType` string, required: "udaType" from Location setup screen - `udaValue` string, required: "udaValue" from Location setup screen ## Other responses - `400`: Validation Error - `401`: Authorization - `404`: Location not found - `429`: Too Many Requests - `500`: Unexpected Error - `503`: System under maintenance - `504`: Timeout --- [API](https://skmtc.dev/crunchtime/apis/cruise-platform.md) - [All operations](https://skmtc.dev/crunchtime/apis/cruise-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/cruise-platform/revisions/d6bb0437a907?raw)