Receipt Event Guidelines (EPCIS v1.2)

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

`Message Types:

  • SOM_RECEIPT_EVENT
  • SOM_RECEIPT_EVENT_IB

Info Exchange Display Name: Receipt Event

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.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.
Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *1
  @creationDate [1…1]
[1/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *2
  EPCISHeader [0…1]
[-]		 - Required. XML file control header record. The following use cases are supported in this message:
  • Aggregation + Receiving events
  • Receiving event only: no aggregation
Receiving event is mandatory, all other events are optional.
    sbdh:StandardBusinessDocumentHeader [1…1]
[-]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1…]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *3
      sbdh:Sender [1…*]
[-]		 - Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. A GLN, SGLN, or any other supported business party type. *4

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *5

See the BusinessAndLocationId enumeration list for valid values.
      sbdh:Receiver [1…*]
[-]		 - Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that receives the standard business document. The Receiver element is used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. A GLN, SGLN, or any other supported business party type. *6

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *7

See the BusinessAndLocationId enumeration list for valid values.
      sbdh:DocumentIdentification [1…1]
[-]		 -

Required.

Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *8
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0. *9
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others. *10
        sbdh:Type [1…1]
[0/*]		 String Required. Identifies the document type. The sbdh:Type value is set to Events for a shipment event. *11
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *12
      extension [0…1]
[-]		 - Header extension area with master data attributes.
        EPCISMasterData [0…1]
[-]		 - Master data extension header. Will contain business and ship party address information.
          VocabularyList [1…1]
[-]		 - Required. Vocabulary list group master data elements.
            Vocabulary [0…*]
[-]		   Looping vocabulary with discrete master data element groups. Vocabulary will occur once each for sold from, ship from, sold to, and ship to parties.
              @type [1…1]
[0/*]		 String Required. Vocabulary type identifying location master data elements. Master data type defined by VocabularyElement | @id.

Valid value: urn:epcglobal:epcis:vtype:Location = party master data. *13

Sold from, ship from, sold to, and ship to for shipping event are all tracked in header master data. Party data in shipping event is mapped from header master in Vocabulary.
              VocabularyElementList [0…1]
[-]		 - List of vocabulary elements that includes all partner master information. Party identifiers and address info are stored in instances of the looping group VocabularyElement.
                VocabularyElement [1…*]
[-]		 - Required. Looping group header for data elements that identify all business party and location master data, including identifiers, identifier types, and address info.

VocabularyElement repeats once for each party type:

  • Carrier (Brazil) (Optional)
  • Sold/Transfer from business party (Mandatory)
  • Ship from location (Optional)
  • Sold/Transfer to business party (Mandatory)
  • Ship to location (Optional)
                  @id [1…1]
[0/*]		 String Required. SGLN or other partner identifier and type for party master data in VocabularyElement. Must match sourceList or destinationList owning or location party in shipping event from: *14
  • ObjectEvent | extension | sourceList | source (transfer from, carrier) OR
  • ObjectEvent | extension | destinationList | destination (transfer to)

The identifier value is mandatory for regulatory reporting. The identifier type must include a valid urn or http string prefix. Valid prefix formats include by namespace:

  • GS1: urn:epc:id:sgln:[CompanyPrefix].[LocationReference].[Extension]
  • GS1 USHC: http://epcis.gs1us.org/hc/[identifierType]/loc/[identificationValue]
  • TraceLink: http://epcis.tracelink.com/hc/[identifierType]/loc/[identificationValue]
Country Requirements:
  • China: Provide the company identifier registered with China SFDA used to identify the sold from party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • Turkey: Provide the SGLN associated with the sold from party.
  • US: Provide the SGLN, DEA, or HIN identifier associated with the sold from party.

The identifier type is included in the urn or http string prefix. The following types are supported in the US:

  • urn:epc:id:sgln: = SGLN (Serialized Global Location Number).
  • http://epcis.tracelink.com/company-id/loc/ = Company Id in Internal ERP System.
  • http://epcis.tracelink.com/company-site-id/loc/ = Internal Location or Site Id in Internal ERP System.
  • http://epcis.gs1us.org/hc/dea/loc/ = DEA (Drug Enforcement Agency Number).
  • http://epcis.gs1us.org/hc/duns/loc/ = DUNS (Dun & Bradstreet Number).
  • http://epcis.gs1us.org/hc/duns_plus_four/loc/ = DUNS4 (Dun & Bradstreet Number + 4-digit location code).
  • http://epcis.gs1us.org/hc/hin/loc/ = HIN (Health Industry Number partner address ID).
                  attribute(1) [0…*]
[0/*]		 String Required. Looping Name/Value pairs identifying partner address master data elements. This is the value element in the Name/Value pair attribute | @id. Stores master data item value defined by @id. *15

Partner master data items currently supported:

  • Business name – Mandatory if address populated in VocabularyElement.
  • Business classification – Optional.
  • Street address 1 – Mandatory if address populated.
  • Street address 2 – Optional.
  • City – Mandatory if address populated.
  • District – Optional.
  • Village – Optional.
  • House number – Optional.
  • Township – Optional.
  • Corporate fax – Optional.
  • State/Province/Region – Mandatory if address populated.
  • Postal code – Optional.
  • Country code – Mandatory if address populated.
  • Premises code – Optional.
  • Tax registration code – Optional.

Create one instance of the Name/Value pair attribute and attribute | @id for each master data element returned.
                    @id [1…1]
[0/*]		 String Conditionally required if attribute is present. Provides the name in the Name/Value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix. Valid values: *16
  • urn:epcglobal:cbv:mda#name
  • urn:epcglobal:cbv:mda#streetAddressOne
  • urn:epcglobal:cbv:mda#streetAddressTwo
  • urn:epcglobal:cbv:mda#streetAddressThree
  • urn:epcglobal:cbv:mda#city
  • http://epcis.tracelink.com/mda/district
  • http://epcis.tracelink.com/mda/village
  • http://epcis.tracelink.com/mda/houseNumber
  • http://epcis.tracelink.com/mda/township
  • http://epcis.tracelink.com/mda/corporateFax
  • urn:epcglobal:cbv:mda#state
  • urn:epcglobal:cbv:mda#postalCode
  • urn:epcglobal:cbv:mda#countryCode
  • http://epcis.tracelink.com/mda/AddressObjectGUID
  • http://epcis.tracelink.com/mda/HouseGUID
  • http://epcis.tracelink.com/mda/partyRoleCode
  • http://epcis.tracelink.com/mda/premisesCode
  • http://epcis.tracelink.com/mda/taxRegistrationCode
                  attribute(2) [0…*]
[0/*]		 String Required. Looping Name/Value pairs identifying additional party identifier elements. This is the value element in the Name/Value pair attribute | @id. Stores additional party identifiers and identifier types defined by @id. *17

Partner master data items currently supported:

  • Additional party identifier - optional (1 or more supported).
  • Additional party identifier type - optional (1 or more supported).

Create one instance of the Name/Value pair attribute and @id for each master data element returned.

Additional party identifiers must be sent in a double attribute combination. The sequence must be:

  • Attribute 1 identifies and provides the party identifier value.
  • Attribute 2 identifies the party identifier type.

For example:

  • <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationValue">10023141</attribute><attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode">DUNS_PLUS_FOUR</attribute>
  • <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">10023141</attribute><attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DUNS4</attribute>
If this sequence of double attributes is not followed for additional party identifiers, the additional party identifier will not be mapped to the TraceLink system and no error will be thrown.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
                    @id [1…1]
[0/*]		 String Conditionally required if attribute is populated. Provides the name in the Name/Value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix. Valid values: *18
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationValue
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode
  EPCISBody [1…1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1…1]
[-]		 - Required. The EventList has the following structure:
  • AggregationEvent: Optional, looping, zero or more instances.
  • ObjectEvent Receipt: One instance for receiving event.

Order of events in message if all events are present:

  1. Aggregation (optional)
  2. Receipt (mandatory)
      choice%1 [1…*]
[-]		 - Required. Only one of the following choice options may be selected in any one loop on EPCISBody | EventList:
  • AggregationEvent
  • ObjectEvent (with receiving extensions)
      AggregationEvent [0…*]
[-]		 - AggregationEvent is option 1 for the EventList choice for the Aggregation events.

EventList = AggregationEvent when all of the following is true:

  • action = ADD
  • bizStep = urn:epcglobal:cbv:bizstep:packing
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *19
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *20
        parentID [1…1]
[1/*]		 AnyURI Required. An Identifier of the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPC is of the case; for a case-to-pallet aggregation, the EPC is of the pallet). See EPC Pure Identifier Format Examples. *21
        childEPCs [1…1]
[-]		 - Required. A list of identifiers, including the child items, in the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPCs is of the items; for a case-to-pallet aggregation, the EPCs is of the cases).
          epc [1…*]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *22
        action [1…1]
[1/*]		 String Required. The action value must equal ADD for the aggregation event. *23
        bizStep [0…1]
[0/*]		 AnyURI The bizStep value must equal urn:epcglobal:cbv:bizstep:packing. *24
        disposition [0…1]
[0/*]		 AnyURI The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *25
        readPoint [0…1]
[-]		 - Optional for AggregationEvent.
          id [1…1]
[0/*]		 AnyURI Required. The SGLN EPC of the location of where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. *26
        bizLocation [0…1]
[-]		 - Required. Mandatory for AggregationEvent.
          id [1…1]
[0/*]		 AnyURI Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. *27
        tl:aggregationEventExtensions [0…1]
[-]		 - Extensions used for Aggregation Event.
          tl:packedStatus [0…1]
[0/*]		 String The packout of the item or container using the supported enumeration values. *28
          tl:quantity [0…1]
[-]		 Int The quantity of child serial numbers aggregated to the parent container in this aggregation. *29
          tl:resetContainerAggregation [0…1]
[-]		 Boolean Reset container aggregation flag. *30
          tl:extensionField [0…*]
[-]		 - Customer extension point to pass in one or more name/value pairs containing additional data attributes not already supported in this message.

These extensions are not stored by TraceLink and are used only for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this message, such as when a CMO is required to provide additional data fields to the Pharmaceutical Manufacturer. In this case, TraceLink would have a custom map for that trade partner to map these fields outbound. Different trade partners may have different field requirements and may therefore require that tl:extensionField be populated differently per trade partner.

If this element group is populated, both the tl:fieldName and tl:fieldValue elements must be populated.

            tl:fieldName [1…1]
[1/*]		 String Conditionally required if tl:ExtensionField is present. Populate with the field name provided by the trade partner receiving the mapped outbound message. The field name must match the field name provided by the trade partner exactly, including case, so that it can be properly detected in the outbound mapping.
            tl:fieldValue [1…1]
[1/*]		 String Conditionally required if tl:ExtensionField is present. Populate with the field value content that corresponds to tl:fieldName.
      ObjectEvent [1…1]
[-]		 - Required. EventList. Data = ObjectEvent for Receipt Event.

Define ReceivingEvent with:

  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:receiving
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *31
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *32
        epcList [1…1]
[-]		 - Required. List of the EPCs of top-most containers (e.g. pallets, cases) in the shipment.
          epc [1…*]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *33
        action [1…1]
[0/*]		 String Required. The action value must equal OBSERVE. *34
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:receiving. *35
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *36
        readPoint [0…1]
[-]		 - Required. The location where the event occurred, i.e. the warehouse GLN location ID and storage location (shelf, bin, etc.) in URN format, that recorded the Object event.
          id [1…1]
[0/*]		 AnyURI Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. *37
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizStep = urn:epcglobal:cbv:bizstep:shipping.
          bizTransaction [1…*]
[0/*]		 AnyURI Required. This field is the business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or invoice and/or purchase order governing this shipment, which are subject to Section 8.4.2 of (CBV1.0). The GLN that occurs after urn:epcglobal:cbv:bt: is the GLN of the party that issued the number (e.g. if customer issues PO Number, customer GLN is entered. If supplier issues ASN/delivery number supplier GLN is entered). *38
A delivery number or ASN is mandatory. All other transaction types are optional.

The transaction number requirements vary by region. It is recommended that the following are always provided, when available, to fulfill compliance needs:

  • Purchase Order Number
  • Invoice Number
  • ASN
Country Requirements:
  • Argentina: provide packing slip number.
  • China: provide sales order number.
            @type [1…1]
[1/*]		 String Required. The transaction identifier type using the supported enumeration values (e.g. PO, ASN, RETURN). *39

Mandatory if cmn:TransactionIdentifier is populated. A delivery number or ASN is mandatory. All other transaction types are optional.

See the TransactionId enumeration list for valid values.
              @date [0…1]
[0/*]		 Date Conditionally required if tl:shipToCountryCode = RU. The transaction identifier date. *40
        extension [0…1]
[-]		 - Main extension body for receipt event.
Source and Destination lists are optional even if party address master data is stored in the VocabularyElement in the EPCISMasterData extension in the message header.
          sourceList [0…1]
[-]		 - Conditionally required if:
  • Transfer or sale involving non-EU FMD countries.
  • Transfer or sale export from an EU FMD country to US, CN, KR, or RU because of country compliance requirements.

Optional if:

  • Transfer or sale within EU FMD countries.
  • Transfer or sale import into an EU FMD country.
  • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.

Source list identifies sending business, location, and carrier parties. sourceList supports one of two functions:

  1. VocabularyElement is populated with party address master data: sourceList identifies sold-from, ship-from, or carrier party. Party master data is mapped from VocabularyElement.
  2. VocabularyElement is not populated with party address master data: sourceList party identifiers used for master data lookup in the backend.
            source [1…*]
[0/*]		 String Required. Source party identifier for sold-from, ship-from, or carrier parties. Party identifier in source either: *41
  1. Identifies sold-from, ship-from, or carrier party in populated VocabularyElement. Party address info is mapped from VocabularyElement. Nothing is mapped from VocabularyElement if there is no match between party identifier in sourceList | source and VocabularyElement | @id.
  2. sourceList/source supports master data lookup in TraceLink system. VocabularyElement is not populated or there is no match between party identifiers in source and VocabularyElement | @id. If ship-from party the same as sold-from party, ship-from identifier does not need to be sent.
If the ship-from party is the same as the sold-from party, the ship-from identifier does not need to be sent.

 
              @type [1…*]
[0/*]		 String Conditionally required if source is present. Type of source party identifier, i.e. owning (sold-from), location (ship-from), or carrier party. Valid values: *42
  • Sold-from party = urn:epcglobal:cbv:sdt:owning_party Conditionally required if:
    • Transfer or sale involving non-EU FMD countries.
    • Transfer or sale export from an EU FMD country to US, CN, KR, or RU because of country compliance requirements.

    Optional if:

    • Transfer or sale within EU FMD countries.
    • Transfer or sale import into an EU FMD country.
    • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.
  • Ship-from party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
  • Carrier party = http://epcis.tracelink.com/sdt/carrier_party (for Brazil).
          destinationList [0…1]
[-]		 - Conditionally required if:
  • Transfer or sale involving non-EU FMD countries.
  • Transfer or sale export from an EU FMD country to US, CN, KR, or RU because of country compliance requirements.

Optional if:

  • Transfer or sale within EU FMD countries.
  • Transfer or sale import into an EU FMD country.
  • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.

Destination list identifies receiving business or location parties identified in header extensions level.

destinationList supports one of two functions:

  1. VocabularyElement populated with party address master data: destinationList identifies sold-to, ship-to parties. Party master data mapped from VocabularyElement.
  2. VocabularyElement NOT populated with party address master data: destinationList party identifiers used for master data lookup in backend.
            destination [1…*]
[0/*]		 String Required. Destination party identifier for sold-to or ship-to parties. Party identifier in destination either: *43
  1. Identifies sold-to or ship-to parties in populated VocabularyElement. Party address info mapped from VocabularyElement. Nothing is mapped from VocabularyElement if there is no match between party identifier in destinationList | destination and VocabularyElement | @id.
  2. destinationList | destination supports master data lookup in the TraceLink system. VocabularyElement is NOT populated or there is NO match between party identifiers in destination and VocabularyElement | @id.
If ship-to party the same as sold-to party, ship-to identifier does not need to be included.

See the MDPartyTypeAttributes enumeration list for valid values.
              @type [1…1]
[0/*]		 String Conditionally required if destination is present. Identifies type of destination party identifier, i.e. owning (sold-to) or location (ship-to) party. Valid values: *44
  • Sold-to party = urn:epcglobal:cbv:sdt:owning_party (conditionally required if:)
    • Transfer or sale involving non-EU FMD countries.
    • Transfer or sale export from an EU FMD country to US, CN, KR, or RU because of country compliance requirements.

    Optional if:

    • Transfer or sale within EU FMD countries.
    • Transfer or sale import into an EU FMD country.
    • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.
  • Ship-to party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
        tl:receivingEventExtensions [0…1]
[-]		 - Receiving event with list of serial numbers being received from supplier's shipment.
          tl:transactionDate [1…1]
[-]		 Date Required. Date associated with the business transaction document in bizTransactionList in YYYY-MM-DD format. This date may or may not be the same as the eventTime. *45
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. 2 letter ISO country code for ship to country. This value is referenced to advise regulatory reporting if it is mandatory for the specified country market. *46

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink system.
          tl:shipFromCountryCode [0…1]
[2/2]		 String 2 letter ISO country code for ship from country. This value is referenced to advise regulatory reporting if it is mandatory for the specified country market. *47

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink system.
          tl:receiptDistributionType [1…1]
[1/*]		 String Required. Informs what types of regulatory reporting may be triggered based on the nature of the transaction: a purchase, transfer, or return within the same country or a purchase, transfer, or return from another country. *48

See the SalesDistType enumeration list for valid values.
          tl:supplyType [0…1] String Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or EXPORTRETURN. All values except for Collection apply. Identifies the type of supply that is being performed using one of the permitted values. *49

See the SupplyType enumeration list for valid values.
          tl:contractType [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or EXPORTRETURN. Identifies the type of contract for the sale of goods using one of the permitted values. *50

See the ContractType enumeration list for valid values.
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with delivery.
          tl:contractNumber [0…1]
[0/*]		 String Identification number of the contract. *51
          tl:fundingSource [0…1]
[0/*]		 String Conditionally required if both tl:shipToCountryCode and tl:shipFromCountryCode = RU. Source of the funding. *52

See the FundingSource enumeration list for valid values.
          tl:transferWithoutShipment [0…1]
[0/*]		 String

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state
  • false – (default) Serial numbers are in the Pending Receipt state.

Only use this element when tl:receiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
          tl:entryPort [0…1]
[0/*]		 String Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
          tl:exitPort [0…1]
[0/*]		 String Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
          tl:deliveryInspection [0…1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.
          tl:deliveryInspectionDate [0…1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *53
          tl:deliveryInspectionNote [0…1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
          tl:removalFromCirculation [0…1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
          tl:aggregationInspection [0…1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
          tl:deliveryCompleteFlag [0…1]
[0/*]		 Boolean

Indicates the status of the delivery. Valid values:

  • true – Default. The delivery is complete and the receipt is marked as submitted.
  • false – The delivery is not complete.
          tl:disaggregateFromParent [0…1]
[0/*]		 Boolean

Indicates whether the child serial number should be implicitly disaggregated from the parent container. Valid values:

  • true – The child serial number is disaggregated from the parent container.
  • false – (default) The child serial number is not disaggregated from the parent container. An error displays if the child serial number is received but the parent serial number is not.
          tl:orderItemList [0…1]
[-]		 - Order item list group is populated to communicate the pick quantities for each item code at the EACH (unit) level.
            tl:orderItem [1…*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number and quantity for each item in the order. Each unique item code and lot number are communicated in a separate order item group.
              tl:orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of tl:orderItem.
              choice%1 [-]
[-]		 -

Conditionally required if tl:shipFromCountryCode = KR. Populate only one of cmn:InternalMaterialCode or cmn:PackagingItemCode. One of the two options must be present.

Populate only one of tl:InternalMaterialCode, tl:PackagingItemCode, or tl:countryDrugCode. One of the three options must be present.

              tl:internalMaterialCode [0…1]
[1/*]		 String Conditionally required if neither tl:packagingItemCode nor tl:countryDrugCode is present. Option 1 for choice%1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *54
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:countryDrugCode is present. Option 2 for choice%1 in OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *55
                @type [0…1]
[0/*]		 String

Required. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14).

See the ItemCode enumeration list for valid values.
              tl:countryDrugCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:packagingItemCode is present. Option 3 for choice%1 in OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *56
                @type [0…1]
[0/*]		 String

Required. The national drug code type using the supported enumeration values (e.g. US_NDC442).

See the CountryDrugCode enumeration list for valid values.
              cbvmda:lotNumber [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:isSerialized = false. The lot or batch code for the items to be picked (if available) in an alphanumeric string. *57
              cbvmda:itemExpirationDate [0…1]
[1/*]		 Date The expiration date for the serialized item in YYYY-MM-DD format. *58
              tl:quantity [1…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:isSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. *59
              tl:unitPrice [0…1]
[0/*]		 Decimal

Conditionally required if tl:shipFromCountryCode = KR, or if tl:shipToCountryCode = RU and tl:shipFromCountryCode = AM, BY, KG, or RU. Unit price of item. *60
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *61
              tl:vat [0…1]
[-]		 Decimal Value Added Tax per unit. *62
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *63

See the ISOCurrency enumeration list for valid values.
              tl:grossPrice [0…1]
[-]		 Decimal Gross price including unit price and all taxes and fees. *64
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *65

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is not serialized. If omitted, defaults to true. *66
              tl:transactionIdentifier [0…*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *67
                @type [1…1]
[1/*]		 String Required. The transaction identifier type. Valid values:
  • DESTRUCTION
  • INVOICE
  • NOTAFISCAL
  • OTHER
  • PO
  • RETURN
                @date [0…1]
[0/*]		 Date Conditionally required if tl:shipToCountryCode = RU. The transaction identifier date. *68
          tl:warehouseOperatorName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible for warehouse operations.
          tl:correctiveReceipt [0…1]
[0/*]		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • false – (default) The receipt is not a corrective receipt.
  • true – The receipt is a corrective receipt.
          tl:originalDeliveryNumber [0…1]
[0/*]		 String Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt.