List Open Orders and Receipts Response Guidelines

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

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.

The following data is included in the message response:

Data Element Occurs
Length
Type Description
S:Envelope [1...1]
[-]
- Required. The SOAP Envelope root element.
  S:Body [1...1]
[-]
- Required. The SOAP Message Body.
    ns3:ListOpenOrdersAndReceiptsResponse [1...1]
[-]
- Required. The List Open Orders and Receipts response message with included query results.
      OrderListResponse [1...1]
[1/*]
String Required. The TraceLink response for the List Open Orders and Receipts request message.
        Success [1...1]
[-]
Boolean Required. Indicates if the List Open Orders and Receipts request successfully processed. *1
        ExceptionReturn [0...1]
[-]
- Conditionally required if Success = false. Populated with error information only if Success = false. Otherwise, it is omitted.
          CallException [1...*]
[-]
- Required. Contains any available exception information.
            ExceptionCode [0...1]
[0/*]
String Required. Indicates the error exception code. See List Open Orders and Receipts Errors for full list of potential errors and error codes.
            ExceptionMessage [0...1]
[0/*]
String Message that further describes the error condition. See List Open Orders and Receipts Errors for full list of potential errors and error codes.
        OrderList [1...1]
[1/*]
- Required. List of order and receipt instances.
          Orders [0...1]
[-]
- Required. Required element for a List Open Orders and Receipts response.
            Order [0...*]
[-]
- Required. Representation of an order (e.g. Sales). Contains just the basic identifier for the order or receipt, which is the delivery number.
              @deliveryNumber [1...1]
[1/*]
String Required. The delivery number submitted in the request message, which links the order information to the serialized pick information for this customer order. *2
              @quantity [1...1]
[1/*]
Integer Required. Total serial number count for this receipt.
              OrderDate [0...1]
[10/10]
Date The date of the business transaction in XML YYYY-MM-DD format. If omitted, the system will reflect the date and time that the request was submitted. *3
              EventDateTime [0...1]
[-]
Time Date and time of the event in XSD Date format in GMT (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system will reflect the date and time that the request was submitted. *4
              OrderComplete [1...1]
[-]
Boolean Required. Instructs the system to process the outbound delivery, updates the status of all serial numbers and sub-child aggregations, and triggers generation of regulatory reporting messages based on customer configuration. *5
  • If all of the information (order detail and picked serial numbers) is provided in a single message, the OrderComplete flag is set to true.
  • If only partial information was provided in the message (e.g. order detail only, picked items sent incrementally), the OrderComplete flag should be set to false for all intermediate messages and then will be set to true when the delivery is complete and all information has been communicated to TraceLink.
              ShipToCountryCode [0...1]
[2/2]
String Conditionally required before OrderComplete is set to true. Two-letter ISO country code for ship to country. This value will be referenced to advise regulatory reporting if it is required for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application. *6
              ShortShip [0...1]
[0/*]
Boolean Instructs the system whether to allow short picks when verifying the quantities of what is expected to be picked (in OrderItems) against the each quantities of actual scanned serial numbers (in PickedItem). *7
  • If this value is set to false, other errors will still be flagged, such as incorrect product/lot and over picks.
  • If not specified, value of false is assumed.
              SaleType [0...1]
[1/*]
String Indicates the nature of the order. See the SalesDistType enumeration list for valid values.
              SoldFromParty [0...1]
[-]
- Conditionally required before OrderComplete is set to true. Represents the From Business Party in the transaction.
                BusinessIdentifiers [0...1]
[-]
- A list of one or more identifiers associated with the From Business Party.
                  BusinessIdentifier [1...*]
[-]
- Required. The identifier associated with the from business entity. This value is required for regulatory reporting. See Business Identifiers by Country.
                    @identifierType [1...1]
[1/*]
String Required. The type of the business identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- The business identifier value. *8
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the trading partner. *9
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address. *10
                Street2 [0...1]
[1/*]
String The second line of the street address. *11
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city. *12
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO3166-2:1998 country subdivision code. *13
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code. *14
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *15
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true. *16
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
              ShipFromLocation [0...1]
[-]
- Represents the Ship From Location in the transaction.
If this is provided, it must be populated before OrderComplete set to true.
                BusinessIdentifiers [0...1]
[-]
- A list of one or more identifiers associated with the ShipFromLocation.
                  BusinessIdentifier [1...*]
[-]
- Conditionally required for US. Populated with the ShipFromLocation identifier. See Business Identifiers by Country.
                    @identifierType [1...1]
[1/*]
String Required. The type of the location identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- The business identifier value.
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the trading partner.
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
                Street2 [0...1]
[1/*]
String The second line of the street address.
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city.
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO3166-2:1998 country subdivision code.
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true.
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
                License [0...*]
[-]
- List of zero or more license numbers associated with the facility. This element may be repeated to include as many license numbers as required (e.g. state, federal license).
                  LicenseNumber [1...1]
[1/*]
String Required. License number value. *17
                  State [0...1]
[1/*]
String Required. The state or region in which the trading partner is licensed, using the standard two-letter abbreviations specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *18
                  Agency [0...1]
[1/*]
String The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. *19
                Contact [0...1]
[-]
- Contact information for use by downstream trading partners to verify the transaction information.
                  Name [1...1]
[1/*]
String Required. The name of the contact department or individual at the company. *20
                  Telephone [0...1]
[1/*]
String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *21
                  Email [0...1]
[1/*]
String The email address of the contact department or individual at the company. Should be included if available. *22
                  Title [0...1]
[1/*]
String The title of the individual if a person was provided in Name. *23
                  Url [0...1]
[1/*]
String The Web address to facilitate authentication. *24
              SoldToParty [0...1]
[-]
- Conditionally required before OrderComplete is set to true. Represents the To Business Party in the transaction.
                Business Identifiers [0...1]
[-]
- A list of one or more identifiers associated with the To Business Party.
                  Business Identifier [1...*]
[-]
- Required. The identifier associated with the To Business Party entity. See Business Identifiers by Country.
                    @identifierType [1...1]
[1/*]
String Required. The type of the Business Identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- Business identifier value.
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the trading partner.
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
                Street2 [0...1]
[1/*]
String The second line of the street address.
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city.
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO3166-2:1998 country subdivision code.
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true.
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
              ShipToLocation [0...1]
[-]
- Represents the ShipToLocation in the transaction.
If this is provided, it must be populated before OrderComplete is set to true.
                BusinessIdentifiers [0...1]
[-]
- A list of one or more identifiers associated with the ShipToLocation.
                  BusinessIdentifier [1...*]
[-]
- Required. Populated with the ShipToLocation identifier. See Business Identifiers by Country.
                    @identifierType [1...1]
[1/*]
String Required. The type of the location identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- Business identifier value.
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the trading partner.
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
                Street2 [0...1]
[1/*]
String The second line of the street address.
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city.
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO3166-2:1998 country subdivision code.
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true.
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
                License [0...*]
[-]
- List of zero or more license numbers associated with the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
                  LicenseNumber [1...1]
[1/*]
String Required. License number value.
                    State [0...1]
[1/*]
String Required. The state or region in which the trading partner is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number.
                    Agency [0...1]
[1/*]
String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number.
                Contact [0...1]
[-]
- Contact information for use by downstream trading partners to verify the transaction information.
                  Name [1...1]
[1/*]
String Required. The name of the contact department or individual at the company.
                  Telephone [0...1]
[1/*]
String The title of the individual, if a person was provided in Name.
                  Email [0...1]
[1/*]
String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code.
                  Title [0...1]
[1/*]
String The email address of the contact department or individual at the company. Should be included if available.
                  Url [0...1]
[1/*]
String The Web address to facilitate authentication.
              TransportationCarrier [0...1]
[-]
- Conditionally required before OrderComplete is set to true for orders made into and within Brazil. Represents the transportation partner that is transporting the order. This is used only for Brazil and is required for orders where ShipToCountryCode = BR.
                BusinessIdentifiers [0...1]
[-]
- A list of one or more identifiers associated with the transportation carrier.
                  BusinessIdentifier [1...*]
[-]
- Required. The identifier associated with the transport carrier business entity. This value is required for regulatory reporting. Different countries require different values as noted below:
For Brazil: Provide the BR_PROF_REG, BR_CNES, BR_CNPJ, or BR_CPF. BR_CNPJ is the value preferred by ANVISA if the company has one.
                    @identifierType [1...1]
[1/*]
String Required. The type of the location identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- Required. Business identifier value.
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the trading partner.
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
                Street2 [0...1]
[1/*]
String The second line of the street address.
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO3166-2:1998 country subdivision code.
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true.
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
              DropShipment *25 [0...1]
[0/*]
Boolean Flag that indicates if the order/receipt is a drop shipment:
  • If set to true, indicates order is a drop order.
  • If not set, or set to false, the system treats as a standard order.
              portalAccessCode [0...1]
[0/*]
String The portal access code used to access drop shipments in the serialized drop ship portal.
              Attempt Disaggregation *26 [0...1]
[0/*]
Boolean When set to true, instructs the system to disaggregate the picked serial number from the parent container, if it is aggregated. If not set, or set to false, the system will operate in default mode, which is to generate an error if attempting to pick a serial number for an item or container that is aggregated to a parent.
              Transactions [0...1]
[-]
- Conditionally required before OrderComplete is set to true. The transaction identifier associated with the order.
                Transaction [0...*]
[-]
- Required. List of one or more transaction identifiers.
                  OrderID [0...1]
[1/*]
String Required. The transaction identifier associated with the order, for regulatory reporting and business tracking purposes. At least one is required, and depending on country more than one transaction ids may be required. *27
Country requirements.
  • Argentina: provide Packing Slip Number.
  • Brazil: provide PO Number, ASN Number and Invoice Number if available.
  • China: provide Sales Order Number.
  • US: provide PO Number, ASN Number and Invoice Number if available.
                  OrderType [0...1]
[1/*]
String Conditionally required if cmn:TransactionIdentifier is present. The transaction identifier type using the supported enumeration values. *28

See the TransactionId enumeration list for valid values.

                  Date [0...1]
[1/*]
String Required. The date of the transaction in XML YYYY-MM-DD format. This value is used for regulatory reporting of the transaction Date. *29
              PickedItem [-]
[-]
- Contains list of items picked for that order as well as the warehouse operator information.
                WarehouseOperator [0...1]
[0/*]
String Conditionally required for China. Name of the person responsible for warehouse operations. This element can be communicated at any time (e.g. with, before, or after the order details or picked items have been communicated). *30
                Items [-]
[-]
- Required. List of items picked for that order.
                  @sn [1...1]
[1/*]
String Required. Serial Number in the format specified in the request. *31
                  @namespace [0...1]
[1/*]
String Not used. See Serial Number Data Examples.
                  @isUpdated [1...1]
[1/*]
Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
              OrderItems [1...1]
[-]
- Optional list of items expected to be in the order.
  • If provided, the system will verify the picked serial numbers against the expected items in the order and generate an error if incorrect products were picked against the order.
  • If OrderItems are not provided, the system will accept the serial numbers against the order and only verify that the serial numbers are in a shippable state.
                OrderItem [0...*]
[-]
- Required. Order item group is a repeating element that captures the item code, lot number and quantity for each item that will be picked for the order. Each unique item code and lot number is communicated in a separate order item group.
                  InternalItemCode [0...1]
[1/*]
String Conditionally required if PackagingItemCode is not present. Option 1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *32
                  PackagingItemCode [0...1]
[1/*]
String Conditionally required if InternalItemCode is not present. Option 2 in OrderItem. Use to identify the product using the packaging level item code (for example, GTIN-14) configured in Product Master Data. *33
                  PackagingItemCodeType [0...1]
[1/*]
String Conditionally required if PackagingItemCode is present. Identifies the packaging level item code type. See the ItemCodeType enumeration list for valid values.
                  Quantity [1...1]
[-]
Int Required. The quantity of items at the Each (unit) level of the item code and lot if specified to be picked. *34
                  Lot [0...1]
[1/*]
String The lot or batch code for the items to be picked (if available) in an alphanumeric string. *35
              CDEntries [0...1]
[-]
- A customer-defined name/value pair. Use to store customer-visible data and metadata that is outside the processing path of the API.
                CDName [0...1]
[1/*]
String Required. Customer-defined name.
                CDValue [0...1]
[1/*]
String Required. Customer-defined value used to annotate serial numbers.
            Order [0...*]
[-]
- Required. Representation of an order (e.g. Sales). Contains the basic identifier for the order or receipt, which is the delivery number.
              @orderReceiptType [0...1]
[1/*]
String Identifier that can be associated with a given receipt. See the OrderReceiptType & OrderType enumeration lists for valid values.
              @deliveryNumber [1...1]
[1/*]
String Required. The delivery number that was submitted in the request message, which links the order/receipt information to the serialized pick information for this customer order.
              ReceiptDate [0...1]
[10/10]
Date The date of the business transaction in XML YYYY-MM-DD format. If omitted, the system will reflect the date and time that the request was submitted.
              EventDateTime [0...1]
[-]
Time Date and time of the event in XSD Date format in GMT (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system will reflect the date and time that the request was submitted
              ReceiptComplete [1...1]
[-]
Boolean Required. Indicates whether the receipt can be considered complete and all editing is finished (true = complete).
              ReceiptFromCountryCode [0...1]
[2/2]
String Conditionally required before ReceiptComplete is set to true. Two-letter ISO country code for receipt from country. This value will be referenced to advise regulatory reporting if it is required for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.
              ShortShip [0...1]
[0/*]
Boolean Instructs the system whether to allow short picks when verifying the quantities of what is expected to be picked (in OrderItems) against the each quantities of actual scanned serial numbers (in PickedItem).
  • If this value is set to false, other errors will still be flagged, such as incorrect product/lot and over picks.
  • If not specified, value of false is assumed.
              ReceiptFromParty [0...1]
[-]
- Conditionally required before ReceiptComplete is set to true. Represents the From Business Party in the transaction.
                BusinessIdentifiers [0...1]
[-]
- A list of one or more identifiers associated with the From Business Party.
                  BusinessIdentifier [1...*]
[-]
- Required. The identifier associated with the from business entity. This value is required for regulatory reporting. See Business Identifiers by Country.
                    @identifierType [1...1]
[1/*]
String Required. The type of the BusinessId identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- Required. Business identifier value.
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the receipt from business party (the company who is sending the receipt).
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
                Street2 [0...1]
[1/*]
String The second line of the street address.
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city.
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true.
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before ReceiptComplete is set to true.
              ReceiptToParty [-]
[-]
- The business "to" party (receiving the order) of the original shipment.
                BusinessIdentifiers [0...1]
[-]
- A list of one or more identifiers associated with the To Business Party.
                  BusinessIdentifier [1...*]
[-]
- Required. The identifier associated with the To Business Party entity. This value is required for regulatory reporting. See Business Identifiers by Country.
                    @identifierType [1...1]
[1/*]
String Required. The type of the Business identifier. See the BusinessAndLocationId enumeration list for valid values.
                    @identifierValue [1...1]
[-]
- Required. Business identifier value.
                BusinessName [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the receipt ToBusinessParty party (the company getting the receipt).
                Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
                Street2 [0...1]
[1/*]
String The second line of the street address.
                City [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The city.
                StateOrRegion [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
                PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
                CountryCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
                DefaultFromMasterData [1...1]
[-]
Boolean Required. Instructs the system to look up the business name and address information from master data when set to true.
  • If set to true, only the Business Identifier and type are needed for the system to perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before ReceiptComplete is set to true.
              Transactions [0...1]
[-]
- Conditionally required before ReceiptComplete is set to true. The transaction identifier associated with the order.
                Transaction [0...*]
[-]
- List of one or more transaction identifiers.
                  OrderID [0...1]
[1/*]
String Required. The transaction identifier associated with the order, for regulatory reporting and business tracking purposes. At least one is required, and depending on country more than one transaction ids may be required.
  • Argentina: provide Packing Slip Number.
  • Brazil: provide PO Number, ASN Number and Invoice Number if available.
  • China: provide Sales Order Number.
  • US: provide PO Number, ASN Number and Invoice Number if available.
                  OrderReceiptType [0...1]
[1/*]
String Required. Identifier that can be associated with a given receipt. See the OrderReceiptType & OrderType enumeration lists for valid values.
                  Date [0...1]
[1/*]
String The date of the transaction in XML YYYY-MM-DD format. This value is used for regulatory reporting of the transaction Date.
              ReceiptItem [-]
[-]
- Contains list of items for that order as well as the warehouse operator information.
                WarehouseOperator [0...1]
[0/*]
String Conditionally required for China. Name of the person responsible for warehouse operations. This element can be communicated at any time (e.g. with, before, or after the order details or picked items have been communicated).
                Items [1...1]
[-]
- Required. List of items included in order.
                  Item [-]
[-]
- Required. Item information.
                    @sn [1...1]
[1/*]
String Required. Serial Number in the format specified in the request. See Serial Number Data Examples.
                    @namespace [0...1]
[1/*]
String Not used by TraceLink.
                    @isUpdated [1...1]
[1/*]
Boolean Required. Records whether the serial number is updated, which TraceLink uses for system processing.
              OrderReceiptItems [1...1]
[-]
- Optional list of items expected to be in the order.
  • Option 1: If provided, the system will verify the picked serial numbers against the expected items in the order and generate an error if incorrect products were picked against the order.
  • Option 2: If OrderReceiptItems is not provided, the system will accept the serial numbers against the order and only verify that the serial numbers are in a shippable state.
                OrderReceiptItem [0...*]
[-]
- Required. Order item group is a repeating element that captures the item code, lot number and quantity for each item that will be picked for the order. Each unique item code and lot number is communicated in a separate order item group.
                  InternalItemCode [0...1]
[1/*]
String Conditionally required if PackagingItemCode is not present. Option 1 in OrderItem: Use to identify the product using the internal material number configured in Product Master Data.
                  PackagingItemCode [0...1]
[1/*]
String Conditionally required if InternalMaterialCode is not present. Option 2 in OrderItem: Use to identify the product using the packaging level item code (for example, GTIN-14) configured in Product Master Data.
                  PackagingItemCodeType [0...1]
[1/*]
String

Conditionally required if PackagingItemCode is present. Identifies the packaging level item code type. See the ItemCodeType enumeration list for valid values.

                  Quantity [1...1]
[-]
int Required. The quantity of items at the Each (unit) level of the item code and lot if specified to be picked.
                  Lot [0...1]
[1/*]
String Required. The lot or batch code for the items to be picked (if available) in an alphanumeric string.
              CDEntries [0...1]
[1/*]
String Customer-defined name.
                CDName [0...1]
[1/*]
String Customer-defined name used to annotate serial numbers.
                CDValue [0...1]
[1/*]
String Customer-defined value used to annotate serial numbers.