openapi: 3.0.3
info:
  title: Advanced ship notice (ASN) push
  description: This API allows a user to receive detailed information regarding your shipment such as shipment racking number, carrier information, and commercial invoice, as they become available.  
  version: 2.0.0
  contact:
    name: API Support
    url: https://www.ti.com/developer-api/support.html
servers:
  - url: 'https://api-pre.customer123.com/v2'
    description: pre-production, sample URL for demonstration only, customer can decide on the naming standard for their own URL
  - url: 'https://api.customer123.com/v2'
    description: production, sample URL for demonstration only, customer can decide on the naming standard for their own URL

tags:
- name: Advanced ship notice
paths:
  /advanced-shipping-notifications/:
    post:
      tags:
        - Advanced ship notice
      requestBody:
        description: 'Endpoint to receive Advanced Ship Notifiation'
        required: true
        content:
          application/json:
            schema:
               $ref: '#/components/schemas/ASNReceive'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse'   
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse'
              example:
                status: "rejected"                   
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse' 
              example:
                status: "rejected"                   
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse' 
              example:
                status: "rejected"                   
        '500':
          description: System Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse'
              example:
                status: "rejected"                   
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ASNPushResponse'  
              example:
                status: "rejected"                                                                               
components:
  schemas:
    ASNReceive:
      description: Advanced Ship Notification retrieve response root object
      type: object
      properties:
        type:
          type: string
          description: Supplier document type
          example: asn
        data:
          type: object
          properties:
            consolidatedInformation:
              type: array
              minItems: 1
              items:
                $ref: "#/components/schemas/ConsolidatedInformation"
    ConsolidatedInformation:
      type: object
      properties:                  
        estimatedDateOfArrival:
          type: string
          description: Date when shipment is estimated to arrive at the destination (UTC, YYYY-MM-DD)
          format: date
          example: 2021-04-13
        goodsIssueDate:
          type: string
          description: Date when shipment goods are issued or processed to ship (UTC, YYYY-MM-DD)
          format: date
          example: 2021-04-09
        numberOfPallet:
          type: string
          description: Shipment number of pallets
          format: int32
          example: '1'
        grossWeight:
          type: string
          description: Shipment gross weight including packaging material
          format: decimal
          example: '2.450'
        grossWeightUnitOfMeasure:
          type: string
          description: Shipment gross weight unit of measure
          example: KG
        numberOfPieces:
          type: string
          description: Shipment number of boxes or cartons
          format: int32
          example: '2'
        netWeight:
          type: string
          description: Shipment weight of the product (gross weight minus packaging material weight)
          format: decimal
          example: '0.264'
        netWeightUnitOfMeasure:
          type: string
          description: Net weight unit of measure
          example: KG
        serviceLevelCode:
          type: string
          description: Carrier shipping service level code
          example: ABC
        productDescription:
          type: string
          description: Shipment product/material description
          example: ABC DEF GHI
        carrierShipmentMasterTrackingNumber:
          type: string
          description: Carrier shipment master tracking number
          example: '123456'
        carrierShipmentBoxTrackingNumber:
          type: string
          description: Carrier shipment box tracking number
          example: CUSTOMER XLR8
        shipDate:
          type: string
          description: Supplier processed shipment - actual goods issue date (UTC, YYYY-MM-DD)
          format: date
          example: 2021-04-09
        shippingPoint:
          type: string
          description: Supplier shipping plant or location 
          example: '1808'
        shippingCondition:
          type: string
          description: Shipping conditions, determined by carrier services and shipping points
          example: EG
        soldToNumber:
          type: string
          description: Supplier customer sold-to
          example: '0000123456'
        specialProcessingIndicator:
          type: string
          description: Special carrier processing like bulk, air, etc. used for expedites in the future
        modeOfTransport:
          type: string
          description: How the shipment is transported (i.e. sea, land, air, truck, train)
          example: '05'
        buyerCode:
          type: string
          description: Unique buyer code to be provided by the customer
          example: '12345'
        vendorCode:
          type: string
          description: Unique code that designates the shipper
          example: ABCDEFG
        shipTrackReference:
          type: string
          description: Supplier ship track reference
          example: '123456789012'
        soldToPartyName:
          type: string
          description: Supplier sold-to party name
          example: CUSTOMER CORPORATION
        shipmentInternalTransactionNumberList:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/ShipmentInternalTransactionNumber'
        forwardingAgentDetails:
          type: object
          description: Forwarding agent detail
          properties:
            companyName:
              type: string
              description: Shipper carrier name (i.e. FedEx, UPS, DB Schenker)
              example: XYZ
            standardCarrierAccessCode:
              type: string
              description: Shipper carrier code - Standard Carrier Alpha Code (SCAC)
              example: ABCD
            carrierIdentifier:
              type: string
              description: Supplier Code - Forwarder ZCAR
              example: '12345'
            carrierTrackingWebSite:
              type: string
              description: Supplier carrier tracking web site
              example: https://www.carrierxyz.com
        wayBillNumberList:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/WayBill'
        commercialInvoicelist:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/CommercialInvoice'
        shipToDetails:
          type: object
          description: Ship-to party details
          properties:
            plantIdentifier:
              type: string
              description: Customer ship-to plant identifier (Plant or Location)
              example: '00001234'
            companyName: 
              type: string
              description: Customer ship-to company name
              example: XYZ
            contactName:
              type: string
              description: Customer ship-to contact name 
              example: 010-234-2010
            address1:
              type: string
              description: Customer ship-to address 1
              example: 123 Main St
            address2:
              type: string
              description: Customer ship-to address 2
              example: ABC
            city:
              type: string
              description: Customer ship-to city
              example: Fort Worth
            state:
              type: string
              description: Customer ship-to state
              example: TX
            zipCode:
              type: string
              description: Customer ship-to zip code
              example: 12345-1234
            country:
              type: string
              description: Customer ship-to country
              example: US
            companyNameAdditionalDetail:
              type: string
              description: Customer ship-to company name additional detail
              example: ABCD
        shipFromDetails:
          type: object
          description: Ship from party details
          properties:
            plantIdentifier:
              type: string
              description: Supplier ship-from plant code or location 
              example: '00001234'
            companyName: 
              type: string
              description: Supplier ship-from company name
              example: Texas Instruments
            contactName:
              type: string
              description: Supplier ship-from contact name
              example: 010-234-2010
            address1:
              type: string
              description: Supplier ship-from address1
              example: 13601 Independence Parkway
            address2:
              type: string
              description: Supplier ship-from address2
              example: ABC
            city:
              type: string
              description: Supplier ship-from city
              example: Fort Worth
            state:
              type: string
              description: Customer ship-to state
              example: TX
            zipCode:
              type: string
              description: Customer ship-to zip code
              example: 12345-1234
            country:
              type: string
              description: Supplier ship-from country
              example: US
            email:
              type: string
              description: Supplier ship-from email address
              example: test@test.com
            phoneNumber: 
              type: string
              description: Supplier ship-from phone Number
              example: 010-101-2031
        crossDockDetails:
          type: object
          description: Supplier cross dock details
          properties:
            plantIdentifier:
              type: string
              description: Supplier cross dock plant code or airport code
              example: '00001234'
            companyName: 
              type: string
              description: Supplier cross dock company Name
              example: XYZ
            contactName:
              type: string
              description: Supplier cross dock contact name 
              example: 010-234-2010
            address1:
              type: string
              description: Supplier cross dock address1
              example: 123 Main St
            address2:
              type: string
              description: Supplier cross dock address2
              example: ABC
            city:
              type: string
              description: Supplier cross dock city
              example: Fort Worth
            state:
              type: string
              description: Customer ship-to state
              example: TX
            zipCode:
              type: string
              description: Customer ship-to zip code
              example: 12345-1234
            country:
              type: string
              description: Supplier cross dock country
              example: US
        importerDetails:
          type: object
          description: Importer details
          properties:
            companyName: 
              type: string
              description: Ultimate Consignee or Importer of Record (IOR) company name
              example: XYZ
            contactName:
              type: string
              description: Ultimate Consignee or Importer of Record contact name
              example: 010-234-2010
            address1:
              type: string
              description: Ultimate Consignee or Importer of Record address1
              example: 13601 Independence Parkway
            address2:
              type: string
              description: Ultimate Consignee or Importer of Record address2
              example: ABC
            city:
              type: string
              description: Ultimate Consignee or Importer of Record city
              example: Fort Worth
            state:
              type: string
              description: Customer ship-to state
              example: TX
            zipCode:
              type: string
              description: Customer ship-to zip code
              example: 12345-1234
            country:
              type: string
              description: Ultimate Consignee or Importer of Record country
              example: US
        manifestIdentifierList:
          type: object
          description: Manifest key number list
          properties:
            manifestIdentifier: 
              type: string
              description: Supplier system generated unique number assigned to a Bill of Landing
              example: '7890123456'
        bookingOrderDetails:
              type: array
              minItems: 1
              items:
                $ref: "#/components/schemas/BookingOrderDetails"
    ShipmentInternalTransactionNumber:
      type: object
      properties:
        shipmentInternalTransactionNumber:
          type: string
          description: The Internal Transaction Number is an Automated Export System (AES) generated number assigned to a shipment confirming that the EEI was accepted and is on file in the AES. This number should be placed on any loading document to allow the Customs and Border Protection (CBP) officer the ability to retrieve the shipment, if needed.
          example: '1234'
    WayBill:
      description: Supplier waybill
      type: object
      properties:
        waybillNumber:
          type: string
          description:  Unique waybill shipment number
          example: '5678901234'
        wayBillcreationDate:
          type: string
          description: Waybill shipment created date - actual shipment start date (UTC, YYYY-MM-DD)
          format: date
          example: 2021-04-08
        wayBillcreationTime:
          type: string
          description: Waybill shipment created Time - actual shipment start time (UTC, HH:MM:SS)
          format: time
          example: '09:15:08'
        waybillPDF:
          type: string
          description: Waybill PDF content (base64 encoded string)
    CommercialInvoice:
      description: Supplier commercial invoice
      type: object
      properties:
        commercialInvoiceNumber:
          type: string
          description: Commercial invoice used by customs in determining customs duties and to clear custom shipments.
          example: '987654321'
        commercialInvoiceDate:
          type: string
          description: Invoice create date (UTC, YYYY-MM-DD)
          format: date
          example: 2021-04-08
        commercialInvoiceTime:
          type: string
          description: Invoice create time (UTC, HH:MM:SS)
          format: time
          example: '22:32:40'
        incotermCode:
          type: string
          description: Incoterm value that specifies who is responsible for paying for and managing the shipment, insurance, documentation, customs clearance, and other logistical activities.
          example: DDP
        incotermDescription:
          type: string
          description: Description of incoterm value that specifies who is responsible for paying for and managing the shipment, insurance, documentation, customs clearance, and other logistical activities.
          example: Buyers Dock
        invoiceValue:
          type: string
          description: Invoice value of goods purchased
          format: decimal
          example: '100.100'
        invoiceCurrency:
          type: string
          description: Supplier currency used for the invoice amount
          example: USD
        commercialInvoicePDF:
          type: string
          description: Commercial invoice PDF content (base64 encoded string)
    BookingOrderDetails:
      description: Booking order details
      type: object
      properties:
        customerPurchaseOrderNumber:
          type: string
          description: Customer purchase order number
          example: T1234567
        customerPurchaseOrderDate:
          type: string
          description: Create date of purchase order (UTC, YYYY-MM-DD)
          format: date
          example: 2021-02-28
        passThrus:
            type: array
            minItems: 1
            items:
              $ref: "#/components/schemas/PassThru"
        packageDetails:
            type: array
            minItems: 1
            items:
              $ref: "#/components/schemas/Package"
    PassThru:
      type: object
      properties:
        orderNumber:
          type: string
          description: Supplier sales order number associated with shipment
          example: '1234567890'
        passThru1:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00001*URL=www.test.com
        passThru2:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00002*URL=www.test.com
        passThru3:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00003*URL=www.test.com
        passThru4:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00004*URL=www.test.com
        passThru5:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00005*URL=www.test.com
        passThru6:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00006*URL=www.test.com
        passThru7:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00007*URL=www.test.com
        passThru8:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00008*EML=test@test.com
        passThru9:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00009*URL=www.test.com
        passThru10:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00010*URL=www.test.com
        passThru11:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00011*URL=www.test.com
        passThru12:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00012*EML=test@test.com
        passThru13:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00013*URL=www.test.com
        passThru14:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00014*URL=www.test.com
        passThru15:
          type: string
          description: Customer specific data that needs to be sent back to customer in API Response
          example: ZREF*00015*URL=www.test.com
    Package:
      type: object
      properties:
        handlingUnitIdentifier:
          type: string
          description: Container unique identifier - license plate for that box
          example: '1234567890'
        containerVolume:
          type: string
          description: Package container volume
          format: decimal
          example: '0.000'
        packageContainerVolumeUnitOfMeasure:
          type: string
          description: Package container volume unit of measure
          example: 'CDM'
        length:
          type: string
          description: Package length
          format: decimal
          example: '0.000'
        width:
          type: string
          description: Package width
          format: decimal
          example: '0.000'
        height:
          type: string
          description: Package height
          format: decimal
          example: '0.000'
        LWHUnitOfMeasure:
          type: string
          description: Package unit of measure for length, width, and height
          example: MM
        trackingNumber:
          type: string
          description: Package tracking number
          example: '123456789012'
        numberOfLineItems:
          type: string
          description: Package number of line items
          format: Int32
          example: '0'
        alternateHandlingUnitIdentifier:
          type: string
          description: Contains alternate handling unit number
          example: 'ABCDEFGH'
        netWeight:
          type: string
          description: Package net weight
          format: decimal
          example: '0.000'
        grossWeight:
          type: string
          description: Package gross weight
          format: decimal
          example: '0.000'
        weightUnitOfMeasure:
          type: string
          description: Package weight unit of measure
          example: KG
        itemDetails:
          type: array
          minItems: 1
          items:
            $ref: "#/components/schemas/Item"
    Item:
      type: object
      properties:
        tiPartNumber:
          type: string
          description: Supplier Material Number
          example: TPS12345
        customerPartNumber:
          type: string
          description: Customer Part Number (CPN)
          example: ABCDEFG
        productDescription:
          type: string
          description: Supplier Material Description
          example: TPS12345 description
        deliveryLineItemNumber:
          type: string
          description: Supplier delivery line item number
          example: '000010'
        deliveryDocumentNumber:
          type: string
          description: Delivery document number created for the order line item
          example: '0123456789'
        orderNumber:
          type: string
          description: Supplier sales order number
          example: '1234567890'
        orderLineItemNumber:
          type: string
          description: Supplier sales order item number
          example: '000010'
        customerPurchaseOrderNumber:
          type: string
          description: Customer purchase order number
          example: T1234567
        customerLineItemNumber:
          type: string
          description: Customer purchase order item number
          example: '2'
        purchaseOrderDate:
          type: string
          description: Customer purchase order date (UTC, YYYY-MM-DD)
          format: date
          example: 2021-02-28
        numberOfUnitsShipped:
          type: string
          description: Number of products being shipped
          example: '000000000001'
        baseUnitOfMeasure:
          type: string
          description: Supplier item base unit of measure
          example: EA
        grossWeight:
          type: string
          description: Weight of the item including shipment package
          format: decimal
          example: '1.450'
        netWeight:
          type: string
          description: Weight of the item (gross weight minus packaging material weight)
          format: decimal
          example: '0.165'
        weightUnitOfMeasure:
          type: string
          description: Item weight unit of measure
          example: KG
        commercialInvoiceNumber:
          type: string
          description: Supplier commercial invoice number
          example: '987654321'
        commercialInvoiceItem:
          type: string
          description: Supplier commercial invoice item
          example: '000001'
        commercialInvoiceUnitprice:
          type: string
          description: Supplier commercial invoice unit price
          format: decimal
          example: '123.000000'
        commercialInvoiceValue:
          type: string
          description: Supplier commercial invoice value
          format: decimal
          example: '123.000000'
        commercialInvoiceCurrency:
          type: string
          description: Supplier commercial invoice currency
          example: USD
        countryOfOriginCode:
          type: string
          description: Supplier country of origin code
          example: PH
        countryOfOriginDescription:
          type: string
          description: Supplier country of origin description
          example: Philippines
        assemblyCountryOfOriginCode3Character:
          type: string
          description: Supplier assembly country of origin code (3 characters)
          example: PHL
        assemblyCountryOfOriginCode2Character:
          type: string
          description: Supplier assembly country of origin code (2 characters)
          example: PH
        assemblyCountryOfOriginDescription:
          type: string
          description: Supplier assembly country of origin description
          example: Philippines
        harmonizedTariffScheduleExportCode:
          type: string
          description: Supplier item harmonized tariff schedule export code
          example: '8901234567'
        harmonizedTariffScheduleExportDescription:
          type: string
          description: Supplier item harmonized tariff schedule export description
          example: Electronic Integrated Circuits, Other
        harmonizedTariffScheduleImportCode:
          type: string
          description: Supplier item harmonized tariff schedule import code
          example: '8901234567'
        harmonizedTariffScheduleImportDescription:
          type: string
          description: Supplier item harmonized tariff schedule export description
          example: Electronic Integrated Circuits, Other
        confirmDate:
          type: string
          description: Supplier item confirm date (UTC, YYYY-MM-DD)
          example: 2021-04-09
        orderType:
          type: string
          description: Supplier order type
          example: ZJR
        deliveryLineItemTotalQuantity:
          type: string
          description: Supplier delivery line item total quantity
          example: '24000.000'
        deliveryLineItemTotalQuantityUnitOfMeasure:
          type: string
          description: Supplier delivery line item total quantity unit of measure
          example: EA
        goodsIssueDate:
          type: string
          description: Supplier item goods issue date (UTC, YYYY-MM-DD)
          example: 2021-04-09
        goodsIssueTime:
          type: string
          description: Supplier item goods issue time (UTC, HH:MM:SS)
          example: '05:23:19'
        passThru1:
          type: string
          description: Customer item pass thru
          example: ZOI6*00001*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru2:
          type: string
          description: Customer item pass thru
          example: ZOI6*00002*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru3:
          type: string
          description: Customer item pass thru
          example: ZOI6*00003*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru4:
          type: string
          description: Customer item pass thru
          example: ZOI6*00004*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru5:
          type: string
          description: Customer item pass thru
          example: ZOI6*00005*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru6:
          type: string
          description: Customer item pass thru
          example: ZOI6*00006*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru7:
          type: string
          description: Customer item pass thru
          example: ZOI6*00007*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru8:
          type: string
          description: Customer item pass thru
          example: ZOI6*00008*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru9:
          type: string
          description: Customer item pass thru
          example: ZOI6*00009*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru10:
          type: string
          description: Customer item pass thru
          example: ZOI6*00010*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru11:
          type: string
          description: Customer item pass thru
          example: ZOI6*00011*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru12:
          type: string
          description: Customer item pass thru
          example: ZOI6*00012*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru13:
          type: string
          description: Customer item pass thru
          example: ZOI6*00013*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru14:
          type: string
          description: Customer item pass thru
          example: ZOI6*00014*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        passThru15:
          type: string
          description: Customer item pass thru
          example: ZOI6*00015*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206
        shipTrackCodeList:
          type: array
          minItems: 1
          items:
            $ref: "#/components/schemas/ShipTrackCode"
    ShipTrackCode:
      type: object
      properties:
        shipTrackCode:
          type: string
          description: Supplier ship track code
          example: 012345ABC
        alternateShipTrackCode:
          type: string
          description: Supplier alternate ship track code
          example: HIJKLM
        chipCountryOfOriginCode3Character:
          type: string
          description: Supplier chip country of origin code (3 characters)
          example: USA
        chipCountryOfOriginCode2Character:
          type: string
          description: Supplier chip country of origin code (2 characters)
          example: US
        chipCountryOfOriginDescription:
          type: string
          description: Supplier chip country of origin description
          example: USA
        shipTrackCodeQuantity:
          type: string
          description: Supplier item ship track code quantity
          example: '3000'
        batchNumber:
          type: string
          description: Supplier batch number
          example: 1234567PHI
        shipDate:
          type: string
          description: Supplier ship date (UTC, YYYY-MM-DD)
          example: 2021-04-08
        dateCode:
          type: string
          description: Supplier date code
          example: '2110'
        boxCount:
          type: string
          description: Supplier box count
          example: '2'              
        alternateTrackingIdentifier:
          type: string
          description: Supplier alternate tracking identifier
          example: ABCDEFGHIJK  
    ASNPushResponse:
      type: object    
      properties:
        status: 
          type: string
          maxLength: 20
          description: Status of this transaction.  Value should be accepted for success.
          example: accepted
          default: accepted