Kuehne+Nagel Esp Order Track API

openapi: 3.2.0
info:
  title: OrderTracking Esp Order Track API
  description: Order tracking API scaffolding.
  contact:
    name: Kuehne+Nagel ESP Public API Development Team
    url: https://esp.kuehne-nagel.com
    email: webdev-esp-public-apis@kuehne-nagel.com
  version: v2
  x-api-id: 753906ff-e277-4f70-83c9-221c20d52b48
  x-api-guideline-version: 1.10.2
  x-api-version: 2.0.2
servers:
- url: https://internal.api.kuehne-nagel.com/track-trace/order/v2
security:
- default: []
tags:
- name: esp-order-track
paths:
  /orders-search:
    post:
      tags:
      - esp-order-track
      summary: Used by customers to search for purchase orders and their statuses in ESP.
      description: "- The search can be performed using either the attributes or the additionalReferences of an order. \n- The search uses \"AND\" to combine the attributes/additionalReferences.\n"
      operationId: orderTracking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderTrackingRequest'
            example:
              customerCode: CUSTC01
              purchaseOrderNumber: PO123456
              parties:
                customer:
                  partyCode: CUSTC01
                  address:
                    countryCode: CN
                    address1: 123 Main St
                    zipCode: '12345'
                    city: Anytown
                supplier:
                  partyCode: SUPP001
                  address:
                    countryCode: CN
                    address1: 456 Supplier St
                    zipCode: '67890'
                    name: Supplier Inc.
                    city: Supplier City
              attributes:
                orderIdentification:
                  purchaseOrderDate: '2024-07-30'
                  orderNumber: ORD123456
                  xdocksOrder: true
                orderPromotions:
                  season: Summer
                  advertisementCode: AD123456
                  advertisementDate: '2024-07-30'
                orderHandling:
                  orderStatus: In Progress
                orderTerms:
                  dutyPercentage: 5
                  paymentMethod: Credit Card
                  paymentTerms: Net 30
                divisions:
                  divisionCode: D001
                  division: Electronics
                  sourceChannel: Online
                  company: TechCorp
                transportation:
                  modeOfTransportation: SEA
                  destinationDeliveryWindow:
                    startDate: '2024-07-30'
                    endDate: '2024-07-30'
                  originalDestinationDeliveryWindow:
                    startDate: '2024-07-30'
                    endDate: '2024-07-30'
                itemDetails:
                  orderedQuantity:
                    amount: 100
                    unit: pcs
                  originalOrderedQuantity:
                    amount: 120
                    unit: pcs
                  packSize: 10
              additionalReferences:
              - code: 'ON'
                values:
                - ON-123456
                - ON-654321
              pageSize: 5
              page: 1
        required: true
      responses:
        '200':
          description: Orders found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderTrackingResponse'
              example:
                numberOfOrders: 1
                totalNumberOfOrders: 1
                purchaseOrders:
                - purchaseOrder:
                    purchaseOrderNumber: PO123456
                    parties:
                      customer:
                        partyCode: CUSTC01
                        address:
                          address1: 123 Main St
                          address2: Suite 100
                          zipCode: '12345'
                          city: Anytown
                          countryCode: CN
                          state: CA
                          stateCode: CA
                          postBox: PO123
                      supplier:
                        partyCode: SUPP001
                        address:
                          address1: 456 Supplier St
                          address2: Building 2
                          zipCode: '67890'
                          city: Supplier City
                          countryCode: US
                          name: Supplier Inc.
                          state: NY
                          stateCode: NY
                          postBox: PO456
                      factory:
                        partyCode: FACT001
                        address:
                          address1: 789 Factory Rd
                          address2: Unit 5
                          zipCode: '54321'
                          city: Factory Town
                          countryCode: US
                          name: Factory Co.
                          state: TX
                          stateCode: TX
                          postBox: PO789
                    orderHeader:
                      orderIdentification:
                        purchaseOrderDate: '2024-07-30'
                        orderNumber: ORD123456
                        orderDate: '2024-07-30'
                        invoiceNumber: INV123456
                        invoiceDate: '2024-07-30'
                        shipmentId: SHIP123456
                        shipmentDate: '2024-07-30'
                        contractNumber: CON123456
                        contractDate: '2024-07-30'
                        salesOrderNumber: SO123456
                        salesOrderDate: '2024-07-30'
                        deliveryNoteNumber: DN123456
                        deliveryNoteDate: '2024-07-30'
                        warehouseReceiptNumber: WR123456
                        warehouseReceiptDate: '2024-07-30'
                        commercialInvoiceNumber: CI123456
                        commercialInvoiceDate: '2024-07-30'
                        packingListNumber: PL123456
                        packingListDate: '2024-07-30'
                        deliveryTicketNumber: DT123456
                        deliveryTicketDate: '2024-07-30'
                        proformaInvoiceNumber: PI123456
                        proformaInvoiceDate: '2024-07-30'
                        transactionId: TX123456
                        transactionDate: '2024-07-30'
                        orderReleaseNumber: OR123456
                        orderReleaseDate: '2024-07-30'
                        raisedBy: John Doe
                        supplierReference: SUPPREF123456
                        workOrderNumber: WO123456
                        proformaOrderNumber: PO123456
                        allocationNumber: AL123456
                        supplierOrderNumber: SO123456
                        orderType: Stock
                        rebuyerOrder: true
                        xdocksOrder: true
                      itemIdentification:
                        europeanArticleNumber: EAN123456
                        lotNumber: LOT123456
                        catalogueNumber: CAT123456
                        partNumber: PART123456
                        packUniversalProductCode: UPC123456
                        materialNumber: MAT123456
                        productNumber: PROD123456
                        lineNumber: LINE123456
                        itemNumber: ITEM123456
                        factoryItemNumber: FACTITEM123456
                        supplierItemNumber: SUPPITEM123456
                        articleNumber: ART123456
                        barcode: BAR123456
                        stockKeepingUnitNumber: SKU123456
                        globalLocationNumber: GLN123456
                        batchNumber: BATCH123456
                        universalProductCode: UPC123456
                      itemAttributes:
                        style: Casual
                        color: Blue
                        shade: Navy
                        size: M
                        hsCode: HS123456
                        hsCodeOrigin: HSO123456
                        hsCodeDestination: HSD123456
                        commodity: Clothing
                        countryOfOrigin: US
                      productCategories:
                        productCategory: Apparel
                        productClass: Class A
                        productSegment: Segment 1
                        productFamily: Family 1
                        gender: Unisex
                        materialGroup: Cotton
                        productGroup: Group 1
                        schedulingLine: Line 1
                        setAndSequenceNumber: Set 1
                        stockCategory: Category 1
                        composition: 100% Cotton
                        seriesName: Series 1
                        seriesNumber: SN123456
                      productHandling:
                        dangerousGoods: false
                        polyamideAndMelamine: false
                        imoDangerousGoodsCode: IMDG123456
                        oversizeIndicator: false
                        overweightIndicator: false
                        productionLeadDuration: 30 days
                        selfInspect: true
                      orderPromotions:
                        season: Summer
                        advertisementCode: AD123456
                        advertisementDate: '2024-07-30'
                        campaign: Campaign 1
                        cancelDate: '2024-07-30'
                        eventCode: EV123456
                        processingDate: '2024-07-30'
                        catalogueStatus: Active
                        catalogueEdition: Edition 1
                      orderHandling:
                        notes1Internal: Internal note 1
                        notes2Internal: Internal note 2
                        orderHandlingNotes: Handle with care due to fragile items.
                        termsAndConditionsNotes: Payment due within 30 days.
                        supplierNote: Ensure packaging meets export standards.
                        factoryNote: Production to be completed by end of the week.
                        priorityFlag: false
                        orderReleased: true
                        fumigationRequired: true
                        qualityCheckRequired: true
                        qualityCheckPassed: true
                        serviceLevel: Express
                        orderStatus: In Progress
                        warehouseReceiptStatus: Pending
                        deliveryCompleteStatus: true
                        typeOfCertificateRequired: Certificate of Origin
                      orderTerms:
                        dutyPercentage: 5
                        paymentMethod: Credit Card
                        paymentTerms: Net 30
                        letterOfCreditNumber: LC123456789
                        letterOfCredit:
                          amount: 10000
                          currency: USD
                        letterOfCreditDate: '2024-07-30'
                      divisions:
                        divisionCode: D001
                        division: Electronics
                        businessUnit: Consumer Electronics
                        purchasingGroup: PG01
                        sourceChannel: Online
                        company: TechCorp
                        costCenter: CC1001
                        operatingCompany: TechCorp International
                        purchaseOffice: PO123
                        section: Retail
                        department: Sales
                        brand: TechBrand
                        buyer: John Doe
                        merchandiser: Jane Smith
                        departmentCode: DC01
                        merchandiseCategory: Gadgets
                        supplyPlanner: Alice Johnson
                        tradingTeam: Global Trading
                      transportation:
                        modeOfTransportation: SEA
                        portOfEntry: WFPWK
                        portOfLoading: XTBNF
                        portOfDischarge: SZ54U
                        placeOfDelivery: Warehouse 5
                        countryOfDeparture: ESBCN
                        countryOfDestination: FRPAR
                        incoterm: FOB
                        incotermLocation: Madrid
                        carrier: AirExpress
                        carrierContract: AX123456
                        shipmentType: FCL
                        movement: Direct
                        totalNumberOfContainers: 10
                        containerType: FCL
                        dayOfDeliveryDate: '2024-07-30'
                        originalDayOfDeliveryDate: '2024-07-30'
                        bookingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalBookingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalOriginDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        shippingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalShippingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        arrivalWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalArrivalWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        destinationDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalDestinationDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                      itemDetails:
                        orderedQuantity:
                          amount: 100
                          unit: pcs
                        itemNetWeight:
                          amount: 50
                          unit: kg
                        originalOrderedQuantity:
                          amount: 120
                          unit: pcs
                        packSize: 10
                      packageDetails:
                        quantityPerPackage: 10
                        expectedNumberOfPackages:
                          amount: 10
                          unit: bx
                        expectedPackageWeight:
                          amount: 5
                          unit: kg
                        expectedPackageVolume:
                          amount: 0.5
                          unit: m3
                        packageLength:
                          amount: 1
                          unit: m
                        packageWidth:
                          amount: 0.5
                          unit: m
                        packageHeight:
                          amount: 0.3
                          unit: m
                        itemPackaged: true
                      packingStructure:
                        quantityPerInnerPackage: 5
                        numberOfInnerPerOuter: 10
                        numberOfPackagesPerPallet: 50
                      pricing:
                        totalOrderValue:
                          amount: 5000
                          currency: USD
                        buyingPrice:
                          amount: 100
                          currency: USD
                        buyingPriceBase: Per Unit
                        sellingPrice:
                          amount: 150
                          currency: USD
                        ticketRetailPrice:
                          amount: 200
                          currency: USD
                        msrp:
                          amount: 250
                          currency: USD
                        originalBuyingPrice:
                          amount: 90
                          currency: USD
                      destinationWarehouseHandling:
                        casesPerPalletLayer: 5
                        layersPerPallet: 10
                        packType: Box
                        putawayUnitCode: PU123
                        putawayUnitName: Standard Box
                      customerSpecific:
                        string1: Customer Note 1
                        string2: Customer Note 2
                        string3: Customer Note 3
                        string4: Customer Note 4
                        string5: Customer Note 5
                        string6: Customer Note 6
                        string7: Customer Note 7
                        string8: Customer Note 8
                        string9: Customer Note 9
                        string10: Customer Note 10
                        bool1: true
                        bool2: false
                        bool3: true
                        bool4: false
                        bool5: true
                        bool6: false
                        bool7: true
                        bool8: false
                        bool9: true
                        bool10: false
                    orderLines:
                    - orderIdentification:
                        purchaseOrderDate: '2024-07-30'
                        orderNumber: ORD123456
                        orderDate: '2024-07-30'
                        invoiceNumber: INV123456
                        invoiceDate: '2024-07-30'
                        shipmentId: SHIP123456
                        shipmentDate: '2024-07-30'
                        contractNumber: CON123456
                        contractDate: '2024-07-30'
                        salesOrderNumber: SO123456
                        salesOrderDate: '2024-07-30'
                        deliveryNoteNumber: DN123456
                        deliveryNoteDate: '2024-07-30'
                        warehouseReceiptNumber: WR123456
                        warehouseReceiptDate: '2024-07-30'
                        commercialInvoiceNumber: CI123456
                        commercialInvoiceDate: '2024-07-30'
                        packingListNumber: PL123456
                        packingListDate: '2024-07-30'
                        deliveryTicketNumber: DT123456
                        deliveryTicketDate: '2024-07-30'
                        proformaInvoiceNumber: PI123456
                        proformaInvoiceDate: '2024-07-30'
                        transactionId: TX123456
                        transactionDate: '2024-07-30'
                        orderReleaseNumber: OR123456
                        orderReleaseDate: '2024-07-30'
                        raisedBy: John Doe
                        supplierReference: SUPPREF123456
                        workOrderNumber: WO123456
                        proformaOrderNumber: PO123456
                        allocationNumber: AL123456
                        supplierOrderNumber: SO123456
                        orderType: Stock
                        rebuyerOrder: true
                        xdocksOrder: true
                      itemIdentification:
                        europeanArticleNumber: EAN123456
                        lotNumber: LOT123456
                        catalogueNumber: CAT123456
                        partNumber: PART123456
                        packUniversalProductCode: UPC123456
                        materialNumber: MAT123456
                        productNumber: PROD123456
                        lineNumber: LINE123456
                        itemNumber: ITEM123456
                        factoryItemNumber: FACTITEM123456
                        supplierItemNumber: SUPPITEM123456
                        articleNumber: ART123456
                        barcode: BAR123456
                        stockKeepingUnitNumber: SKU123456
                        globalLocationNumber: GLN123456
                        batchNumber: BATCH123456
                        universalProductCode: UPC123456
                      itemAttributes:
                        style: Casual
                        color: Blue
                        shade: Navy
                        size: M
                        hsCode: HS123456
                        hsCodeOrigin: HSO123456
                        hsCodeDestination: HSD123456
                        commodity: Clothing
                        countryOfOrigin: US
                      productCategories:
                        productCategory: Apparel
                        productClass: Class A
                        productSegment: Segment 1
                        productFamily: Family 1
                        gender: Unisex
                        materialGroup: Cotton
                        productGroup: Group 1
                        schedulingLine: Line 1
                        setAndSequenceNumber: Set 1
                        stockCategory: Category 1
                        composition: 100% Cotton
                        seriesName: Series 1
                        seriesNumber: SN123456
                      productHandling:
                        dangerousGoods: false
                        polyamideAndMelamine: false
                        imoDangerousGoodsCode: IMDG123456
                        oversizeIndicator: false
                        overweightIndicator: false
                        productionLeadDuration: 30 days
                        selfInspect: true
                      orderPromotions:
                        season: Summer
                        advertisementCode: AD123456
                        advertisementDate: '2024-07-30'
                        campaign: Campaign 1
                        cancelDate: '2024-07-30'
                        eventCode: EV123456
                        processingDate: '2024-07-30'
                        catalogueStatus: Active
                        catalogueEdition: Edition 1
                      orderHandling:
                        notes1Internal: Internal note 1
                        notes2Internal: Internal note 2
                        orderHandlingNotes: Handle with care due to fragile items.
                        termsAndConditionsNotes: Payment due within 30 days.
                        supplierNote: Ensure packaging meets export standards.
                        factoryNote: Production to be completed by end of the week.
                        priorityFlag: false
                        orderReleased: true
                        fumigationRequired: true
                        qualityCheckRequired: true
                        qualityCheckPassed: true
                        serviceLevel: Express
                        orderStatus: In Progress
                        warehouseReceiptStatus: Pending
                        deliveryCompleteStatus: true
                        typeOfCertificateRequired: Certificate of Origin
                      orderTerms:
                        dutyPercentage: 5
                        paymentMethod: Credit Card
                        paymentTerms: Net 30
                        letterOfCreditNumber: LC123456789
                        letterOfCredit:
                          amount: 10000
                          currency: USD
                        letterOfCreditDate: '2024-07-30'
                      divisions:
                        divisionCode: D001
                        division: Electronics
                        businessUnit: Consumer Electronics
                        purchasingGroup: PG01
                        sourceChannel: Online
                        company: TechCorp
                        costCenter: CC1001
                        operatingCompany: TechCorp International
                        purchaseOffice: PO123
                        section: Retail
                        department: Sales
                        brand: TechBrand
                        buyer: John Doe
                        merchandiser: Jane Smith
                        departmentCode: DC01
                        merchandiseCategory: Gadgets
                        supplyPlanner: Alice Johnson
                        tradingTeam: Global Trading
                      transportation:
                        modeOfTransportation: SEA
                        portOfEntry: WFPWK
                        portOfLoading: XTBNF
                        portOfDischarge: SZ54U
                        placeOfDelivery: Warehouse 5
                        countryOfDeparture: ESBCN
                        countryOfDestination: FRPAR
                        incoterm: FOB
                        incotermLocation: Madrid
                        carrier: AirExpress
                        carrierContract: AX123456
                        shipmentType: FCL
                        movement: Direct
                        totalNumberOfContainers: 10
                        containerType: FCL
                        dayOfDeliveryDate: '2024-07-30'
                        originalDayOfDeliveryDate: '2024-07-30'
                        bookingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalBookingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalOriginDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        shippingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalShippingWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        arrivalWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalArrivalWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        destinationDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                        originalDestinationDeliveryWindow:
                          startDate: '2024-07-30'
                          endDate: '2024-07-30'
                      itemDetails:
                        orderedQuantity:
                          amount: 100
                          unit: pcs
                        itemNetWeight:
                          amount: 50
                          unit: kg
                        originalOrderedQuantity:
                          amount: 120
                          unit: pcs
                        packSize: 10
                      packageDetails:
                        quantityPerPackage: 10
                        expectedNumberOfPackages:
                          amount: 10
                          unit: bx
                        expectedPackageWeight:
                          amount: 5
                          unit: kg
                        expectedPackageVolume:
                          amount: 0.5
                          unit: m3
                        packageLength:
                          amount: 1
                          unit: m
                        packageWidth:
                          amount: 0.5
                          unit: m
                        packageHeight:
                          amount: 0.3
                          unit: m
                        itemPackaged: true
                      packingStructure:
                        quantityPerInnerPackage: 5
                        numberOfInnerPerOuter: 10
                        numberOfPackagesPerPallet: 50
                      pricing:
                        totalOrderValue:
                          amount: 5000
                          currency: USD
                        buyingPrice:
                          amount: 100
                          currency: USD
                        buyingPriceBase: Per Unit
                        sellingPrice:
                          amount: 150
                          currency: USD
                        ticketRetailPrice:
                          amount: 200
                          currency: USD
                        msrp:
                          amount: 250
                          currency: USD
                        originalBuyingPrice:
                          amount: 90
                          currency: USD
                      destinationWarehouseHandling:
                        casesPerPalletLayer: 5
                        layersPerPallet: 10
                        packType: Box
                        putawayUnitCode: PU123
                        putawayUnitName: Standard Box
                      customerSpecific:
                        string1: Customer Note 1
                        string2: Customer Note 2
                        string3: Customer Note 3
                        string4: Customer Note 4
                        string5: Customer Note 5
                        string6: Customer Note 6
                        string7: Customer Note 7
                        string8: Customer Note 8
                        string9: Customer Note 9
                        string10: Customer Note 10
                        bool1: true
                        bool2: false
                        bool3: true
                        bool4: false
                        bool5: true
                        bool6: false
                        bool7: true
                        bool8: false
                        bool9: true
                        bool10: false
                      state: CA
                      status:
                      - name: Allocated
                        code: '0110'
                        milestone: Gate In
                        statusDate: '2022-12-29T01:33:00Z'
                        quantity: 222
                      shippingDetails:
                      - shipmentType: BCM
                        masterShipmentNumber: SHP1234567890
                        bookingNumber: BN123456
                        containerNumber: ABCD1234657
                        loadingSequence: 0
                        knOriginReference: 1234-5678-019.111
                        trackingNumber: TRN1234567890
                        hbl: ASC1234567890
                        mbl: ASC12345678019111
                        quantity: 222
                      additionalReferences:
                      - code: 'ON'
                        values:
                        - ON-123456
                        - ON-654321
                pageSize: 5
                totalPages: 1
                currentPage: 1
        default:
          $ref: '#/components/responses/default'
      security:
      - default: []
      x-auth-type: Application & Application User
      x-throttling-tier: 50KPerMin
components:
  schemas:
    Money:
      required:
      - amount
      type: object
      properties:
        amount:
          minimum: 0
          type: number
          format: decimal
        currency:
          maxLength: 3
          type: string
          format: iso-4217
    AmountAndUnit:
      required:
      - amount
      type: object
      properties:
        amount:
          minimum: 0
          type: number
          format: decimal
        unit:
          maxLength: 3
          type: string
    Status:
      type: object
      properties:
        name:
          maxLength: 255
          type: string
          description: Status longname
          example: Allocated
        code:
          maxLength: 255
          type: string
        

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kuehne-nagel/refs/heads/main/openapi/kuehne-nagel-esp-order-track-api-openapi.yml