ESM Shipment Guidelines (EPCIS v1.2)

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

Message Type:SOM_ESM_SHIPMENT

Info Exchange Display Name: ESM Shipment

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. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *2
  EPCISHeader [0…1]
[-]		 - Required. XML file control header. This message supports the following use cases:
  • Shipping event only: Commission and aggregation transactions have already been processed.
  • Aggregation + Shipping events: Commission events have already been processed.
  • Aggregation + Shipping + Decommission/Destroy events: Commission events have already been processed.
  • Commission + Shipping events: Product is not aggregated.
  • Commission + Aggregation + Shipping events: All events reported at same time from external system.
  • Commission + Shipping + Decommission/Destroy events: Product is not aggregated.
  • Commission + Aggregation + Shipping + Decommission/Destroy events: All events reported at same time from external system.
  • Shipping + Decommission/Destroy events: Commission and Aggregation transactions have already been processed.

Shipping event is required; 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…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. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *4

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have an 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. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *6

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String Required. The receiver 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.
      extension [0…1]
[-]		 - Header extension area with master data attributes.
        EPCISMasterData [0…1]
[-]		 - Master data extension header. May contain product master data attributes for Commissioning event and/or business and ship party address information.
Full GS1 conformance requires that all product and party master data be stored in the EPCIS header extension EPCISMasterData | VocabularyList | Vocabulary | VocabularyElementList | VocabularyElement. It is strongly urged that all product master data for Commissioning and Transformation events be sent in the VocabularyElement within the EPCISMasterData header extension.
          VocabularyList [1…1]
[-]		 - Required. Vocabulary list group master data elements.
            Vocabulary(1) [0…*]
[-]		 - Looping vocabulary element with discrete item master data and/or party master data element groups. Vocabulary occurs only once for all item master entries and party address info present in message, if the group is populated.

Group is optional. If it does not appear in master data header extension, no error will be thrown.

              @type [1…1]
