ServiceChannel

ServiceChannel Locations API

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

GitHub OpenAPI

Operations 38

GET /stores Retrieve stores #
GET /locations Retrieve stores #
GET /subscribers/current/users/current/stores Get stores #
GET /locations/{locationId} Retrieve a location #
PUT /locations/{locationId} Update a location #
GET /locations/{locationId}/notes Retrieve location notes #
POST /locations/{locationId}/notes Add a location note #
POST /locations/{storeId}/updateNotes Add location notes #
GET /locations/UnassignedContracts Get unassigned contracts #
GET /locations/{locationId}/evacuationmaps Get an evacuation plan map of a location #
GET /locations/CheckIfLocationIsOpen Check whether the location is open or closed. #
POST /GetFilteredLocations Get locations by filters #
POST /locations/LocationWithNotes Create a location with location notes #
GET /providers/GetProviderLocationAssignments Get provider location assignments #
GET /providers/GetPrimaryLocationAssignmentsForProviderIds Get provider primary location assignments by Provider Ids #
GET /GetLocationsMobile Get Locations #
GET /GetLocationDistricts Get location districts #
GET /GetUserDistricts Get user districts #
GET /GetUserRegions Get user regions #
GET /locations/addressformats Retrieve address format pattern per list of country ISO codes or per list of address types Ids #
POST /filter Retrieve Locations by location ids #
GET /landlord-responsibilities-by-storeId Get landlord responsibilities #
GET /landlord-responsibilities-by-locationId Get landlord responsibilities #
PUT /landlord-responsibilities Update Landlord Responsibility #
POST /landlord-responsibilities Create landlord responsibility #
DELETE /landlord-responsibilities/{responsibilityId} Delete Landlord Responsibility #
GET /locations/{storeId}/attachments Get a Location’s Attachments #
POST /locations/{storeId}/attachments Create a Location Attachment #
DELETE /locations/{storeId}/attachments/{attachmentId} Delete a Location Attachment #
POST /locations/GetExistsLocations GetExistsLocations #
POST /locations/GetExistsRegions GetExistsRegions #
POST /locations/GetExistsDistricts GetExistsDistricts #
GET /providers/current/locationsWithRetired Retrieve provider's locations (include retired) #
GET /locations/{locationId}/hierarchy GetLocationHierarchy #
GET /locations/{locationId}/locationAttachments Get Location Attachments #
GET /odata/locations Retrieve locations #
GET /odata/locations/Service.NearBy(latitude={latitude},longitude={longitude}) Get locations by geographic coordinates #
GET /odata/locations/Service.ForServiceRequest() Retrieve locations #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-locations-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/servicechannel-locations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

