How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ServiceChannel Locations API

The Locations API from ServiceChannel — 34 operation(s) for locations.

ServiceChannel Locations API is one of 66 APIs that ServiceChannel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Locations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 38 operations across 34 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version bearer.v1.

Requests are made against a single base URL, https://sb2fixxbook.servicechannel.com:443/api.

38 operations 34 paths 51 schemas 2 DELETE24 GET10 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
bearer.v1
Base URL
https://api.servicechannel.com/v3
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ServiceChannel Locations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • oauth2 — OAuth2 Authorization

Paths & Operations 38

Across 34 paths, the API surfaces 38 operations — 2 DELETE, 24 GET, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Locations 38
GET
/stores
Retrieve stores
GETv3_stores?Id={Id}&storeIdentifier={storeIdentifier}&Name={Name}&Sort={Sort}&Page={Page}&PageSize={PageSize} 6 params → 200400401500
GET
/locations
Retrieve stores
GETv3_locations?Id={Id}&storeIdentifier={storeIdentifier}&Name={Name}&Sort={Sort}&Page={Page}&PageSize={PageSize} 6 params → 200400401500
GET
/subscribers/current/users/current/stores
Get stores
GETv3_subscribers_current_users_current_stores → 200
GET
/locations/{locationId}
Retrieve a location
GETv3_locations_{locationId} 1 param → 200400401500
PUT
/locations/{locationId}
Update a location
PUTv3_locations_{locationId} 1 param body → 200400401500
GET
/locations/{locationId}/notes
Retrieve location notes
GETv3_locations_{locationId}_notes?privateNotes={privateNotes} 2 params → 200400401500
POST
/locations/{locationId}/notes
Add a location note
POSTv3_locations_{locationId}_notes 1 param body → 200400401403404500
POST
/locations/{storeId}/updateNotes
Add location notes
POSTv3_locations_{storeId}_updateNotes 1 param body → 200400401403404500
GET
/locations/UnassignedContracts
Get unassigned contracts
GETv3_locations_UnassignedContracts → 200400401404
GET
/locations/{locationId}/evacuationmaps
Get an evacuation plan map of a location
GETv3_locations_{locationId}_evacuationmaps 1 param → 200401500
GET
/locations/CheckIfLocationIsOpen
Check whether the location is open or closed.
GETv3_locations_CheckIfLocationIsOpen?locationId={locationId}&checkTime={checkTime} 2 params → 200
POST
/GetFilteredLocations
Get locations by filters
POSTv3_GetFilteredLocations body → 200400401403500
POST
/locations/LocationWithNotes
Create a location with location notes
POSTv3_locations_LocationWithNotes body → 200400401500
GET
/providers/GetProviderLocationAssignments
Get provider location assignments
GETv3_providers_GetProviderLocationAssignments → 200400401
GET
/providers/GetPrimaryLocationAssignmentsForProviderIds
Get provider primary location assignments by Provider Ids
GETv3_providers_GetPrimaryLocationAssignmentsForProviderIds?providerIds[0]={providerIds[0]}&providerIds[1]={providerIds[1]}&dateFrom={dateFrom}&dateTo={dateTo} 3 params → 200400401
GET
/GetLocationsMobile
Get Locations
GETv3_GetLocationsMobile?page={page}&pageSize={pageSize}&latitude={latitude}&longitude={longitude}&searchExpression={searchExpression}&onlyOpened={onlyOpened}&locationIds={locationIds} 7 params → 200401500
GET
/GetLocationDistricts
Get location districts
GETv3_GetLocationDistricts?page={page}&pageSize={pageSize}&searchExpression={searchExpression} 3 params → 200401500
GET
/GetUserDistricts
Get user districts
GETv3_GetUserDistricts?page={page}&pageSize={pageSize}&searchExpression={searchExpression} 3 params → 200401500
GET
/GetUserRegions
Get user regions
GETv3_GetUserRegions?page={page}&pageSize={pageSize}&searchExpression={searchExpression} 3 params → 200401500
GET
/locations/addressformats
Retrieve address format pattern per list of country ISO codes or per list of address types Ids
GETv3_locations_addressformats?c[0]={c[0]}&c[1]={c[1]}&id[0]={id[0]}&id[1]={id[1]} 2 params → 200
POST
/filter
Retrieve Locations by location ids
POSTv3_filter body → 200400
GET
/landlord-responsibilities-by-storeId
Get landlord responsibilities
GETv3_landlord-responsibilities-by-storeId?storeId={storeId} 1 param → 200403404
GET
/landlord-responsibilities-by-locationId
Get landlord responsibilities
GETv3_landlord-responsibilities-by-locationId?locationId={locationId} 1 param → 200403404
PUT
/landlord-responsibilities
Update Landlord Responsibility
PUTv3_landlord-responsibilities body → 201400403404
POST
/landlord-responsibilities
Create landlord responsibility
POSTv3_landlord-responsibilities body → 201400403404
DELETE
/landlord-responsibilities/{responsibilityId}
Delete Landlord Responsibility
DELETEv3_landlord-responsibilities_{responsibilityId} 1 param → 200400401403
GET
/locations/{storeId}/attachments
Get a Location’s Attachments
GETv3_locations_{storeId}_attachments 1 param → 200400401403404
POST
/locations/{storeId}/attachments
Create a Location Attachment
POSTv3_locations_{storeId}_attachments?subscriberId={subscriberId}&fileDescription={fileDescription}&isEvacuationPlan={isEvacuationPlan} 4 params body → 201400401403404500
DELETE
/locations/{storeId}/attachments/{attachmentId}
Delete a Location Attachment
DELETEv3_locations_{storeId}_attachments_{attachmentId} 2 params → 200400401403404
POST
/locations/GetExistsLocations
GetExistsLocations
POSTv3_locations_GetExistsLocations body → 200
POST
/locations/GetExistsRegions
GetExistsRegions
POSTv3_locations_GetExistsRegions body → 200
POST
/locations/GetExistsDistricts
GetExistsDistricts
POSTv3_locations_GetExistsDistricts body → 200
GET
/providers/current/locationsWithRetired
Retrieve provider's locations (include retired)
GETv3_providers_current_locationsWithRetired → 200401
GET
/locations/{locationId}/hierarchy
GetLocationHierarchy
GETv3_locations_{locationId}_hierarchy 1 param → 200400401403
GET
/locations/{locationId}/locationAttachments
Get Location Attachments
GETv3_locations_{locationId}_locationAttachments 1 param → 200400401403404
GET
/odata/locations
Retrieve locations
Locations_GetLocations 7 params → 200
GET
/odata/locations/Service.NearBy(latitude={latitude},longitude={longitude})
Get locations by geographic coordinates
Locations_GetLocationsNearMe 9 params → 200
GET
/odata/locations/Service.ForServiceRequest()
Retrieve locations
Locations_GetServiceRequestLocations 7 params → 200

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.Messaging.Location.ProviderAssignmentExtendedLocation (47 properties), ServiceChannel.Services.Messaging.Location.LocationWithTimezoneName (46 properties), ServiceChannel.Services.Messaging.Location.Location (45 properties), ServiceChannel.Services.Messaging.Providers.Provider (34 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Services.Messaging.Location.ProviderLocation
object
Provider's location
2 properties
ServiceChannel.Services.Messaging.Location.ApiLocationModel
object
12 properties
ServiceChannel.Services.Messaging.Location.UpdateLandlordResponsibilityApiRequest
object
8 properties
ServiceChannel.Services.Messaging.Location.GetProviderAssignmentExtendedLocationsResponse
object
6 properties
ServiceChannel.Services.Messaging.Location.LocationFilterRequest
object
1 property
ServiceChannel.Services.Messaging.Location.GetLocationDistrictsResponse
object
Response details object.
4 properties
ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse
object
Response details object.
2 properties
ServiceChannel.Services.Messaging.Location.GetFilteredLocationsRequest
object
Request object to get locations.
10 properties
System.Object
object
ServiceChannel.Services.Messaging.Location.UpdateLocationExRequest
object
Request object to update location details.
24 properties 2 required
ServiceChannel.Services.Messaging.Users.User
object
User details object.
17 properties
ServiceChannel.Services.Messaging.Location.ExistsRegionsRequest
object
ExistsRegionsRequest
1 property
ServiceChannel.Services.WebApi.Models.Response.LocationHierarchy.LocationHierarchyResponse
object
1 property
ServiceChannel.Services.Messaging.Currencies.Currency
object
7 properties
ServiceChannel.Services.Messaging.Users.LimitOptions
object
Object for NTE, proposal, and invoice limits set for a subscriber user.
3 properties
ServiceChannel.Services.Messaging.Location.GetLocationsMobileResponse
object
Response details object.
4 properties
ServiceChannel.Services.Messaging.Users.AccessOptions
object
Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and…
4 properties
ServiceChannel.Services.Messaging.Location.ExistsDistrictsRequest
object
ExistsDistrictsRequest
1 property
ServiceChannel.Services.Messaging.Location.ProviderAssignmentExtendedLocation
object
47 properties
ServiceChannel.Services.Messaging.Location.AddUpdateLocationResponse
object
Location note object.
1 property
ServiceChannel.Services.Messaging.Users.DashboardInfo
object
Dashboard details object.
3 properties
ServiceChannel.Services.Messaging.AfterHours.CheckIfLocationIsOpenResponse
object
Stores information whether the location is open or closed.
1 property
ServiceChannel.Services.Messaging.Location.CreateLandlordResponsibilityApiRequest
object
8 properties
ServiceChannel.Services.Messaging.Location.GetApiLocationResponse
object
1 property
ServiceChannel.Services.Messaging.Location.GetUserRegionsResponse
object
Response details object.
2 properties
ServiceChannel.Services.Messaging.Location.GetUserDistrictsResponse
object
Response details object.
2 properties
ServiceChannel.Services.Messaging.Location.ExistsLocationsRequest
object
ExistsLocationsRequest
1 property
ServiceChannel.Services.Messaging.Location.LocationShortModel
object
Shortened location details object.
22 properties
ServiceChannel.Services.WebApi.Models.Response.LocationHierarchy.LocationHierarchyByLevelResponse
object
LocationHierarchyByLevelResponse
7 properties
ServiceChannel.Services.Messaging.Trade.Trade
object
Trade object.
3 properties
ServiceChannel.Api.Model.Entities.Category
object
6 properties
ServiceChannel.Services.Messaging.Contracts.Contract
object
Contract object.
7 properties
ServiceChannel.Services.Messaging.Location.Location
object
General location details object.
45 properties
ServiceChannel.Services.Messaging.Location.LocationAttachment
object
Attachment object.
11 properties
ServiceChannel.Services.Messaging.Location.GetLandlordResponsibilityResponse
object
1 property
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Services.Messaging.Location.LocationWithTimezoneName
object
LocationWithTimezoneName
46 properties
ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeaderApiModelRequest
object
Object containing the details of the location note.
2 properties
ServiceChannel.Services.Messaging.Users.Limit
object
Object for limit details set for a subscriber user.
2 properties
ServiceChannel.Services.Messaging.Users.MlpUserInfo
object
3 properties
ServiceChannel.Services.Messaging.Location.GetLocationAttachmentsResponse
object
3 properties
ServiceChannel.Services.Messaging.Subscribers.Subscriber
object
19 properties 1 required
ServiceChannel.Services.Messaging.Location.LandlordResponsibilityModel
object
16 properties
ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeadersApiModelRequest
object
Object containing the details of the location notes.
1 property
ServiceChannel.Services.Messaging.Providers.Provider
object
34 properties
ServiceChannel.Services.Messaging.Users.MliUserInfo
object
3 properties
ServiceChannel.Services.Messaging.Location.AddressType
object
AddressType
2 properties
ServiceChannel.Services.Messaging.Location.LocationForMobile
object
Location details object for mobile.
23 properties
ServiceChannel.Api.Model.Entities.PrimaryCategory
object
4 properties
ServiceChannel.Services.Messaging.Location.GetLocationsByFilterRequest
object
1 property
ServiceChannel.Services.Messaging.LocationNote.LocationNote
object
Object with the location note details.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-locations-api-openapi.yml Raw ↑

Other APIs ServiceChannel publishes across the network.

ServiceChannel AfterHours API
ServiceChannel AIAgents API
ServiceChannel Announcements API
ServiceChannel ApplicationAccess API
ServiceChannel Assets API
ServiceChannel AssetTaskResponse API
ServiceChannel AssetTypes API
ServiceChannel Attachments API
ServiceChannel BatchRfp API
ServiceChannel Branding API
ServiceChannel Categories API
ServiceChannel CheckLists API
Where this information came from

This is an independent, third-party profile of ServiceChannel Locations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.