Decommission Event Guidelines (EPCIS v1.2)

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

Message Type: SOM_DECOMMISSION_EVENT

Info Exchange Display Name: Decommission 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. Date the message was created in XML DateTime format YYYY-MM-DDTHH:MM:SS:mmZ. *2

Mandatory according to the EPCIS standard.
  EPCISHeader [1…1]
[-]		 -

Required. The XML file control header.
    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. The version of the Standard Business Document Header (SBDH). The sbdh:HeaderVersion is 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 sbdh:Sender element must only be used 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 Authority was previously expected to be set to GLN for GS1 XML messages. Update made in December 2016 changed this to take additional values. *5

See the MDPartyTypeEnums enumeration list for valid values.
      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 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.

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 Authority was previously expected to be set to GLN for GS1 XML messages. Update made in December 2016 changed this to take additional values.

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

Required. The identification group for the message.

        sbdh:Standard [1…1]
[0/*]		 String

Required. The name of the document standard contained in the file/message. The standard value for this field is EPCglobal. *6
        sbdh:TypeVersion [1…1]
[0/*]		 String

Required. The version of the document included. This is the complete version of the document itself and is different from the sbdh:HeaderVersion as these are hard-coded values. The sbdh:TypeVersion is set to 1.0. *7
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String

Required. The reference information, which uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This is a hard-coded value. This identifier confirms this document as being distinct from others. *8
        sbdh:Type [1…1]
[0/*]		 String

Required. The document type. The sbdh:Type value is set to Events for a shipment event. *9
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime

Required. Date and time of the SBDH document creation in XML DateTime format YYYY-MM-DDTHH:MM:SS.mmZ. *10
  EPCISBody [1…1]
[-]		 -

Required. All of the EPCIS events for this message.
    EventList [1…1]
[-]		 -

Required. The ObjectEvent for decommissioning events is the only event expected in the EventList.
      ObjectEvent [1…*]
[-]		 -

Required. The ObjectEvent field records decommission events when the following criteria is set accordingly (see Transaction Identifiers for message type settings details).

        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] in XML DateTime format YYYY-MM-DDTHH:MM:SS.mmZ. *11
        eventTimeZoneOffset [1…1]
[1/*]		 String

Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time - whether it is standard time or daylight saving time. Per Section 7.2.8 of (EPCIS1.0.1). *12
        epcList [1…1]
[-]		 -

Required. The EPCs of each decommissioned item, case, and/or pallet.

          epc [1…*]
[1/*]		 String

Required. An item, pallet, or case EPC identifier in EPC Pure Identity URI format. Numerous EPC identifiers can be provided, which creates a list of items/cases. See EPC Pure Identifier Format Examples. *13
        action [1…1]
[0/*]		 String

Required. The action taken in the transaction. The action value is set to DELETE for a decommission event. *14
        bizStep [0…1]
[0/*]		 AnyURI

Required. The business step taken in the event. The bizStep value is set to urn:epcglobal:cbv:bizstep:decommissioning for a decommission event. *15
        disposition [0…1]
[0/*]		 AnyURI

Required. The bizStep, disposition, and action fields define the message event and are grouped together under the GS1 EPCIS guidelines. The disposition indicates the status of the message. The disposition value is set to urn:epcglobal:cbv:disp:inactive for a decommission event. *16
        readPoint [1…1]
[-]		 -

Required. The location where the event occurred. Defined with GS1-conformant party identifier types with full urn or http prefix. SGLN is strongly preferred, but other party types are supported.

readPoint links to location party address data if the data is present in VocabularyElement | @id. Use readPoint for master data lookup if it does not link to the location identifier in VocabularyElement | @id.
          id [1…1]
[0/*]		 AnyURI

Required. The party identifier of the location where the decommissioning event occurs. SGLN is strongly preferred for GS1 conformance, but other party identifiers are also supported. This may be a site-level SGLN or a finer-grain location identifier. *17

If the location address info is populated in EPCISMasterData header extension, this location identifier links to VocabularyElement | @id. If the location address is not present in VocabularyElement, this identifier is used for master data lookup in the TraceLink system.

See the MDPartyTypeAttributes enumeration list for valid values.
        bizLocation [0…1]
[-]		 -

The location where the event occurred.
          id [0…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. Omitted for decommissioning event.
        bizTransactionList [0…1]
[-]		 -

Business transaction list group.
          bizTransaction [1…*]
[0/*]		 AnyURI

The transaction identifier associated with the decommissioned product. *18
            @type [1…1]
[1/*]		 String

Required.

The transaction identifier type. Valid values:
  • http://epcis.tracelink.com/hc/btt/destruction
  • http://epcis.tracelink.com/hc/btt/removal
  • urn:epcglobal:cbv:btt:rma
            @date [0…1]
[0/*]		 Date Transaction identifier date attribute in XML YYYY-MM-DD format. *19
        tl:locationId [0…1]
[-]		 String

Serialized Operations Manager External Subscriber Location identifier. Type of identifier defined by the type enum below.

When transactions are submitted by an external Serialized Operations Manager partner, the system will use the subscriber company integration user to perform the action and log this in the audit trail so that all messages executed by the external Serialized Operations Manager partner are attributed to that company. *20
          @type [1…1]
[1/*]		 String

Required. Attribute that identifies the location types. *21

See the MessagePartyIdType enumeration list for valid values.
        tl:decommissionEventExtensions [0…1]
[-]		 -

Extensions used for ObjectEvent Decommissioning.

          tl:transactionDate [0…1]
[0/*]		 Date

Date associated with the business transaction document in bizTransactionList in XML date format YYYY-MM-DD. This date may or may not be the same as the eventTime. *22
          tl:disaggregateFromParent [0…1]
[1/*]		 Boolean

When set to true, instructs the backend to disaggregate a serial number from its parent container (if it is aggregated) when setting the PackagingSerialNumberStatus of the serial number to DECOMMISSIONED or DESTROYED.

If not set, or set to false, the backend operates 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 defaults to false.
          tl:marketCountryCode [0…1]
[2/2]		 String

The market country code. *23

See the ISOCountryCode enumeration list for valid values.
          tl:businessPartyInfo [0…1]
[0/*]		 -

Conditionally required for Russia. Authorizing party information for the decommissioning event.

Master data lookup is supported for decommissioning events if the full location address is not present. If master data lookup is not intended, send complete address information for the location of the decommissioning event.
            tl:businessId [1…*]
[0/*]		 String

Required. Identifier associated with the authorizing business entity.
              @type [1…1]
[0/*]		 String

Required. The business identifier type.

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

The classification of the business.

See the BusinessClassification enumeration list for valid values.
            tl:BusinessPartyDetail [0…1]
[-]		 -

Business name and address of the authorizing business entity.

              tl:businessName [1…1]
[0/*]		 String

Required. Business name of the entity that is authorizing the decommissioning of the serial numbers.
              tl:street1 [1…1]
[0/*]		 String

Required. First line of the address for the company indicated in tl:businessName.
              tl:street2 [0…1]
[0/*]		 String

Second line of the address for the company indicated in tl:businessName.

              tl:city [1…1]
[0/*]		 String

Required. City for the company indicated in tl:businessName.
              tl:village [0…1]
[0/*]		 String Name of the village in which the company is located.
              tl:houseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in tl:street1.
              tl:township [0…1]
[0/*]		 String Name of the township in which the company is located.
              tl:district [0…1]
[0/*]		 String

Conditionally required for India. District code.

Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[0/*]		 String

Required. The state, province, or region of the business entity indicated in tl:businessName, using the standard two-letter abbreviation specified in the ISO 3166-2:1998 country subdivision code.
              tl:postalCode [0…1]
[1/*]		 String

Postal code for the company indicated in tl:businessName.
              tl:country [1…1]
[0/*]		 String

Required. The country where the company indicated in tl:businessName is located. The country uses the standard two-letter abbreviation specified in the ISO 3166-1alpha-2:1997 country code.

See the ISOCountryCode enumeration list for valid values.

              tl:corporateFax [0…1]
[0/*]		 String Company fax number.
              tl:addressObjectGUID [0…1]
[0/36]		 String

The global identifier assigned by the Russian Federation Information Address System (FIAS). *24

Maximum of 36 characters, using the digits 0-9 and letters A-F
              tl:houseGUID [0…1]
[0/36]		 String

The global house identifier assigned by the Russian Federation Information Address System (FIAS). *25

Maximum of 36 characters, using the digits 0-9 and letters A-F
              tl:taxRegistrationCode [0…1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
              tl:premisesCode [0…1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
          tl:warehouseOperatorName [0…1]
[0/*]		 String

Conditionally required for China. Name of the person responsible for warehouse operations in the transfer from business entity (where the serial numbers were decommissioned). *26
          tl:decommissionReasonCode [0…1]
[0/*]		 String

Reason code for decommissioning. *27

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

Description of why the product was decommissioned. *28
          tl:destructionMethod [0…1]
[0/*]		 String

Method of destruction. *29

See the DestructionMethod enumeration list for valid values.