OneRail Shipper Contract SLA Template API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard Shipper Contract SLA Template API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: Shipper Contract SLA Template
paths:
  /v1/shipper-contract-sla-template/{shipperContractSlaTemplateId}:
    parameters:
    - name: shipperContractSlaTemplateId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Get Shipper Contract SLA Template
      operationId: getShipperContractSlaTemplate
      tags:
      - Shipper Contract SLA Template
      responses:
        '200':
          description: Shipper Contract SLA Template
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v1~1shipper-contract-sla~1%7BshipperContractSlaId%7D~1template/get/responses/200/content/application~1json/schema'
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
    put:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Update Shipper Contract SLA Template
      operationId: updateShipperContractSlaTemplate
      tags:
      - Shipper Contract SLA Template
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Shipper Contract SLA Template
              properties:
                marketModifiers:
                  type: array
                  description: List of market modifiers
                  items:
                    $ref: '#/paths/~1v1~1lp-contract-sla~1%7BlpContractSlaId%7D/put/requestBody/content/application~1json/schema/properties/marketModifiers/items'
                deliveryPremium:
                  $ref: '#/paths/~1v1~1lp-contract-sla~1%7BlpContractSlaId%7D/put/requestBody/content/application~1json/schema/properties/deliveryPremium'
                milageTiers:
                  type: array
                  items:
                    $ref: '#/paths/~1v1~1lp-contract-sla~1%7BlpContractSlaId%7D/put/requestBody/content/application~1json/schema/properties/milageTiers/items'
                deliveryCorrectionCharges:
                  type: array
                  items:
                    $ref: '#/paths/~1v1~1lp-contract-sla~1%7BlpContractSlaId%7D/put/requestBody/content/application~1json/schema/properties/deliveryCorrectionCharges/items'
                fleetVehicleModifiers:
                  type: array
                  items:
                    $ref: '#/paths/~1v1~1lp-contract-sla~1%7BlpContractSlaId%7D/put/requestBody/content/application~1json/schema/properties/fleetVehicleModifiers/items'
                routeCostConfigurations:
                  type:
                  - array
                  - 'null'
                  items:
                    $ref: '#/paths/~1v1~1lp-contract-sla~1%7BlpContractSlaId%7D/put/requestBody/content/application~1json/schema/properties/routeCostConfigurations/items'
      responses:
        '200':
          description: Shipper Contract SLA
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v1~1shipper-contract~1%7BshipperContractId%7D~1sla/post/responses/200/content/application~1json/schema'
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/shipper-contract-sla-template/{shipperContractSlaTemplateId}/submit-approval:
    parameters:
    - name: shipperContractSlaTemplateId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Notify OneRail Approver to approve Template SLA
      operationId: approveNotifyShipperContractSlaTemplate
      tags:
      - Shipper Contract SLA Template
      requestBody:
        description: None
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: True or false
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/shipper-contract-sla-template/{shipperContractSlaTemplateId}/approve:
    parameters:
    - name: shipperContractSlaTemplateId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Approve an SLA Template
      operationId: approveShipperContractSlaTemplate
      tags:
      - Shipper Contract SLA Template
      requestBody:
        description: None
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Approve SLA Template
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v1~1shipper-contract-sla~1%7BshipperContractSlaId%7D~1template/get/responses/200/content/application~1json/schema'
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/shipper-contract-sla-template/{shipperContractSlaTemplateId}/generate-lp-contract-sla:
    parameters:
    - name: shipperContractSlaTemplateId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Matches LPs and generates SLA Contracts for each of matched LP,
      operationId: generateLPContractSla
      tags:
      - Shipper Contract SLA Template
      requestBody:
        description: None
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Successfully matched and generated SLA contracts for matching LPs
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/shipper-contract-sla-template/bulk-approve:
    post:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Bulk approve an SLA Template
      operationId: bulkApproveShipperContractSlaTemplates
      tags:
      - Shipper Contract SLA Template
      requestBody:
        description: None
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Shipper Contract SLA Template ids
              properties:
                shipperContractSlaTemplateIds:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Approve SLA Template
          content:
            application/json:
              schema:
                type: object
                description: List of bulk SLA approval info
                properties:
                  approvals:
                    type: array
                    description: SLA Template approval info
                    items:
                      $ref: '#/paths/~1v1~1shipper-contract-sla~1%7BshipperContractSlaId%7D~1template/get/responses/200/content/application~1json/schema'
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/shipper-contract-sla-template/bulk-send-templates:
    post:
      x-exegesis-controller: ShipperContractSlaTemplate
      summary: Send Bulk SLA Templates,
      operationId: bulkSendTemplates
      tags:
      - Shipper Contract SLA Template
      requestBody:
        description: None
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Shipper Contract SLA Template ids
              properties:
                shipperContractSlaTemplateIds:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Successfully matched and sent bulk template slas
          content:
            application/json:
              schema:
                type: object
                description: List of bulk SLA template info
                properties:
                  success:
                    type: array
                    items:
                      type: string
                  failed:
                    type: array
                    items:
                      type: string
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Standard JWT bearer token used for authenticated OmniPoint users

        and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`

        and the token is validated using the shared Core access token secret.

        '
    ApiKey:
      type: apiKey
      in: header
      name: X-ONERAIL-API-KEY
      description: 'Shared secret key used for machine-to-machine integrations. Must be sent

        together with `X-ONERAIL-APP-ID` and is validated against the stored ApiAuth

        record for that application.

        '
    AppId:
      type: apiKey
      in: header
      name: X-ONERAIL-APP-ID
      description: 'Application identifier (UUID) that pairs with `X-ONERAIL-API-KEY` for

        machine-to-machine integrations. Both headers are required for ApiKey-based

        authentication.

        '
    OAuth:
      type: oauth2
      description: 'OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed

        integrations). Clients obtain tokens from their own IdP outside of this API

        and call endpoints with `Authorization: OAuth <access_token>`. The

        `authorizationUrl` and `tokenUrl` values below are placeholders only to

        satisfy the OpenAPI schema; this service does not call them directly and the

        real IdP URLs are configured via environment and introspection logic in code.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://dummy-unused-url.com
          tokenUrl: https://dummy-unused-url.com
          scopes: {}