Locations

Retrieve stores

Returns a list of all Locations, also called Stores, if neither of the filters is used. You can get the details for a certain store by specifying any of the following parameters: Id, storeIdentifier, name. <br /> You can use either of these methods to get a list of the subscriber’s locations: GET /locations, GET /stores. <br /> Visit ServiceChannel University to find out more about locations and provider assignments.

get/stores

Request

Query parameters

idinteger

Unique location identifier.

storeIdentifierstring

Alphanumeric location identifier in the client’s system. Assigned by and unique per subscriber.

namestring

Location name.

sortstring

Sort resources by the specified property in the response.

pageinteger

Results page number.

pageSizeinteger

Number of objects on the results page. The default and maximum per page is 50.

Response

The requested locations are in the response.

TotalCountinteger

Total count of all accessible locations unless one of the filters is filled out. For example, specifying the Id filter brings out details of the particular location.

Changes

No recorded changes to this operation across all 1 revision of this API.