servicechannel-locations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours Locations API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
servers:
- url: https://sb2fixxbook.servicechannel.com:443/api
security:
- oauth2: []
tags:
- name: Locations
paths:
  /stores:
    get:
      tags:
      - Locations
      summary: Retrieve stores
      description: "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`.\n            <br /> You can use either of these methods to get a list of the subscriber’s locations: [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\n            <br /> Visit ServiceChannel University to find out more about [locations and provider assignments](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/556105830/Locations+Provider+Assignments)."
      operationId: GETv3_stores?Id={Id}&storeIdentifier={storeIdentifier}&Name={Name}&Sort={Sort}&Page={Page}&PageSize={PageSize}
      parameters:
      - name: id
        in: query
        description: Unique location identifier.
        required: false
        schema:
          type: integer
          format: int32
      - name: storeIdentifier
        in: query
        description: Alphanumeric location identifier in the client’s system. Assigned by and unique per subscriber.
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: Location name.
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort resources by the specified property in the response.
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: Results page number.
        required: false
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of objects on the results page. The default and maximum per page is 50.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The requested locations are in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc\n            <br/>Error codes: \n            502 — Subscriber not found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 - API call rejected by security permissions\n            100 — User has no permissions to perform this action"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error. \n            <br/>Error codes:\n            501 — “Location ID” is not a valid value for Int32\n            "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /locations:
    get:
      tags:
      - Locations
      summary: Retrieve stores
      description: "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`.\n            <br /> You can use either of these methods to get a list of the subscriber’s locations: [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\n            <br /> Visit ServiceChannel University to find out more about [locations and provider assignments](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/556105830/Locations+Provider+Assignments)."
      operationId: GETv3_locations?Id={Id}&storeIdentifier={storeIdentifier}&Name={Name}&Sort={Sort}&Page={Page}&PageSize={PageSize}
      parameters:
      - name: id
        in: query
        description: Unique location identifier.
        required: false
        schema:
          type: integer
          format: int32
      - name: storeIdentifier
        in: query
        description: Alphanumeric location identifier in the client’s system. Assigned by and unique per subscriber.
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: Location name.
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort resources by the specified property in the response.
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: Results page number.
        required: false
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Number of objects on the results page. The default and maximum per page is 50.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The requested locations are in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc\n            <br/>Error codes: \n            502 — Subscriber not found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 - API call rejected by security permissions\n            100 — User has no permissions to perform this action"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error. \n            <br/>Error codes:\n            501 — “Location ID” is not a valid value for Int32\n            "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /subscribers/current/users/current/stores:
    get:
      tags:
      - Locations
      summary: Get stores
      description: "Returns a list of stores with the LocationIDs and subscriber IDs, along with the location address details. The method is available to subscribers only.\n            <br /> To get more detailed information, use one of these methods: [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /odata/locations](/swagger/ui/index?version=3#/Locations/Locations_GetLocations).\n            <br /> Learn about updating [location details](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/708936009/Updating+Location+Details) in ServiceChannel University."
      operationId: GETv3_subscribers_current_users_current_stores
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Object'
      deprecated: false
      x-access: Any
  /locations/{locationId}:
    get:
      tags:
      - Locations
      summary: Retrieve a location
      description: "Returns the details for the specified location.\n            <br /> To receive details of several locations, use one of these methods: [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /odata/locations](/swagger/ui/index?version=3#/Locations/Locations_GetLocations)."
      operationId: GETv3_locations_{locationId}
      parameters:
      - name: locationId
        in: path
        description: Unique numeric identifier of the location to return the details for.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The specified location details are in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.LocationWithTimezoneName'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.LocationWithTimezoneName'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\n            <br/>Error codes:\n            601 — Location is not found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 — API call rejected by security permissions"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    put:
      tags:
      - Locations
      summary: Update a location
      description: "Modifies information of the existing location.You can use either of the following methods to retrieve location details: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\n             <br />***Note:*** Method is available for subscribers with the *Super Admin* permission or *SC Admin* role.\n             <br />Visit ServiceChannel University to find out [how subscribers can update location details](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/708936009/Updating+Location+Details).\n             <br />**Example request**\n            \n                 PUT / locations/{locationId}\n                 {\n                  \"StoreId\": \"34\",\n                  \"Name\": \"CSR Flagship\",\n                  \"Latitude\": 40.736601,\n                  \"Longitude\": -73.991795,\n                  \"Distance\": null,\n                  \"Address1\": \"3rd Floor, Innovation Center\",\n                  \"Address2\": \"18 E. 16th Street\",\n                  \"City\": \"New York\",\n                  \"State\": \"NY\",\n                  \"StateId\": 1,\n                  \"Region\": \"Northeast\",\n                  \"District\": \"NYC/LI\",\n                  \"Zip\": \"10003\",\n                  \"Country\": \"US\",\n                  \"CountryId\": 1,\n                  \"ClosedDate\": \"null\",\n                  \"OpenDate\": \"2021-07-05T07:05:04.991Z\",\n                  \"Email\": \"flagship@gmail.com\",\n                  \"Phone\": \"212-555-1212\",\n                  \"Contact\": \"\",\n                  \"FaxNumber\": \"\",\n                  \"LocationTypeId\": null,\n                  \"SquareValue\": 20.21\n                  \"SquareMeasure\": \"ft or foot\" or \"m or metre\"\n                 }"
      operationId: PUTv3_locations_{locationId}
      parameters:
      - name: locationId
        in: path
        description: Unique identifier of the subscriber’s location which information you want to update.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The location details are updated.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\n            <br/>Error codes:\n            601 — Location not found\n            1254 — Invalid square measure"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 — API call rejected by security permissions"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.UpdateLocationExRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.UpdateLocationExRequest'
        description: Request to change the location details. Leaving a parameter empty or excluding it from the request model erases the already existing data.
        required: true
  /locations/{locationId}/notes:
    get:
      tags:
      - Locations
      summary: Retrieve location notes
      description: Returns the location notes for the specified location.
      operationId: GETv3_locations_{locationId}_notes?privateNotes={privateNotes}
      parameters:
      - name: locationId
        in: path
        description: Unique ID of the location you want to receive notes for.
        required: true
        schema:
          type: integer
          format: int32
      - name: privateNotes
        in: query
        description: Should privateNotes be included. Settings from dashboardSetup by default
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Location notes are in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.LocationNote.LocationNote'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.LocationNote.LocationNote'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\n            <br/>Error codes:\n            601 — Location not found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 - API call rejected by security permissions"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    post:
      tags:
      - Locations
      summary: Add a location note
      description: "Adds a location note for the specified location. If a note is already added, you can change it by sending the request, or leave the `Value` parameter empty to delete the note.\n             <br /> To retrieve location IDs along with the location notes, send either of these requests: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\n             Get location notes separately for the specified location by sending the [GET/locations/{locationId}/notes](/swagger/ui/index?version=3#/Locations/GETv3_locations__locationId__notes) request.\n             <br />***Note***: Method is available for users with the *Super Admin* or *Admin* roles, or the *Location Admin* permission.\n             <br /> **Example request**\n            \n                 POST /locations/{locationId}/notes\n                 {\n                   \"Header\": \"Location Manager\",\n                   \"Value\": \"John Smith\"\n                 }"
      operationId: POSTv3_locations_{locationId}_notes
      parameters:
      - name: locationId
        in: path
        description: Unique ID of the location you want to update a note for.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The note is added to the specified location.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\n            <br/>Error codes:\n            601 — Location is not found\n            1301 — Request is empty or null"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 — API call rejected by security permissions"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n            <br/>Error codes:\n            100 — User has no rights to perform this action\n            612 — The user does not have access to update a protected location note header"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\n            <br/>Error codes:\n            611 — The location note header does not exist on the subscriber instance"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 — Object reference not set to an instance of an object"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeaderApiModelRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeaderApiModelRequest'
        description: Request to add, update or delete a location note header for a location.
        required: true
  /locations/{storeId}/updateNotes:
    post:
      tags:
      - Locations
      summary: Add location notes
      description: "Add location notes for the specified location. If a note is already added, you can change it by sending the request, or leave the `Value` parameter empty to delete the note.\n             <br /> ***Note***: To retrieve store IDs along with the location notes, send either of these requests: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\n             Get location notes separately for the specified location by sending the [GET/locations/{locationId}/notes](/swagger/ui/index?version=3#/Locations/GETv3_locations__locationId__notes) request.\n             <br /> **Example request**\n            \n                 POST /locations/{storeId}/updateNotes\n                 {\n                    \"Notes\": [\n                        {\n                            \"Header\": \"Note1\",\n                            \"Value\": \"1\"\n                        },\n                        {\n                            \"Header\": \"Note2\",\n                            \"Value\": \"2\"\n                        }\n                    ]\n                 }"
      operationId: POSTv3_locations_{storeId}_updateNotes
      parameters:
      - name: storeId
        in: path
        description: Unique storeId of the location you want to update a note for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The note is added to the specified location.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\n            <br/>Error codes:\n            601 — Location is not found\n            1301 — Request is empty or null"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 — API call rejected by security permissions"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n            <br/>Error codes:\n            100 — User has no rights to perform this action\n            612 — The user does not have access to update a protected location note header"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\n            <br/>Error codes:\n            611 — The location note header does not exist on the subscriber instance"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 — Object reference not set to an instance of an object"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeadersApiModelRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeadersApiModelRequest'
        description: Request to add, update or delete a location note headers for a location.
        required: true
  /locations/UnassignedContracts:
    get:
      tags:
      - Locations
      summary: Get unassigned contracts
      description: "Returns subscriber’s locations with open trades that have unassigned providers.\n            <br /> ***Note***: Method could be outdated causing faulty results."
      operationId: GETv3_locations_UnassignedContracts
      responses:
        '200':
          description: The requested locations are in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.GetProviderAssignmentExtendedLocationsResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.Location.GetProviderAssignmentExtendedLocationsResponse'
        '400':
          description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\n            <br/>Error codes:\n            504 — API call rejected by security permissions"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: The requested resource does not exist on the server.
      deprecated: false
      x-access: Any
  /locations/{locationId}/evacuationmaps:
    get:
      tags:
      - Locations
      summary: Get an evacuation plan map of a location
      description: "Returns evacuation plan map attachments details for the specified location.\n            <br /> Visit ServiceChannel University to learn about [Location Emergency Evacuation Plan Map(s)](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/710312376/Location+Emergency+Evacuation+Plan+Map+s)."
      operationId: GETv3_locations_{locationId}_evacuationmaps
      parameters:
      - name: locationId
        in: path
        description: Unique numeric identifier of the location to return the details for.
        re

# --- truncated at 32 KB (212 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-locations-api-openapi.yml