API business guidebook

The TI backlog API order suite consists of: Quote, Order Management, Advanced Ship Notice (ASN) Retrieve, Financial Document Retrieve and Remittance Advice APIs. Push notification APIs are also available to automate data entry into the customer’s system. Please follow the instructions below for more details.

  1. End-to-end order flow  
  2. API default setup
    1. Synchronous response
      1. Within one API call, customer system would know whether TI processed the request fully and actual sales order has been changed in TI system successfully
    2. Partial PO creation and change allowed
      1. Correct API PO line item entry will be accepted while rejections will not be entered
      2. API order change will always be performed at the individual line item level
    3. Error handling
      1. Any error messages or informational warnings will be passed back in the API response, either at the order level or at the individual line item level
      2. With a full list of warning or error details, customer will have better control on how and when to correct the error and resubmit the request if needed
  3. Push APIs
    1. API push notifications are required to receive full advantage of TI's APIs
    2. To setup API push notifications for orders, advanced ship notices and financial documents, follow the instructions below
      1. Go to TI.com/support
      2. Select Open a new support request
      3. Select Direct customer order fulfillment
      4. Complete the API push form, attach and submit
  4. Quote API
    1. Backlog quote API enables customers to create quotes and receive responses for TI products. Customers can also retrieve quotes created previously
    2. Quote APIs can be utilized to request multiple quote line items at the same time for different manufacturer part numbers (MPNs). If the customer submits a quote with the same MPN on multiple line items, TI will only process the first instance of the MPN
    3. If the quantity requested when submitting a quote does not meet the minimum order value, minimum order quantity (MOQ) or standard pack quantity (SPQ) multiples, TI will round up to the nearest MOQ in quote response
  5. Order management API
    1. Order creation and change flow chart
    2. API order creation requirements
      1. Mandatory and optional fields for order creation
        Order Elements Mandatory / Optional Character Limitations
        Purchase order (PO) number Mandatory No more than 35 Characters;
        No space in PO number
        PO line item Mandatory  
        Manufacturer part number (MPN) Mandatory  
        Customer direct price (CDP) Mandatory No more than five (5) decimals
        Customer requested date (CRD) Mandatory  
        Quantity Mandatory  
        Customer part number (CPN) Optional  
        End customer Optional (Required for CM) UPPER CASE
      2. For each PO line item, only ONE single CRD is allowed
      3. For each PO line item under the same PO number, the item number should not be duplicated, otherwise the PO change will fail
      4. For each PO, multiple PO line items with same or different TI part numbers are both accepted
      5. For PO with “End Customer”, only materials for same end customer can be accepted under same PO number
      6. The quantity should be a multiple of the TI standard pack quantity (SPQ) and meet both the minimum order requirement (MOQ) and minimum item value (MIV) as is defined in the TI product catalog
    3. Order response rules
      1. For customers with partial delivery allowed, you may receive multiple schedule lines/Estimated Ship Date (ESD) per PO line item, depending on the availability of the product
    4. API order change requirements
      1. Types of order changes allowed
        • CRD pull in or push out
        • PO line item price update
        • PO line item quantity decrease
        • PO line item cancellation
      2. Period for order changes or cancellations
        • Change Order Window (COW) is defining the period of time when changes or cancellations are no longer authorized to process
          • STD (Standard) COW: 30 days
          • Non-STD (Non-Standard) COW: 90 days
        • TI rejects all changes within the COW except for CRD pull in and price change
        • COW Cancellations and Rescheduling Rules depends on the type of parts
          • For Products, Wafer Products and Die Products, Buyer may cancel or reschedule orders according to the following rules:
            Buyer-Requested Cancel or Reschedule Date Standard Products Non-Standard Products
            < 30 Days before ESD Not allowed Not allowed
            30-90 Days before ESD Allowed Not allowed
            > 90 Days before ESD Allowed Requires TI approval. Charges may apply.
            For Evaluation Items: Orders for Evaluation Items may not be cancelled or rescheduled.

            Notwithstanding the above rules, certain Items are subject to special cancellation and reschedule terms that TI will communicate to Buyer prior to order acceptance.
      3. Order change rules
        • Order changes are at the PO line item level
          • The sum of the schedule line quantities needs to match the PO line item’s total quantity even if customer wants to change only a particular schedule line
          • The full PO line item original quantity is not required only when the customer is requesting a quantity decrease in the PO line item
        • To increase PO line item quantity, create a new PO
        • PO line items that have shipped completely, with an advanced ship notice (ASN), cannot be changed
        • Ship to address change is allowed for both PO header and line item level on established customer ship to addresses within TI
        • Customer needs to update price on original PO line item via order change for new effective price
        • For customers with complete delivery setup, increasing the order qty may result in loss of ESD
    5. Order management warning and error handling
      1. If there is a price mismatch between CDP and TI's pricing agreement (PA), the result will be an incomplete order that is reviewed by both customer and TI
        • If CDP is correct, TI will refresh price - no action needed from customer
        • If TI price is correct, you will need to update CDP via order change, response will be sent back indicating if the price mismatch is resolved
      2. Order will not be created if there is SPQ/MOQ/MIV errors, correct the quantity and resend to TI as order creation
      3. For full list of error details, please check our detailed error lists:
  6. Advanced ship notice (ASN) API
    1. Backlog ASN retrieve API enables customers to retrieve detailed information regarding your shipment such as shipment tracking number, carrier information, and commercial invoice
  7. Financial document API
    1. Backlog financial document retrieve API enables customers to retrieve financial invoice information such as invoice number, invoice amount, and invoice date
  8. Remittance advice API
    1. Backlog remittance advice API gives authorized customers the ability to send remittance advice information that confirms payment details.
  9. User acceptance testing scenarios (UAT) to pass testing phase:
    1. Once the customer completes self-service testing scenarios 1.0 – 2.1, our GBO regional team will contact the admin email who has access to the API keys