Locus ServiceTypeConfiguration API

The ServiceTypeConfiguration API from Locus — 1 operation(s) for servicetypeconfiguration.

OpenAPI Specification

locus-sh-servicetypeconfiguration-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Locus HomebaseMaster ServiceTypeConfiguration API
  description: Manage your deliveries with the Locus API
  version: 1.0.0
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: ServiceTypeConfiguration
paths:
  /client/{clientId}/service-type/{serviceTypeId}/disable:
    parameters:
    - $ref: '#/parameters/ClientIdParam'
    - $ref: '#/parameters/ServiceTypeIdParam'
    post:
      description: Disable a specific service type
      operationId: disableServiceType
      tags:
      - ServiceTypeConfiguration
      responses:
        '200':
          description: Updated service type object
          schema:
            $ref: '#/definitions/ServiceTypeConfiguration'
      security:
      - locusauth: []
definitions:
  ServiceTypeConfiguration:
    description: Service type model a specific delivery service
    allOf:
    - $ref: '#/definitions/CreateServiceTypeRequest'
    - type: object
  CreateServiceTypeRequest:
    description: Create service type
    allOf:
    - $ref: '#/definitions/EntityDefinition'
    - type: object
      required:
      - serviceTypeId
      - serviceTypeName
      - orderTypes
      - maxDeliveryDays
      - maxDeliveryTime
      properties:
        orderType:
          $ref: '#/definitions/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: '#/definitions/Amount'
        serviceSubType:
          $ref: '#/definitions/ServiceSubType'
  ServiceSubType:
    type: string
    enum:
    - NO_OF_DAYS_PLUS_TIME
    - NO_OF_DAYS
    - NO_OF_DAYS_PLUS_SLOT
  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
parameters:
  ClientIdParam:
    name: clientId
    in: path
    description: Id of the client
    required: true
    type: string
  ServiceTypeIdParam:
    name: serviceTypeId
    in: path
    description: Id of the service type
    required: true
    type: string
securityDefinitions:
  locusauth:
    type: basic
    description: HTTP Basic Authentication
  apiKeyAuth:
    type: apiKey
    in: header
    name: Authorization