openapi: 3.1.0
info:
  title: U.S. Steel SteelTrack API
  description: >-
    The U.S. Steel SteelTrack platform provides internet-based customer applications
    for order management, inventory tracking, shipment history, material release, and
    test reporting. This API exposes the core SteelTrack capabilities for integration
    with customer ERP, supply chain, and procurement systems.
  version: '1.0'
  contact:
    name: U.S. Steel Customer Service
    url: https://www.ussteel.com/about-us/doing-business-with-u.-s.-steel
  x-generated-from: documentation
externalDocs:
  description: U.S. Steel Customer Solutions
  url: https://www.ussteel.com/about-us/doing-business-with-u.-s.-steel
servers:
  - url: https://steeltrack.ussteel.com/api
    description: SteelTrack Production
tags:
  - name: Orders
    description: Order status and summary reporting operations
  - name: Inventory
    description: Inventory tracking and management operations
  - name: Shipments
    description: Shipment history and tracking operations
  - name: Test Reports
    description: Physical, mechanical, and chemical test report operations
security:
  - bearerAuth: []
paths:
  /orders:
    get:
      operationId: listOrders
      summary: U.S. Steel SteelTrack List Orders
      description: >-
        Returns a list of orders with customizable filtering by facility, status,
        and date range. Supports sorting by multiple fields.
      tags:
        - Orders
      parameters:
        - name: facility
          in: query
          required: false
          description: Filter by production facility code.
          schema:
            type: string
          example: 'GH'
        - name: status
          in: query
          required: false
          description: Filter by order status.
          schema:
            type: string
            enum:
              - OPEN
              - IN_PRODUCTION
              - SHIPPED
              - CLOSED
              - CANCELLED
          example: 'OPEN'
        - name: customerId
          in: query
          required: false
          description: Filter by customer ID.
          schema:
            type: string
          example: 'CUST-001234'
        - name: fromDate
          in: query
          required: false
          description: Start date for order date range filter (YYYY-MM-DD).
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: toDate
          in: query
          required: false
          description: End date for order date range filter (YYYY-MM-DD).
          schema:
            type: string
            format: date
          example: '2025-03-31'
        - name: limit
          in: query
          required: false
          description: Maximum number of results to return.
          schema:
            type: integer
            minimum: 1
            maximum: 500
          example: 50
        - name: offset
          in: query
          required: false
          description: Number of results to skip for pagination.
          schema:
            type: integer
            minimum: 0
          example: 0
      responses:
        '200':
          description: Orders returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderList'
              examples:
                ListOrders200Example:
                  summary: Default listOrders 200 response
                  x-microcks-default: true
                  value:
                    total: 2
                    orders:
                      - orderId: 'ORD-2025-001234'
                        customerId: 'CUST-001234'
                        purchaseOrder: 'PO-2025-5678'
                        status: 'IN_PRODUCTION'
                        facility: 'GH'
                        product: 'Hot-Rolled Coil'
                        quantity: 50.0
                        quantityUnit: 'tons'
                        orderDate: '2025-01-15'
                        requiredDate: '2025-03-01'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orders/{orderId}:
    get:
      operationId: getOrder
      summary: U.S. Steel SteelTrack Get Order
      description: >-
        Returns detailed information for a specific order including line items,
        production status, and delivery details.
      tags:
        - Orders
      parameters:
        - name: orderId
          in: path
          required: true
          description: The unique order identifier.
          schema:
            type: string
          example: 'ORD-2025-001234'
      responses:
        '200':
          description: Order details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
              examples:
                GetOrder200Example:
                  summary: Default getOrder 200 response
                  x-microcks-default: true
                  value:
                    orderId: 'ORD-2025-001234'
                    customerId: 'CUST-001234'
                    purchaseOrder: 'PO-2025-5678'
                    status: 'IN_PRODUCTION'
                    facility: 'Gary Works'
                    product: 'Hot-Rolled Coil'
                    grade: 'A36'
                    quantity: 50.0
                    quantityUnit: 'tons'
                    orderDate: '2025-01-15'
                    requiredDate: '2025-03-01'
                    estimatedDeliveryDate: '2025-02-28'
        '404':
          description: Order not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /inventory:
    get:
      operationId: listInventory
      summary: U.S. Steel SteelTrack List Inventory
      description: >-
        Returns on-hand inventory available for the customer, filterable by
        product, grade, and facility. Supports sorting by multiple fields including
        OP, customer, PO, and part number.
      tags:
        - Inventory
      parameters:
        - name: customerId
          in: query
          required: false
          description: Filter by customer ID.
          schema:
            type: string
          example: 'CUST-001234'
        - name: product
          in: query
          required: false
          description: Filter by product type.
          schema:
            type: string
          example: 'Cold-Rolled Coil'
        - name: grade
          in: query
          required: false
          description: Filter by steel grade.
          schema:
            type: string
          example: 'IF'
        - name: facility
          in: query
          required: false
          description: Filter by production facility.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Maximum number of results to return.
          schema:
            type: integer
          example: 100
        - name: offset
          in: query
          required: false
          description: Pagination offset.
          schema:
            type: integer
          example: 0
      responses:
        '200':
          description: Inventory list returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryList'
              examples:
                ListInventory200Example:
                  summary: Default listInventory 200 response
                  x-microcks-default: true
                  value:
                    total: 1
                    items:
                      - itemId: 'INV-CR-001234'
                        customerId: 'CUST-001234'
                        orderId: 'ORD-2025-001234'
                        product: 'Cold-Rolled Coil'
                        grade: 'IF'
                        coilId: 'COIL-8765432'
                        weight: 28.5
                        weightUnit: 'tons'
                        location: 'Gary Works'
                        status: 'AVAILABLE'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /shipments:
    get:
      operationId: listShipments
      summary: U.S. Steel SteelTrack List Shipments
      description: >-
        Returns shipment history searchable by order item, part number, and purchase
        order, with optional coil-level detail.
      tags:
        - Shipments
      parameters:
        - name: orderId
          in: query
          required: false
          description: Filter by order ID.
          schema:
            type: string
          example: 'ORD-2025-001234'
        - name: purchaseOrder
          in: query
          required: false
          description: Filter by purchase order number.
          schema:
            type: string
          example: 'PO-2025-5678'
        - name: fromDate
          in: query
          required: false
          description: Start date for shipment date range.
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: toDate
          in: query
          required: false
          description: End date for shipment date range.
          schema:
            type: string
            format: date
          example: '2025-03-31'
        - name: includeCoilDetail
          in: query
          required: false
          description: Whether to include coil-level detail in the response.
          schema:
            type: boolean
          example: false
        - name: limit
          in: query
          required: false
          description: Maximum number of results to return.
          schema:
            type: integer
          example: 50
      responses:
        '200':
          description: Shipments returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShipmentList'
              examples:
                ListShipments200Example:
                  summary: Default listShipments 200 response
                  x-microcks-default: true
                  value:
                    total: 1
                    shipments:
                      - shipmentId: 'SHIP-2025-9876'
                        orderId: 'ORD-2025-001234'
                        purchaseOrder: 'PO-2025-5678'
                        shipDate: '2025-02-14'
                        carrier: 'Rail'
                        destination: 'Detroit, MI'
                        weight: 50.0
                        weightUnit: 'tons'
                        status: 'DELIVERED'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /test-reports:
    get:
      operationId: listTestReports
      summary: U.S. Steel SteelTrack List Test Reports
      description: >-
        Returns physical, mechanical, and chemical test reports for steel products.
        Includes certified test reports with electronic signatures.
      tags:
        - Test Reports
      parameters:
        - name: coilId
          in: query
          required: false
          description: Filter by coil ID.
          schema:
            type: string
          example: 'COIL-8765432'
        - name: orderId
          in: query
          required: false
          description: Filter by order ID.
          schema:
            type: string
          example: 'ORD-2025-001234'
        - name: reportType
          in: query
          required: false
          description: Filter by test report type.
          schema:
            type: string
            enum:
              - MECHANICAL
              - CHEMICAL
              - PHYSICAL
              - ALL
          example: 'ALL'
      responses:
        '200':
          description: Test reports returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestReportList'
              examples:
                ListTestReports200Example:
                  summary: Default listTestReports 200 response
                  x-microcks-default: true
                  value:
                    total: 1
                    reports:
                      - reportId: 'RPT-2025-4321'
                        coilId: 'COIL-8765432'
                        orderId: 'ORD-2025-001234'
                        product: 'Cold-Rolled Coil'
                        grade: 'IF'
                        reportType: 'MECHANICAL'
                        certified: true
                        reportDate: '2025-02-10'
                        yieldStrength: 34
                        tensileStrength: 47
                        elongation: 44
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication for SteelTrack API.
  schemas:
    Order:
      type: object
      description: A U.S. Steel customer order.
      properties:
        orderId:
          type: string
          description: Unique order identifier.
          example: 'ORD-2025-001234'
        customerId:
          type: string
          description: Customer account identifier.
          example: 'CUST-001234'
        purchaseOrder:
          type: string
          description: Customer purchase order number.
          example: 'PO-2025-5678'
        status:
          type: string
          description: Current order status.
          enum:
            - OPEN
            - IN_PRODUCTION
            - SHIPPED
            - CLOSED
            - CANCELLED
          example: 'IN_PRODUCTION'
        facility:
          type: string
          description: Production facility name or code.
          example: 'Gary Works'
        product:
          type: string
          description: Steel product type.
          example: 'Hot-Rolled Coil'
        grade:
          type: string
          description: Steel grade designation.
          example: 'A36'
        quantity:
          type: number
          description: Order quantity.
          example: 50.0
        quantityUnit:
          type: string
          description: Unit of measure for quantity.
          example: 'tons'
        orderDate:
          type: string
          format: date
          description: Date the order was placed.
          example: '2025-01-15'
        requiredDate:
          type: string
          format: date
          description: Customer required delivery date.
          example: '2025-03-01'
        estimatedDeliveryDate:
          type: string
          format: date
          description: Estimated delivery date from US Steel.
          example: '2025-02-28'
    OrderList:
      type: object
      description: Paginated list of orders.
      properties:
        total:
          type: integer
          description: Total number of matching orders.
          example: 25
        orders:
          type: array
          description: List of order records.
          items:
            $ref: '#/components/schemas/Order'
    InventoryItem:
      type: object
      description: An inventory item available to the customer.
      properties:
        itemId:
          type: string
          description: Unique inventory item identifier.
          example: 'INV-CR-001234'
        customerId:
          type: string
          description: Customer account identifier.
          example: 'CUST-001234'
        orderId:
          type: string
          description: Associated order identifier.
          example: 'ORD-2025-001234'
        product:
          type: string
          description: Steel product type.
          example: 'Cold-Rolled Coil'
        grade:
          type: string
          description: Steel grade designation.
          example: 'IF'
        coilId:
          type: string
          description: Individual coil identifier.
          example: 'COIL-8765432'
        weight:
          type: number
          description: Item weight.
          example: 28.5
        weightUnit:
          type: string
          description: Weight unit.
          example: 'tons'
        location:
          type: string
          description: Storage or production facility location.
          example: 'Gary Works'
        status:
          type: string
          description: Inventory item availability status.
          enum:
            - AVAILABLE
            - RESERVED
            - IN_TRANSIT
            - ON_HOLD
          example: 'AVAILABLE'
    InventoryList:
      type: object
      description: Paginated list of inventory items.
      properties:
        total:
          type: integer
          description: Total number of inventory items.
          example: 15
        items:
          type: array
          description: List of inventory items.
          items:
            $ref: '#/components/schemas/InventoryItem'
    Shipment:
      type: object
      description: A shipment record for a steel order.
      properties:
        shipmentId:
          type: string
          description: Unique shipment identifier.
          example: 'SHIP-2025-9876'
        orderId:
          type: string
          description: Associated order identifier.
          example: 'ORD-2025-001234'
        purchaseOrder:
          type: string
          description: Customer purchase order number.
          example: 'PO-2025-5678'
        shipDate:
          type: string
          format: date
          description: Date the order was shipped.
          example: '2025-02-14'
        carrier:
          type: string
          description: Carrier type used for shipment.
          enum:
            - Rail
            - Truck
            - Barge
            - Intermodal
          example: 'Rail'
        destination:
          type: string
          description: Destination city and state.
          example: 'Detroit, MI'
        weight:
          type: number
          description: Shipment total weight.
          example: 50.0
        weightUnit:
          type: string
          description: Weight unit.
          example: 'tons'
        status:
          type: string
          description: Shipment delivery status.
          enum:
            - DISPATCHED
            - IN_TRANSIT
            - DELIVERED
            - EXCEPTION
          example: 'DELIVERED'
    ShipmentList:
      type: object
      description: Paginated list of shipments.
      properties:
        total:
          type: integer
          description: Total number of matching shipments.
          example: 10
        shipments:
          type: array
          description: List of shipment records.
          items:
            $ref: '#/components/schemas/Shipment'
    TestReport:
      type: object
      description: A physical, mechanical, or chemical test report for a steel product.
      properties:
        reportId:
          type: string
          description: Unique test report identifier.
          example: 'RPT-2025-4321'
        coilId:
          type: string
          description: Coil or material identifier.
          example: 'COIL-8765432'
        orderId:
          type: string
          description: Associated order identifier.
          example: 'ORD-2025-001234'
        product:
          type: string
          description: Steel product type.
          example: 'Cold-Rolled Coil'
        grade:
          type: string
          description: Steel grade designation.
          example: 'IF'
        reportType:
          type: string
          description: Type of test report.
          enum:
            - MECHANICAL
            - CHEMICAL
            - PHYSICAL
          example: 'MECHANICAL'
        certified:
          type: boolean
          description: Whether this is a certified test report with electronic signature.
          example: true
        reportDate:
          type: string
          format: date
          description: Date the test report was issued.
          example: '2025-02-10'
        yieldStrength:
          type: number
          description: Yield strength in ksi.
          example: 34
        tensileStrength:
          type: number
          description: Tensile strength in ksi.
          example: 47
        elongation:
          type: number
          description: Elongation percentage.
          example: 44
    TestReportList:
      type: object
      description: Paginated list of test reports.
      properties:
        total:
          type: integer
          description: Total number of matching test reports.
          example: 5
        reports:
          type: array
          description: List of test report records.
          items:
            $ref: '#/components/schemas/TestReport'
    Error:
      type: object
      description: API error response.
      properties:
        code:
          type: string
          description: Error code.
          example: 'INVALID_REQUEST'
        message:
          type: string
          description: Human-readable error message.
          example: 'Invalid order ID format'
        details:
          type: string
          description: Additional error details.