API Reference

getAllLocationsV1

get
https://webservices-test.net-chef.com/location/v1/getAllLocations

Retrieve a list of all Locations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Use true to retrieve only active Locations.

boolean

Use 'true' to retrieve "Location" data for the Company location only.

string

The Code that identifies the Location in Crunchtime.

int32

The number of minutes since a location record was last updated. Use to set how far back to search.

string

Market Name from main location record

string

Code for the City associated with this location

string

Code for the State/Province associated with this location

string

Code for the Country associated with this location

string

Links the location to a specific franchise

string

Export Code for the location, from the Alternate Address tab

string
string
enum

Specifies the field used to sort the Locations. Default is 'locationCode ' if not provided (Optional)

string
enum

Specifies the sort direction for Locations: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional)

Allowed:
boolean

Specify 'true' to output null data elements.

Headers
string
required

Secure token for API authentication.

string
required

Password for the Crunchtime Application User.

string
required

Crunchtime site identifier. (test or production)

string
required

User ID for the Crunchtime Application User.

string

Optional trace identifier for troubleshooting.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 5 months ago