GS1 USHC Shipment Event Guidelines (EPCIS v1.1)

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

Message Type: SOM_SHIPMENT_EVENT

Info Exchange Display Name: Shipment 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 be set to 1.1. *1
  @creationDate [1…1]
[1/*]		 DateTime Required. The creation date of the message. *2
  EPCISHeader [0…1]
[-]		 - Required. XML file control header record.
    sbdh:StandardBusinessDocumentHeader [1…1]
[-]		 - Required. The business header information including EPCIS Header Version, Sender, and Receiver information along with the document identification.
      sbdh:HeaderVersion [1…1]
[0/*]		 String Required. The version number of the SBDH standard used. The sbdh: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 which created the standard business document. The sbdh:Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The SGLN identifier for the sender. *4
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type as a SGLN. *5
        sbdh:ContactInformation [0…*]
[-]		 - Not used.
      sbdh:Receiver [1…*]
[-]		 - Required. A unique identification key for the direct Receiver party of the message, representing the organization which receives the standard business document. The sbdh:Receiver element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The SGLN identifier for the receiver. *6
          @Authority [1…1]
[1/*]		 String Required. The receiver identifier type as a SGLN. *7
        sbdh:ContactInformation [0…*]
[-]		 - Not used.
      sbdh:DocumentIdentification [1…1]
[-]		 - Required. -
        sbdh:Standard [1…1]
[0/*]		 String Required. The name of the document standard contained in the payload. The sbdh:Standard value must be set to EPCglobal. *8
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. The version of the document included in the payload of SBDH. This is the complete version of the document itself and is different than the sbdh:HeaderVersion. The sbdh:TypeVersion value must be set to 1.0. *9
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. Description which contains reference information which uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier identifies this document as being distinct from others. *10
        sbdh:Type [1…1]
[0/*]		 String Required. The type of the document. The sbdh:Type value must be set to Events. *11
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime Required. Date and time of the SBDH document creation. *12
  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 (0 or more for commissioning events)
  • ObjectEvent Decommissioning (0 or more decommissioning events)
  • ObjectEvent Destroying (0 or more destroying events)
  • AggregationEvent (0 or more aggregation events)
  • ObjectEvent Shipping (one shipping event)
      choice [1…1]
[-]		 - Required. Only one of the following choice options may be selected in any one loop on EPCISBody | EventList: ObjectEvent or AggregationEvent.
      ObjectEvent [0…*]
[-]		 - Choice 1 for EventList. Data = ObjectEvent for the Commissioning Events.

EventList = ObjectEvent Commissioning when all of the following is 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. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *13
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        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]. *14
        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. *15
        action [1…1]
[0/*]		 String Required. The action value must be set to ADD. *16
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must be set to urn:epcglobal:cbv:bizstep:commissioning. *17
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must be set to urn:epcglobal:cbv:disp:active. *18
        readPoint [0…1]
[-]		 - Identifies the location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin), in URN format.
          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. *19
        bizLocation [0…1]
[-]		 - Required. Business location is mandatory for a 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.
        bizTransactionList [0…1]
[-]		 - Not used.
        extension [0…1]
[-]		 - Main extension body for commission event.
          ilmd [0…1]
[-]		 - Instance lot master data specific to product being commissioned.
            gs1ushc:lotNumber [0…1]
[0/*]		 String Conditionally required. The lot or batch code for the serialized item in an alphanumeric String of up to 20 characters. *20
            gs1ushc:itemExpirationDate [0…1]
[0/*]		 Date Conditionally required. The expiration date for the serialized item in YYYY-MM-DD format. *21
      ObjectEvent [0…*]
[-]		 - Choice 1 for EventList. Data = ObjectEvent for the Decommissioning Events.

EventList = ObjectEvent Decommissioning when all of the following is true:

  • action = DELETE
  • bizStep = urn:epcglobal:cbv:bizstep:decommissioning
  • disposition = urn:epcglobal:cbv:disp:inactive
        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]. *22
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        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]. *23
        epcList [1…1]
[-]		 - Required. The EPCs of each item, case, and/or pallet decommissioned.
          epc [1…*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *24
        action [1…1]
[0/*]		 String Required. The action value must be set to DELETE. *25
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must be set to urn:epcglobal:cbv:bizstep:decommissioning. *26
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must be set to urn:epcglobal:cbv:disp:inactive. *27
        readPoint [0…1]
[-]		 - The location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin), in URN format.
          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. *28
        bizLocation [1…1]
[-]		 - Required. The business location where the event occurred.
          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. *29
        bizTransactionList [0…1]
[-]		 - Not used.
        extension [0…1]
[-]		 - Not used.
      ObjectEvent [0…*]
[-]		 - Choice 1 for EventList. Data = ObjectEvent for the Destroying Events.

EventList = ObjectEvent Destroying when all of the following is true:

  • action = DELETE
  • bizStep = urn:epcglobal:cbv:bizstep:destroying
  • disposition = urn:epcglobal:cbv:disp:destroyed
        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]. *30
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        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]. *31
        epcList [1…1]
[-]		 - Required. The EPCs of each item, case, and/or pallet destroyed.
          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 be set to DELETE. *33
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must be set to urn:epcglobal:cbv:bizstep:destroying. *34
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must be set to urn:epcglobal:cbv:disp:destroyed. *35
        readPoint [0…1]
[-]		 - Identifies the location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin), in URN format.
          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
        bizLocation [1…1]
[-]		 - Required. The business location where the event occurred.
          id [1…1]
[1/*]		 AnyURI 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]
[-]		 - Not used.
        extension [0…1]
[-]		 - Not used.
      AggregationEvent [0…*]
[-]		 - Choice 2 for EventList. 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]. *38
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        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]. *39
        parentID [1…1]
[1/*]		 AnyURI Required. Identifier of the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPC of the case. For a case-to-pallet aggregation, the EPC of the pallet). See EPC Pure Identifier Format Examples. *40
        childEPCs [1…1]
[-]		 - Required. 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 of the items. For a case-to-pallet aggregation, the EPCs of the cases).
          epc [1…*]
[1/*]		 String Required. Identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *41
        action [1…1]
[1/*]		 String Required. The action value must be set to ADD for commissioning event. *42
        bizStep [0…1]
[0/*]		 AnyURI The bizStep value must be set to urn:epcglobal:cbv:bizstep:packing. *43
        disposition [0…1]
[0/*]		 AnyURI The disposition value must be set to urn:epcglobal:cbv:disp:in_progress. *44
        readPoint [0…1]
[-]		 - Identifies the location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin), in URN format.
          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. *45
        bizLocation [0…1]
[-]		 - Required. The business location where the event occurred.
          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. *46
        bizTransactionList [0…1]
[-]		 - Not used.
      ObjectEvent [0…*]
[-]		 - Choice 1 for EventList. Data = ObjectEvent for Shipping Events.

EventList = ObjectEvent Shipping when all of the following is 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. SHALL include a timezone indicator as specified in Section 9.5 of [EPCIS1.0.1] in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ. *47
        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]. *48
        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. *49
        action [1…1]
[0/*]		 String Required. The action value must be set to OBSERVE. *50
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must be set to urn:epcglobal:cbv:bizstep:shipping. *51
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must be set to urn:epcglobal:cbv:disp:in_transit. *52
        readPoint [0…1]
[-]		 - Required. Identifies the location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin), in URN format.
          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. *53
          extension [0…1]
[-]		 - Not used.
        bizLocation [0…1]
[-]		 - Not used.
          id [1…1]
[1/*]		 AnyURI Required. Not used. *54
          extension [0…1]
[-]		 - Not used.
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizstep = urn:epcglobal:cbv:bizstep:shipping. List of business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or invoice and/or purchase order governing this shipment.
          bizTransaction [1…*]
[0/*]		 AnyURI Required. The business transaction identifier 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).
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

Conditionally required if bizTransaction is populated. The transaction identifier type using the supported enumeration values (e.g. PO, ASN, RETURN, etc). *55

See the TransactionId enumeration list for valid values.
        extension [0…1]
[-]		 - Extension with sourceList and destinationList info corresponding to master data info in gs1ushc:companyMasterData group elements.
          sourceList [0…1]
[-]		 - Required. Source list identifies the sending and carrier parties identified in header extensions level.
            source [1…*]
[0/*]		 String Required. Source party identifier for sold from party.  *56
  • Owning party (i.e. sold from party) is mandatory.
  • Location party (i.e. ship from party) is optional. Include the ship from party only if different from sold from party.
              @type [1…*]
[0/*]		 String Required. Type of source party identifier, i.e. owning party. *57

Valid values:

  • http://epcis.tracelink.com/sdt/carrier_party (for Brazil)
  • urn:epcglobal:cbv:sdt:location (only include if identifier is different from owning_party)
  • urn:epcglobal:cbv:sdt:owning_party
          destinationList [0…1]
[-]		 - Required. Destination list identifies the sending and carrier parties identified in header extensions level.
            destination [1…*]
[0/*]		 String Required. Destination party identifier for sold to party. *58
  • Owning party (i.e. sold to party) is mandatory.
  • Location party (i.e. ship to party) is optional. Include the ship to party only if different from sold to party.
              @type [1…*]
[0/*]		 String Required. Type of source party identifier, i.e. owning party. *59

Valid values:

  • urn:epcglobal:cbv:sdt:location (only include if identifier is different from owning_party).
  • urn:epcglobal:cbv:sdt:owning_party
        gs1ushc:companyMasterData [0…1]
[-]		 - Company master data element group. Includes one set of attributes for each trading partner found in the associated Shipping event linked to the sourceList and destinationList.
          gs1ushc:companyMasterDataRecord(1) [0…*]
[-]		 - Instance 1 of companyMasterDataRecord element group. Identifies sold to business party master data identifier and address info.
            gs1ushc:identifier [1…1]
[0/*]		 String Required. Identifier element. Identifier matches destinationList/destination for type urn:epcglobal:cbv:sdt:owning_party. *60
            gs1ushc:companyName [1…1]
[0/*]		 String Required. Company name of the sold to business party. *61
            gs1ushc:street1 [1…1]
[0/*]		 String Required. The first line of the street address for the sold to business party. *62
            gs1ushc:street2 [0…1]
[0/*]		 String The second line of the street address for the sold to business party. *63
            gs1ushc:city [1…1]
[0/*]		 String Required. City name. *64
            gs1ushc:stateOrRegion [1…1]
[0/*]		 String Required. 2-character ISO state or region code. *65
            gs1ushc:postalCode [1…1]
[0/*]		 String Required. Postal code. *66
            gs1ushc:country [1…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *67
          gs1ushc:companyMasterDataRecord(2) [0…*]
[-]		 - Instance 2 of companyMasterDataRecord element group. Identifies ship to business party master data identifier and address info.
            gs1ushc:identifier [1…1]
[0/*]		 String Required. Identifier element. Identifier matches destinationList/destination for type urn:epcglobal:cbv:sdt:location. *68
            gs1ushc:companyName [1…1]
[0/*]		 String Required. Company name of the ship to business party. *69
            gs1ushc:street1 [1…1]
[0/*]		 String Required. The first line of the street address for the ship to business party. *70
            gs1ushc:street2 [0…1]
[0/*]		 String The second line of the street address for the ship to business party. *71
            gs1ushc:city [1…1]
[0/*]		 String Required. City name. *72
            gs1ushc:stateOrRegion [1…1]
[0/*]		 String Required. 2-character ISO state or region code. *73
            gs1ushc:postalCode [1…1]
[0/*]		 String Required. Postal code. *74
            gs1ushc:country [1…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *75
          gs1ushc:companyMasterDataRecord(3) [0…*]
[-]		 - Instance 3 of companyMasterDataRecord element group. Identifies sold from business party master data identifier and address info.
            gs1ushc:identifier [1…1]
[0/*]		 String Required. Identifier element. Identifier matches sourceList/source for type urn:epcglobal:cbv:sdt:owning_party. *76
            gs1ushc:companyName [1…1]
[0/*]		 String Required. Company name of the sold from business party. *77
            gs1ushc:street1 [1…1]
[0/*]		 String Required. The first line of the street address for the sold from business party. *78
            gs1ushc:street2 [0…1]
[0/*]		 String The second line of the street address for the sold from business party.
            gs1ushc:city [1…1]
[0/*]		 String Required. City name. *79
            gs1ushc:stateOrRegion [1…1]
[0/*]		 String Required. 2-character ISO state or region code. *80
            gs1ushc:postalCode [1…1]
[0/*]		 String Required. Postal code. *81
            gs1ushc:country [1…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *82
          gs1ushc:companyMasterDataRecord(4) [0…*]
[-]		 - Instance 4 of companyMasterDataRecord element group. Identifies ship from business party master data identifier and address info.
            gs1ushc:identifier [1…1]
[0/*]		 String Required. Identifier element. Identifier matches sourceList/source for type urn:epcglobal:cbv:sdt:location. *83
            gs1ushc:companyName [1…1]
[0/*]		 String Required. Company name of the ship from business party. *84
            gs1ushc:street1 [1…1]
[0/*]		 String Required. The first line of the street address for the ship from business party. *85
            gs1ushc:street2 [0…1]
[0/*]		 String The second line of the street address for the ship from business party.
            gs1ushc:city [1…1]
[0/*]		 String Required. City name. *86
            gs1ushc:stateOrRegion [1…1]
[0/*]		 String Required. 2-character ISO state or region code. *87
            gs1ushc:postalCode [1…1]
[0/*]		 String Required. Postal code. *88
            gs1ushc:country [1…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *89