openapi: 3.0.2
info:
  title: Product information orchestrated API
  description: Open API spec for the TI product information orchestrated API. This API combines product, quality and parametric data calls into one call. TI does not recommend this API if you do not need all of that data, as this call is typically slower than the product information API.
  contact:
    name: API Support
    url: https://www.ti.com/developer-api/support.html
  version: "1.0"
servers:
  - url: 'https://transact.ti.com/v1'
    description: External production API Gateway
tags:
- name: Products extended
security:
  - Oauth: []
paths:
  /products-extended/{ProductIdentifier}:
    get:
      tags:
      - Products extended
      description: Get a specific product by its identifier
      operationId: getSpecificProductExtendedUsingGET
      parameters:
      - name: ProductIdentifier
        in: path
        description: The URL encoded unique identifier for the product
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orchestrated'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        405:
          description: Method Not Supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        429:
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        503:
          description: Temporarily Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PriceData:
      title: Price
      description: Price data including a price USD for a corresponding unit count for the purchase
      type: object
      properties:
        Quantity:
          type: integer
          description: The unit quantity for which the price value is determined
          format: int32
          example: 1000
        Value:
          type: number
          description: The price in dollars per unit
          format: double
          example: 1.0
    Product:
      title: Product
      description: Basic product attributes
      type: object
      properties:
        ChangeOrderWindow:
          type: string
          description: Window to change order
          example: STD
        DatasheetUrl:
          type: string
          description: Url for the datasheet for the product
          example: http://ti.com/lit/gpn/AFE7799
        Description:
          type: string
          description: The description of the product
          example: Quad-channel RF transceiver with dual feedback paths
        ExportControlClassificationNumber:
          type: string
          description: The Export Control Classification Number (ECCN) for this product
          example: EAR99
        ExtendedShelfLife:
          type: boolean
          description: Whether or not this product has an extended shelf life
          example: false
        FullBoxQty:
          type: integer
          description: The product quantity for a full box
          format: int32
          example: 126
        GenericProductIdentifier:
          type: string
          description: The unique identifier of the generic part number (a.k.a. Generic
            Part Identifier). Sometimes referred to as the base part number.
          example: AFE7799
        HtsCode:
          type: string
          description: The 10-digit Harmornized Tariff Schedule Code for this product
            - used for customs purposes
          example: "8542390001"
        Identifier:
          type: string
          description: The unique identifier of the product
          example: AFE7799IABJ
        IndustryPackageType:
          type: string
          description: The industry standard package type of the product
          example: NFBGA
        InventoryStatus:
          type: string
          description: The status of Texas Instrument's inventory for this product
          example: Contact TI
        JedecCode:
          type: string
          description: The JEDEC code assigned to this product
          example: S-PBGA-N
        LeadTimeWeeks:
          type: string
          description: The product lead time in weeks
          example: '8'
        Length:
          type: integer
          description: The length (mm) of the product
          format: int32
          example: 15
        LifeCycleStatus:
          type: string
          description: The lifecycle status of the product
          example: ACTIVE
        LifetimeBuy:
          type: boolean
          description: Whether or not this product is flagged for lifetime buy
          example: false
        MaterialContentUrl:
          type: string
          description: The URL to the material content site for this product. The
            page found at this URL will provide quality related information like RoHS,
            Reach, and IEC 62474 Compliance, as well as a breakdown of the material
            composition for the product with various standard formats supported.
          example: http://www.ti.com/materialcontent/en/search?partNumber=AFE7799IABJ&partType=tiPartNumber
        MaxHeight:
          type: number
          description: The max height (mm) of the product
          format: double
          example: 1.8
        MilitaryGoods:
          type: boolean
          description: Whether or not this product is used for military goods
          example: true
        MinOrderQty:
          type: integer
          description: The minimum order quantity (MOQ) of this product
          format: int32
          example: 630
        NextIncrementQty:
          type: integer
          description: Incremental quantity for orders of this product
          format: int32
          example: 126
        Obsolete:
          type: boolean
          description: Whether or not this product is flagged as obsolete
          example: false
        OkayToOrder:
          type: boolean
          description: Whether or not this product is okay to order
          example: true
        PackageCarrier:
          type: string
          description: The carrier for the package
          example: JEDEC TRAY (10+1)
        PackageGroup:
          type: string
          description: The TI package group for this product
          example: QFN
        PackageType:
          type: string
          description: The supplier package type of the product
          example: ZBV
        Pin:
          type: integer
          description: The pin count for the product
          format: int32
          example: 289
        Pitch:
          type: number
          description: The pitch (mm) of the product
          format: double
          example: 0.8
        Price:
          $ref: '#/components/schemas/PriceData'
        ProductFamilyDescription:
          type: string
          description: The description of the product family to which this product
            belongs
          example: RF-sampling transceivers
        QualityEstimatorUrl:
          type: string
          description: The URL to the quality estimator site for this product. The
            page found at this URL will provide quality related information like Defective
            Parts Per Million (DPPM), Mean Time Between Fails (MTBF), and Failures
            in Time (FIT) information for this product.
          example: http://www.ti.com/quality/docs/estimator.tsp?OPN=AFE7799IABJ&partNumber=AFE7799IABJ&partType=tiPartNumber
        StandardPackQty:
          type: integer
          description: The standard package quantity (SPQ) of this product
          format: int32
          example: 126
        StopShip:
          type: boolean
          description: Whether or not shipment is currently stopped for this product
          example: false
        Thickness:
          type: number
          description: The thickness (mm) of the product
          format: double
          example: 1.25
        Url:
          type: string
          description: The url of the product folder for this product
          example: http://www.ti.com/product/AFE7799
        Width:
          type: integer
          description: The width (mm) of the product
          format: int32
          example: 15
    Parametric:
      title: Parametric
      description: Parametric specification for a product
      type: object
      properties:
        Description:
          description: Brief description of the parameter
          type: string
        Range:
          $ref: '#/components/schemas/ParametricRange'
        Type:
          description: The parameter type
          type: string
        Unit:
          description: The unit of measurement for the parameter
          type: string
        UnitDescription:
          description: The description of the unit of measurement
          type: string
        Value:
          description: The value - if single value - for the parameter
          type: string
    ParametricRange:
      title: ParametricRange
      description: The range specifications of a parameter
      type: object
      properties:
        Min:
          description: The minimum value of the range
          type: string
        Max:
          description: The maximum value of the range
          type: string
    ProductQuality:
      title: ProductQuality
      description: Product quality data
      type: object
      properties:
        AutomotiveQualification:
          type: boolean
          description: The AEC Q10x qualification status of the product
        CommodityGroup:
          type: string
          description: The commodity group of the product
        DieSize:
          type: string
          description: The die size of the product via the X and Y dimensions
          example: '10.0 x 10.0 UM'
        DefectivePartsPerMillion:
          type: string
          description: The defective parts per million for the product
          example: '691'
        FailuresInTime:
          type: string
          description: The failures in time for the product
          example: '1.0'
        MeanTimeBetweenFailures:
          type: string
          description: The mean time between failures for the product
          example: '5390000000'
        ProcessTechnology:
          type: array
          description: The process technologies for the product
          items:
            type: string
    ErrorResponse:
      title: ErrorResponse
      description: ErrorResponse
      type: object
      required:
      - Errors
      properties:
        Errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Error'
    Error:
      title: Error
      description: Error
      type: object
      required:
      - Code
      - Message
      properties:
        Code:
          type: string
          maximum: 20
        Message:
          type: string
          maximum: 4000
    Orchestrated:
      title: Orchestrated API
      description: Combined API call to all of the endpoints - Product, Quality, and Parametric Data
      type: object
      required:
      - Product
      properties:
        Product:
          $ref: '#/components/schemas/Product'
        Quality:
          $ref: '#/components/schemas/ProductQuality' 
        Parametric:
          $ref: '#/components/schemas/Parametric' 
        Message:
          type: string
          maximum: 4000
  securitySchemes:
    Oauth:    # <---- arbitrary name
      type: oauth2
      description: 'This API uses OAuth 2 with the Client Credentials. More Information availible here: https://api-portal.ti.com/oauth-setup/'
      flows:
        clientCredentials: 
          tokenUrl: https://transact.ti.com/v1/oauth
          scopes: {}