getLocationsByPageV1
Changed onRetrieve a list of Locations by page number.
Request
- Base URL//webservices-test.net-chef.com (relative, and the document’s source URL is not known)
- URL//webservices-test.net-chef.com/location/v1/getLocationsByPage
- Authnone declared. Required headers: authenticationtoken, password, sitename, userid
Query parameters
Use true to retrieve only active Locations.
Use 'true' to retrieve "Location" data for the Company location only.
The Code that identifies the Location in Crunchtime.
The number of minutes since a location record was last updated. Use to set how far back to search.
Market Name from main location record
Code for the City associated with this location
Code for the State/Province associated with this location
Code for the Country associated with this location
Code for the Franchise associated with this location
Name of the Franchise associated with this location. Use 3 or more characters. (Optional)
Export Code for the location, from the Alternate Address tab
Payroll Export Code for the location, from the Alternate Address tab
Specifies the field used to sort the Locations. Default is 'locationCode ' if not provided (Optional)
Specifies the sort direction for Locations: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional)
Retrieve one or more records by pageNumber. \n Use to retrieve data in smaller chunks. \n If left blank, the default is 1.
Number of items to display per page.
Specify 'true' to output null data elements.
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
Example response
[
{
"locationDetails": [
{
"locationAltAddressDetails": [
{
"acapCode": "test1",
"accoCode": "test",
"altAddressOne": "testAddress1",
"altAddressTwo": "testAddress2",
"cdpEMail": "cdp@crunchtime.com",
"city": "Test City",
"companyNameForPO": "test",
"locationCode": "WGT1",
"stateProvince": "MD"
}
],
"locationCode": "000000",
"locationConceptInfoDetails": [
{
"conceptCode": "BSC1",
"conceptName": "BS Concept 1",
"locationCode": "WGT1",
"remove": "N"
}
],
"locationDeliverInfoDetails": [
{
"activeFlag": "Y",
"delete": "N",
"deliverToName": "MASF11",
"locationCode": "WGT1"
}
],
"locationDetailDetails": [
{
"allowAutoPost": "Y",
"allowAutoTransfer": "N",
"autoCreatePOSRecipe": "N",
"autoPostDaysOffset": 1,
"autoPostMethod": "A",
"autoPostTime": "15:00",
"autoPrepForDepletion": "N",
"baseCurrency": "USD",
"biziqCompDate": "12/03/2023",
"borrowCnsEndDate": "12/30/2023",
"borrowCnsLocationCode": "MASF11",
"buffetQuantityAlertPercent": 999,
"dailyPrepReview": "Y",
"earliestPostDateTimeBasedOn": "C",
"gmtOffset": -4,
"grandOpeningDate": "12/03/2023",
"inventoryAutoFlag": "N",
"inventoryDataEntryDate": "2025-01-13T13:46:05",
"inventoryPostUpFlag": "Y",
"inventoryUserId": "IM_OWNER",
"laborAutoFlag": "N",
"laborDataEntryDate": "2024-06-26T01:37:03",
"laborPostUpFlag": "Y",
"laborUserId": "IM_OWNER",
"lastInventoryPost": "12/30/2024",
"lastLaborPost": "06/24/2024",
"locationCode": "786_98",
"lotTracking": "N",
"market": "ASMarket",
"missingPrepCheck": "N",
"optimalDaysOnHand": 22,
"ownershipEntity": "Crunchtime",
"posFilePath": "Deprecated",
"posType": "STANDARD",
"productionQuantityAlertPercent": 999,
"purchaseType": "D",
"secMrktPurchase": "Y",
"smartPicklist": "N",
"software": "STANDARD",
"timezone": 48
}
],
"locationHoursOfOperationDetails": [
{
"closingTime": "16:00",
"closingTimeCleanup": "20:30",
"corporateFlag": "N",
"dayOfWeek": 5,
"locationCode": "WGT1",
"openingTime": "10:30",
"openingTimeSetup": "08:00"
}
],
"locationLaborDetails": [
{
"businessDayBegins": "02:50",
"corporateFlag": "N",
"locationCode": "WGT1"
}
],
"locationNameAddressDetails": [
{
"activeFlag": "Y",
"addressOne": "Addr1",
"addressTwo": "Addr2",
"city": "Glacier",
"country": "USA",
"eMail": "test@abc.com",
"franchiseName": "Franchisee 11",
"franchiseSiteName": "test11",
"locationADRemoteName": "Test 1",
"locationCode": "WGT1",
"locationName": "New York",
"phone": "8008675309",
"stateProvince": "NJ",
"zip": "20867"
}
],
"locationPostDetails": [
{
"enabledFlag": "Y",
"locationCode": "WGT1"
}
],
"locationSafeLogDetails": [
{
"locationCode": "WGT1",
"safeLogName": "Test Safe",
"expectedValue": 1000.55,
"currencyCode": "USD",
"activeFlag": "Y",
"noteRequiredForVarianceFlag": "Y",
"varianceThreshold": 700
}
],
"locationTimeClockInTwxDetails": [
{
"allowTimeClockInMTX": true,
"allowTimeClockInTWX": true,
"locationCode": "WGT1",
"minutesEarly": 10,
"minutesLate": 5,
"contentReportingEmail": "email@provider.com; email2@otherprovider.com"
}
],
"locationUdaDetails": [
{
"dataType": "CHAR",
"locationCode": "MASF11",
"replicatedFlag": true,
"requiredFlag": "Y",
"udaCode": "ADDRESS",
"udaDescription": "Address",
"udaGroup": "USERDEFINED",
"udaType": "COMPANY",
"udaValue": "New City"
}
]
}
]
}
]Changes
- breaking
the
/////response's property type changed fromobjecttostringfor status (media type: */*) - breaking
the
/////response's property type changed fromobjecttostringfor status (media type: application/json) - info
added the optional property
/////to the response with the status (media type: */*) - info
added the optional property
/////to the response with the status (media type: application/json) - info
added the optional property
/////to the response with the status (media type: */*) - info
added the optional property
/////to the response with the status (media type: application/json)
- breaking