OneRail Shipment ID API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard Shipment ID API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: shipmentId
paths:
  /v1/delivery/{deliveryId}/shipment-id-api:
    parameters:
    - name: deliveryId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      x-exegesis-controller: Delivery
      summary: Update the shipment ID of a delivery
      security:
      - ApiKey: []
      - AppId: []
      - OAuth: []
      operationId: updateShipmentIdFromApi
      tags:
      - shipmentId
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: string
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - shipmentId
              properties:
                shipmentId:
                  description: Shipment ID to update to. An empty string can be passed to clear out the shipment ID.
                  type: string
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: {}