[0/*]		 String Required. Vocabulary type identifying product master data elements. Product master data is defined by VocabularyElement | @id.

Valid value: urn:epcglobal:epcis:vtype:EPCClass = product master data. *12
              VocabularyElementList [0…1]
[-]		 - List of vocabulary elements containing master data attributes for each unique product code.
                VocabularyElement [1…*]
[-]		 - Looping vocabulary element identifying each unique SGTIN, NTIN, or China Product Code for product master data embedded in the epc serial number in the Commissioning and Transformation events.

SSCC codes are not included in VocabularyElement product master data.

To conform with GS1 standards, master data attributes should be sent in the VocabularyElement. Each unique SGTIN, NTIN, or China Product Code embedded in Commissioning event epcList | epc and Transformation event outputEPC | epc serial numbers should be sent in one instance of VocabularyElement.
                  @id [1…1]
[0/*]		 String Required. Identifies the product code for which master data is being sent in the VocabularyElement loop. VocabularyElement | @id = SGTIN, NTIN, or China Product Code. These are the only values supported in this element. All other product identifier types will be sent as additional trade item types. SSCC codes are not identified in any part of the VocabularyElement group. *13

Must match the product code embedded within the serial number in the epc code in one or more commissioning events or the outputEPCList | epc in one or more transformation events.

SGTIN

  • Prefix: urn:epc:idpat:sgtin:
  • Example: urn:epc:idpat:sgtin:0030001.0012345.*

China

  • Prefix: http://epcis.tracelink.com/hc/cn-edmc/obj/
  • Example: http://epcis.tracelink.com/hc/cn-edmc/obj/10230.*
Legacy http prefix will continue to be supported: Legacy: http://epcis.tracelink.com/obj/[ProductType]/
                  attribute [1…1]
[1/*]		 String Conditionally required if item master data attributes are sent in VocabularyElement. Instance 1 of attribute for packaging level value identified by attribute | @id. *14

See the PackagingLevel enumeration list for valid values.
                    @id [1…1]
[0/*]		 String Required. Attribute identifying packaging level.

Valid value: http://epcis.tracelink.com/mda/packageTypeCode *15
                  attribute [0…1]
[0/*]		 String Instance 2 of attribute for internal material number in Pharmaceutical Manufacturer's internal system identified by attribute | @id. Identified by the value in attribute element (instance 3) in the current loop = MANUFACTURER_PART_NUMBER. *16
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying internal material code.

Valid value: urn:epcglobal:cbv:mda#additionalTradeItemIdentification *17
                  attribute [0…1]
[0/*]		 String Conditionally required if the previous name/value pair attribute | @id (instance 2) is populated. Instance 3 of attribute for internal material number identifier type for the product. Id attribute identifying internal material code.

Valid value: MANUFACTURER_PART_NUMBER *18

Sequence of fields for internal material number is:

  1. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">100335</attribute>
  2. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode">MANUFACTURER_PART_NUMBER</attribute>
If this sequence is not followed as documented above in the input file, the internal material number will not be mapped into the TraceLink system and no error will be thrown.
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying internal material code.

Valid value: urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode *19
                  attribute [0…1]
[0/*]		 String Instance 4 of attribute for country drug code for all national drug code types, identified by the enum value in the next attribute element (instance 5) in the current loop and by the attribute @id value as an additional trade item. *20

Country drug code type defined by value in the attribute element (instance 5) where attribute | @id = urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode OR http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode.
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying internal material code.

Valid value: urn:epcglobal:cbv:mda#additionalTradeItemIdentification *21
                  attribute [0…1]
[0/*]		 String Conditionally required if the previous name/value pair attribute | @id (instance 4) is populated. Instance 5 of attribute for country drug code identifier type. Must follow attribute with country drug value. Id attribute identifying internal material code. *22

Sequence of fields for country drug code is:

GS1:

  1. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">82025030221</attribute>
  2. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode">FDA_NDC_11</attribute>

TraceLink:

  1. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">82025030221</attribute>
  2. <attribute id="http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode">US_NDC442</attribute>
If this sequence is not followed as documented above in the input file, the internal material number will not be mapped into the TraceLink system and no error will be thrown.

The following qualifiers have been defined by GS1 as additional trade item types:

  • MANUFACTURER_PART_NUMBER = Internal material number
  • FDA_NDC_11 = US NDC542
  • DIN = Canada Drug ID Number
  • PHARMACODE_CH = Swiss Pharma Code
  • NAN = Nordic Article Number

To identify these material number types, use attribute | @id string: urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode.

For all other country drug code types, use attribute | @id string: http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode.

Mandatory if the previous name/value pair attribute | @id (instance 4) is populated.
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying internal material code. Valid value: *23
  • urn:epcglobal:cbv:mda#additionalTradeItemIdentification (GS1 enums).
  • http://epcis.tracelink.com/mda/packageTypeCode (TraceLink enums).
            Vocabulary(2) [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.
Group is optional. If it does not appear in master data header extension, no error will be thrown.
              @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 *24

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 [0…1]
[-]		 - Looping group header for data elements that identify all business party and location master data, including identifiers, identifier types, and address info.

Shipping Event:

  • Sold/Transfer from business party (Mandatory if group populated)
  • Ship from location (Optional)
  • Sold/Transfer to business party (Mandatory if group populated)
  • Ship to location (Optional)
  • Carrier (Brazil) (Optional)

Master data lookup is supported. If partner master data is available in TraceLink, indicate master data lookup by sending partner identifiers in the sourceList and/or destinationList for the shipping event and do not include address data in any VocabularyElement group.

Master data lookup is supported from the readPoint | id for the decommissioning and destroying events if VocabularyElement is not populated with location address.

If master data lookup is not intended, send complete address information for at least the sold-from and sold-to partners in the header master data extension. Ship-from and ship-to addresses can also be included.
                  @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: *25
  • 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]

Only SGLN is supported–not GLN. Different countries require different values as noted below:

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 an 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/hc/companyId/loc/ = Company Id in Internal ERP System.
  • http://epcis.tracelink.com/hc/companySiteId/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) [1…1]
[0/*]		 String Conditionally required if attribute(2) is populated. 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 attribute | @id. Partner master data items currently supported: *26

  • 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 Required. 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: *27
  • 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 Conditionally required if attribute(1) is present. 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. *28

Partner master data items currently supported:

  • Additional party identifier - Optional (one or more supported).
  • Additional party identifier type - Optional (one or more supported).

Create one instance of the name/value pair attribute and attribute | @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> or
  • <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 Required. 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: *29
  • 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:
  • ObjectEvent Commissioning (Optional - 0 or more for commissioning events).
  • AggregationEvent (Optional - 0 or more for aggregation events).
  • ObjectEvent Shipping (Mandatory - one for shipping event).
Order of events is not enforced by the schema.
      choice [1…1]
[-]		 - Required. Only one of the following choice options may be selected in any one loop on EPCISBody | EventList | ObjectEvent OR EPCISBody | EventList | AggregationEvent.
      ObjectEvent [0…*]
[-]		 - Choice 1 for EventList. Data = ObjectEvent for the Commissioning Events.

EventList = ObjectEvent Commissioning when all of the following are true:

  • action = ADD
  • bizStep = urn:epcglobal:cbv:bizstep:commissioning
  • disposition = urn:epcglobal:cbv:disp:active
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Includes a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *30
        recordTime [0…1]
[0/*]		 DateTime This field is not used.
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at the time and place where the event occurred, consistent with the choice made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *31
        epcList [1…1]
[-]		 - Required. The EPCs of each item, case, and/or pallet commissioned.
          epc [1…*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *32
        action [1…1]
[0/*]		 String Required. The action value must equal ADD. *33
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:commissioning. *34
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:active. *35
        readPoint [0…1]
[-]		 - Read point is optional in commissioning 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. *36
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizLocation [1…1]
[-]		 - Required. Business location is required in commissioning event.
          id [1…1]
[1/*]		 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]
[-]		 - This field is not used.
        extension [0…1]
[-]		 - Main extension body for commission event.
          ilmd [0…1]
[-]		 - Instance lot master data specific to product being commissioned.
            cbvmda:lotNumber [0…1]
[0/*]		 String The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. *38
            cbvmda:itemExpirationDate [0…1]
[0/*]		 Date The expiration date for the serialized item in YYYY-MM-DD format. *39
            tl:commissionEventExtensions [0…1]
[-]		 - Extensions used for Commission ObjectEvent.

The following items can be sent in the master data header extensions:

  • tl:packagingLevel
  • tl:internalMaterialCode
  • tl:packagingItemCode
  • tl:packagingItemCode | @type
  • tl:countryDrugCode
  • tl:countryDrugCode | @type
Note: Full GS1 conformance requires all master data be stored in the header extension EPCISMasterData | VocabularyList. While master data can be sent from the commissioning event extensions, it is strongly urged that all product master data items for the commissioning event be sent in the header extensions elements.
              tl:filterValue [0…1]
[-]		 Integer

tl:filterValue is used only if it is mandatory by a trade partner to convert SSCC to GS1 HEX or Tag URI format.

See the FilterValue enumeration list for valid values.
              tl:packagingLevel [0…1]
[0/*]		 String The packaging level of the commissioned item using the supported enumeration values. *40
To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data (i.e. a homogenous pallet).

See the PackagingLevel enumeration list for valid values.
              tl:epcAttributes [0…*]
[-]		 - Supports optional inclusion of human readable barcode content associated with each epc number in a commission event. Included only if provided in original commission event.
                @epc [1…1]
[1/*]		 String Conditionally required. The EPC serial number to which the barcodeContent is associated. The epc must be an EPC Pure Identity URI as specified in Section 6 of [TDS1.5]. *41
  • Case: SGTIN or SSCC
  • Item: SGTIN
  • Pallet: SSCC
                tl:barcodeContent [1…1]
[1/*]		 String Required. The human readable barcode contents encoded in the 2D barcode with parentheses for the AI keys. *42
              tl:plantLocationId [0…1]
[0/*]		 String Identifier of plant where products were commissioned. *43
              tl:productionLineId [0…1]
[1/*]		 String Conditionally required for China. Identifier of production line where products were commissioned. *44
              tl:lineManagerName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible as the production line manager for the commissioned products. *45
              tl:companyPrefix [0…1]
[0/*]		 String This field not used.
              tl:internalMaterialCode [0…1]
[0/*]		 String Internal material number for the product in the Pharmaceutical Manufacturer's internal systems (e.g. ERP). *46
See the following additional information:
  • To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data.
  • The message may include either tl:internalMaterialCode or tl:countryDrugCode, but all packaging levels must be consistent.
              tl:packagingItemCode [0…1]
[0/*]		 String The product code for the commissioned item (e.g. GTIN-14). *47
                @type [1…1]
[1/*]		 String Required. The product code type using the supported enumeration values. *48

See the ItemCode enumeration list for valid values.
              tl:countryDrugCode [0…1]
[0/*]		 String The national drug code for the commissioned item (e.g. NDC number for US products). *49
See the following additional information:
  • To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data.
  • The message may include either tl:internalMaterialCode or tl:countryDrugCode, but all packaging levels must be consistent.
                @type [0…1]
[0/*]		 String The national drug code type using the supported enumeration values and any formatting instructions provided. *50
To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data.

See the CountryDrugCode enumeration list for valid values.
              tl:manufacturingDate [0…1]
[0/10]		 Date The date of manufacture for the serialized item, in YYYY-MM-DD format. *51
              tl:countryMarket [0…1]
[0/3]		 Date ISO country code for target country market for which the product was manufactured. Used for triggering production notifications associated with a produced batch. If batch is multi-market, then production notification will be triggered at time of shipment and this field would not be populated. *52

See the ISOCountryCode enumeration list for valid values.
              tl:referenceDocuments [0…1]
[-]		 - Reference document identifier associated with the commissioning activity.
                tl:poNumber [0…1]
[0/*]		 String PO Number associated with serial number use. *53
                tl:poLine [0…1]
[0/*]		 String PO Line number. *54
                tl:workOrderNumber [0…1]
[0/*]		 String Work Order number associated with serial number use. *55
                tl:referenceIdentifier [0…1]
[0/*]		 String Reference identifier (e.g. any type of identifier) associated with serial number use. *56
              tl:extensionField [0…*]
[-]		 - One or more name/value pairs that contain additional data attributes not already supported in this message.

When this attribute is populated, both the tl:fieldName and fl:fieldValue elements must be populated.

These extensions are not stored by TraceLink and are only used for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this transaction (e.g. when a CMO is required to provide additional data fields to the brand owner). Different trade partners may have different field requirements and may require that the ExtensionField be populated differently per trade partner.
                tl:fieldName [1…1]
[1/*]		 String Field name provided by the trade partner that will receive the outbound message. *57
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 Field value that corresponds to the tl:fieldName. *58
          tl:locationId [0…1]
[0/*]		 String Location to associate the Transaction Histories when they are created.
            @type [0…1]
[0/*]		 String

Attribute that identifies the location types.

See the LocationIdType enumeration list for valid values.
      AggregationEvent [0…*]
[-]		 - AggregationEvent is option 2 for the EventList choice for the Aggregation events.

EventList = AggregationEvent when all of the following are 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]. *59
        recordTime [0…1]
[0/*]		 DateTime Not used.
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at the time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *60
        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. *61
        childEPCs [1…1]
[-]		 - Required. A list of identifiers of the child items in the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPCs are 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. *62
        action [1…1]
[1/*]		 String Required. The action value must equal ADD for the aggregation event. *63
        bizStep [0…1]
[0/*]		 AnyURI The bizStep value must equal urn:epcglobal:cbv:bizstep:packing. *64
        disposition [0…1]
[0/*]		 AnyURI The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *65
        readPoint [0…1]
[-]		 - Optional for Aggregation 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. *66
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizLocation [1…1]
[-]		 -

Required. Mandatory for aggregation 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. *67
        bizTransactionList [0…1]
[-]		 - Not used.
        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. *68

See the PackedStatus enumeration list for valid values.
          tl:quantity [0…1]
[-]		 Integer The quantity of child serial numbers aggregated to the parent container in this aggregation. *69
          tl:resetContainerAggregation [0…1]
[-]		 Boolean Reset container aggregation flag. *70
          tl:epcOrderItemDetails [0…1]
[-]		 - Group header for epcOrderItemDetails with a specific link between tl:orderItem | tl:orderItemNumber in the receiving event and the epc serial number.
            tl:epcOrderItemList [1…*]
[-]		 - Subgroup header.
              @orderItemNumber [0…1]
[-]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of tl:orderItem, in EPC Pure Identity URI format.
              tl:epcOrderItem [1…*]
[-]		 String Serial numbers associated with the pricing and tax information in the current instance of the ItemOrder.
          tl:extensionField [0…*]
[-]		 - One or more name/value pairs that contain additional data attributes not already supported in this transaction.

When populating this element, both the tl:fieldName and tl:fieldValue elements must be populated.

These extensions are not stored by TraceLink and are only used for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this transaction (e.g. when a CMO is required to provide additional data fields to the brand owner). Different trade partners may have different field requirements and may require that the ExtensionField be populated differently per trade partner.
            tl:fieldName [1…1]
[1/*]		 String Field name provided by the trade partner that will receive the outbound message. *71
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 Field value that corresponds to the tl:fieldName. *72
      ObjectEvent [1…1]
[-]		 - Required. EventList. Data = ObjectEvent for Shipping events.

EventList = ObjectEvent Shipping when all of the following are true:

  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:shipping
  • disposition = urn:epcglobal:cbv:disp:in_transit
        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]. *73
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at the time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *74
        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 EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples.
        action [1…1]
[0/*]		 String Required. The action value must equal OBSERVE. *75
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:shipping. *76
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:in_transit. *77
        readPoint [0…1]
[-]		 - Required. The location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin) in URN format, that recorded the ObjectEvent.
          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. *78
          extension [0…1]
[-]		 - Not used - GS1 Reserved
        bizLocation [0…1]
[-]		 - Not used.
          id [1…1]
[1/*]		 AnyURI Required. Not used. *79
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizStep = urn:epcglobal:cbv:bizstep:shipping. A list of the business transaction identifiers.
          bizTransaction [1…*]
[-]		 AnyURI Required. 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). *80
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). *81

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. *82
        extension [0…1]
[-]		 - Main extension body for shipping event.
Source and Destination lists are optional even if party address master data is not stored in the VocabularyElement in the EPCISMasterData extension in the message header.
          sourceList [0…1]
[-]		 -

Conditionally required if:

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.

Mandatory 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.

Sending business, location, and carrier parties.

sourceList supports one of two functions:

  1. VocabularyElement populated with party address master data; sourceList identifies sold-from, ship-from, or carrier party. Party master data mapped from VocabularyElement.
  2. VocabularyElement NOT populated with party address master data; sourceList party identifiers used for master data lookup in backend.
            source [1…*]
[0/*]		 String Required. Source party identifier for sold-from, ship-from, or carrier parties. Party identifier in source either: *83
  1. Identifies sold-from, ship-from, or carrier party in populated VocabularyElement. Party address info 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 included.

See the MDPartyTypeAttributes enumeration list for valid values.
              @type [1…1]
[0/*]		 String Conditionally required if source is populated. Type of source party identifier [i.e. owning (sold-from), location (ship-from), or carrier party.] Valid values: *84
  • Sold-from party = urn:epcglobal:cbv:sdt:owning_party (). Conditionally required if:

    • 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.

    Mandatory 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.
  • 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:

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.

Mandatory 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.

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 and ship-to parties. Party identifier in destination either: *85
  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 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 populated. Identifies type of destination party identifier, i.e. owning (sold-to) or location (ship-to) party. Valid values: *86
  • Sold-to party = urn:epcglobal:cbv:sdt:owning_party (). Conditionally required if:

    • 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.

    Mandatory 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.
  • Ship-to party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
        tl:shippingEventExtensions [0…1]
[-]		 - Conditionally required if Shipping Event is populated. Extensions used for Shipping Event.
          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. *87
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. 2 or 3 letter ISO country code for ship to country. This value is referenced to advise regulatory reporting if it is required for the specified country market. *88

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.
          tl:shipFromCountryCode [0…1]
[2/2]		 String Conditionally required if tl:salesDistributionType = EXPORTSALE, EXPORTTRANSFER, or EXPORTRETURN. 2 or 3 letter ISO country code for ship from country. This value will be referenced to advise regulatory reporting if it is required for the specified country market. *89

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.
          tl:salesDistributionType [1…1]
[1/*]		 String Required. To set this value, compare the ship from country with the ship to country. *90
  • INCOUNTRYSALE: If ship from country = ship to country (indicates a sale within the same country).
  • EXPORTSALE: If ship from country <> ship to country (indicates a sale that is an export to another country).
  • INCOUNTRYTRANSFER: A transfer within a company or with a partner such as 3PL or contract manufacturer/packager, occurring within the same country.
  • EXPORTTRANSFER: A transfer within a company or with a partner such as 3PL or contract manufacturer/packager, made from one country to another.
  • INCOUNTRYRETURN: A shipment for a return of goods to the supplier, shipped within the same country.
  • EXPORTRETURN: A shipment for a return of goods to the supplier, shipped from one country to another.

The EXPORT value is not used. This value will be referenced to advise regulatory reporting of exportation, if it is mandatory 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.

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

Conditionally required:

  • If cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN; All values except for Collection apply.
  • For Brazil: Populate only if performing Collection, Donation, or SampleDistribution.

The type of supply that is being performed using a valid value from the enumerations list.

See the SupplyType enumeration list for valid values.
          tl:contractType [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN. Identifies the type of contract for the sale of goods using a valid value from the enumerations list.

See the ContractType enumeration list for valid values.
          tl:dropShipmentIndicator [0…1][0/*] Boolean Indicates if shipment is a drop shipment. *91
          tl:portalAccessCode [0…1][0/*] String The portal access code used to access drop shipments in the serialized drop ship portal.
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with delivery.
          tl:warehouseOperatorName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible for warehouse operations. *92
          tl:correctiveShipment [0…1]
[0/*]		 Boolean Corrective shipment flag is set when shipment is used to replace a previously voided shipment. *93
          tl:originalDeliveryNumber [0…1]
[0/*]		 String Used to identify previous delivery that was voided and is being replaced by current delivery. *94
Populated only if tl:correctiveShipment = true.
          tl:contractNumber [0…1]
[0/*]		 String Identification number of the contract. *95
          tl:fundingSource [0…1]
[0/*]		 String Conditionally required if both tl:shipToCountry and tl:shipFromCountry = RU. Source of the funding. *96

See the FundingSource enumeration list for valid values.
          tl:disaggregateFromParent [0…1]
[–]		 Boolean Valid values: *97
  • true - instructs backend to disaggregate a serial number from its parent container (if aggregated).
  • false - instructs backend to operate in default mode, which is to generate an error when attempting to change the status of a serial number aggregated to a parent container.
If source is not populated, target will default to false.
          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. *98
          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:epcOrderItemDetails [0…1]
[-]		 - Group header with specific link between the aggregation event epc and @orderItemNumber.
            tl:epcOrderItemList [1…*]
[-]		 - Required. Subgroup header.
              @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.
              tl:epcOrderItem [1…*]
[1/*]		 String Required. Serial numbers associated with the pricing and tax information in the current instance of tl:orderItem.
          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. 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 tl:InternalMaterialCode or tl:PackagingItemCode.
              tl:internalMaterialCode [0…1]
[1/*]		 String Conditionally required if tl:packagingItemCode is not populated. Option 1 for choice%1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *99
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if tl:internalMaterialCode is not populated. 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. *100
                @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.
              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. *101
              cbvmda:itemExpirationDate [0…1]
[1/*]		 Date The expiration date for the serialized item, in YYYY-MM-DD format.
              tl:quantity [1…1]
[0/*]		 Integer 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. *102
              tl:unitPrice [0…1]
[0/*]		 Decimal Conditionally required if cmn:shipFromCountryCode = KR, or if tl:shipToCountryCode = RU and tl:shipFromCountryCode = AM, BY, KG, KZ, or RU. Unit price of item. *103
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *104
              tl:vat [0…1]
[-]		 Decimal Value Added Tax per unit. *105
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *106

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

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is not serialized. If omitted, defaults value to true. *108
              tl:transactionIdentifier [0…*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *109
                @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:shipFromCountryCode = RU. The transaction identifier date. *110
      TransactionEvent [0…*]
[-]		 -

TransactionEvent is Option 6 for the EventList choice for the Transaction events and is optional to support associating a purchase order with a specific serial number for shipments that contain one or more purchase orders.

The bizStep and disposition values are populated from the linked event (e.g. shipping, receiving, void shipment). Valid values for action are ADD, OBSERVE, or DELETE.
        eventTime [1…1]
[1/*]		 DateTime Required. The timestamp of date and time when the event occurred. Includes timezone indicator as specified in Section 9.5 of [EPCIS 1.0.1].
        recordTime [0…1]
[0/*]		 DateTime Not used.
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].
        bizTransactionList [1…*]
[-]		 - Required.
          bizTransaction [1…*]
[0/*]		 anyURI Required. The business transaction identifiers for the Advance Ship Notice and/or Invoice and/or Purchase Order governing this shipment, subject to Section 8.4.2 of [CBV1.0]. *111

Example: urn:epcglobal:cbv:btt:po:0333331013655:45006290016.

The GLN that occurs after "urn:epcglobal:cbv:bt:" identifies the party that issued the message, i.e. if the customer issues a purchase order, the GLN of the customer is included as the GLN in the bizTransaction string.
            @type [1…1]
[1/*]		 String Required. The transaction identifier type. Valid value: urn:epcglobal:cbv:btt:po
            @date [0…1]
[0/*]		 Date The transaction identifier date in YYYY-MM-DD format.
        epcList [1…1]
[-]		 -

Required. List of the EPCs of top most containers (e.g. pallets, cases) in the shipment.
          epc [0…*]
[0/*]		 String Required. The EPC identifier in EPC Pure Identity URI format:

  • SGTIN: urn:epc:id:sgtin:<company prefix>.<inidcator digit + item reference>.<serial number>

  • SSCC: urn:epc:id:sscc:<company prefix>.<extension digit + serial number>

  • CN EDMC:

    • New: http://epcis.tracelink.com/hc/cn-edmc/obj/<serial number>

    • Legacy: http://epcis.tracelink.com/obj/cn-edmc/<serial number>

  • NTIN:

    • New: http://epcis.tracelink.com/hc/ntin/obj/<companyprefix>.<item reference>.<serial number>

    • Legacy: http://epcis.tracelink.com/obj/ntin/<companyprefix>.<item reference>.<serial number>
        action [1…1]
[0/*]		 String

Required. Set the action value to ADD.
        bizStep [0…1]
[0/*]		 String

Required. Set the action value to urn:epcglobal:cbv:bizstep:shipping.
        disposition [0…1]
[0/*]		 String

Required. Set the action value to urn:epcglobal:cbv:disp:in_transit.
        readPoint [0…1]
[-]		 -

Required.

          id [1…1]
[0/*]		 anyURI Required. The readPoint ID.
        bizLocation [0…1]
[-]		 -

-
          id [1…1]
[1/*]		 anyURI The EPC pure identity of the location where the objects are presumed to be following the event. This may be a site-level SGLN, or a finer-grain location identifier.