List Open Orders and Receipts Request Guidelines

See How To Use this Guide before interpreting the guidelines below.

The following data is sent in the request to TraceLink:

Data Element Occurs
Length
Type Description
soapenv:Envelope [1...1]
[-]
- Required. SOAP Envelope root element.
  soapenv:Header [1...1]
[-]
- Required. Not used.
  soapenv:Body [1...1]
[-]
- Required. SOAP Message Body.
    urn:ListOpenOrdersAndReceipts [1...1]
[-]
- Required. Finds and lists orders and receipts.
      ListOrderRequest [1...1]
[-]
- Required. Required field for a List Open Orders and Receipts request.
        DeliveryNumber [0...1]
[0/*]
String Delivery number of the receipt that is being requested. *1
        Keywords [0...1]
[0/*]
String

Words to search for in the following fields of open orders and receipts:

  • Sold or returned to business name and identifiers
  • Sold or returned from business name and identifiers
  • Sold or returned to business name and identifiers
  • Sold or returned from business name and identifiers
  • Transaction identifier
        IncludeSalesOrders [1...1]
[1/*]
Boolean Required. Indicates whether to include orders where the Sales Distribution Type is one of the following:
  • Sale - Export
  • Sale - In Country
  • Purchase - Import
  • Purchase - In Country
        IncludeReturnOrders [1...1]
[1/*]
Boolean Required. Indicates whether to include orders where the Sales Distribution Type is one of the following:
  • IMPORT_RETURN
  • IMPORT_PURCHASE
  • IMPORT_TRANSFER
  • INCOUNTRY_PURCHASE
  • INCOUNTRY_RETURN
  • INCOUNTRY_TRANSFER
        ReceiptType [0...1]
[1/*]
String The order receipt type. Valid values:
  • IMPORT_RETURN
  • IMPORT_PURCHASE
  • IMPORT_TRANSFER
  • INCOUNTRY_PURCHASE
  • INCOUNTRY_RETURN
  • INCOUNTRY_TRANSFER
        saleType [0...1]
[0/*]
String The order sale type. Valid values:
  • INCOUNTRY_SALE
  • EXPORT_SALE
  • INCOUNTRY_TRANSFER
  • EXPORT
  • INCOUNTRY_RETURN
  • EXPORT_RETURN
        DateOnOrAfter [0...1]
[0/*]
Date The response includes the order and receipts that occurred on or after the specified date. *2
        DateOnOrBefore [0...1]
[0/*]
Date The response includes the order and receipts that occurred on or before the specified date. *3