Locus

Locus ServiceType API

The ServiceType API from Locus — 1 operation(s) for servicetype.

Documentation GitHub OpenAPI

Operations 2

GET /client/{clientId}/service-type/{serviceTypeId} Get service type #

PUT /client/{clientId}/service-type/{serviceTypeId} Create service type #

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/locus-sh-servicetype-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

openapi: 3.2.0
info:
  title: Locus HomebaseMaster Service Type API
  description: Manage your deliveries with the Locus API
  version: 1.0.0
servers:
- url: https://oms.locus-api.com/v1
tags:
- name: ServiceType
paths:
  /client/{clientId}/service-type/{serviceTypeId}:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/ServiceTypeIdParam'
    get:
      summary: Get service type
      operationId: getServiceType
      tags:
      - ServiceType
      responses:
        '200':
          description: Service type object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceTypeConfiguration'
      security:
      - locusauth: []
    put:
      summary: Create service type
      operationId: createServiceType
      parameters:
      - $ref: '#/components/parameters/OverwriteParam'
      tags:
      - ServiceType
      responses:
        '200':
          description: Created Service Type Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceTypeConfiguration'
      security:
      - locusauth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceTypeRequest'
        description: Create service type request
        required: true
components:
  schemas:
    Amount:
      description: Amount of an item
      properties:
        amount:
          type: number
          format: double
        currency:
          type: string
          description: Currency for the amount. Value should be one of the active codes of official ISO 4217 currency names. Examples are INR, USD, AED, GBP etc
        symbol:
          type: string
          description: A symbol for the currency. If missing, will default to currency string
    EntityDefinition:
      type: object
    OrderType:
      $ref: https://swagger.locus-api.com/oms.yaml#/definitions/OrderType
    ServiceSubType:
      type: string
      enum:
      - NO_OF_DAYS_PLUS_TIME
      - NO_OF_DAYS
      - NO_OF_DAYS_PLUS_SLOT
    CreateServiceTypeRequest:
      description: Create service type
      allOf:
      - $ref: '#/components/schemas/EntityDefinition'
      - type: object
        required:
        - serviceTypeId
        - serviceTypeName
        - orderTypes
        - maxDeliveryDays
        - maxDeliveryTime
        properties:
          orderType:
            $ref: '#/components/schemas/OrderType'
          teams:
            description: List of teams of carrier client to consider for this task assignment
            type: array
            items:
              type: string
          serviceabilityMapIds:
            description: List of zone ids that the service is serviceable to
            type: array
            items:
              type: string
          maxDeliveryDays:
            type: integer
            minimum: 0
            description: Maximum number of days allowed to fulfill the delivery.
          maxDeliveryTime:
            type: string
            pattern: ^([01]\d|2[0-3]):([0-5]\d)$
            description: Latest time by which the delivery should be completed, in 24-hour HH:MM format.
            example: '23:00'
          costOfService:
            $ref: '#/components/schemas/Amount'
          serviceSubType:
            $ref: '#/components/schemas/ServiceSubType'
    ServiceTypeConfiguration:
      description: Service type model a specific delivery service
      allOf:
      - $ref: '#/components/schemas/CreateServiceTypeRequest'
      - type: object
  parameters:
    ServiceTypeIdParam:
      name: serviceTypeId
      in: path
      description: Id of the service type
      required: true
      schema:
        type: string
    ClientIdParam:
      name: clientId
      in: path
      description: Id of the client
      required: true
      schema:
        type: string
    OverwriteParam:
      name: overwrite
      in: query
      description: Boolean flag if true, will overwrite the existing entity
      required: false
      schema:
        type: boolean
  securitySchemes:
    locusauth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization