ESM Decommission Guidelines (EPCIS v1.2)

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

Message Type: SOM_ESM_DECOMMSSION

Info Exchange Display Name: ESM Decommission

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. The EPCISDocument element contains the EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal

Required. The version of the EPCIS schema used to populate the EPCIS document elements. *1
  @creationDate [1…1]
[1/*]		 DateTime

Required. The date that the message was created in XML datetime format YYYY-MM-DDTHH:MM:SSZ. *2
  EPCISHeader [0…1]
[-]		 -

Required. 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 which created the standard business document. The Sender element must only be used 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 a urn/http prefix.

See the MDPartyTypeAtribbutes 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 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 a urn/http prefix.

See the MDPartyTypeAtribbutes 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. *7

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

Required. 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. *8
        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 Header Version as these are hard-coded values. The TypeVersion is set to 1.0. *9
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String

Required. Reference information, which 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. Document type. The Type value is set to Events for an aggregation event. *11
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime

Required. Date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however if it is not included, the system assumes that the time is GMT and therefore appends the Z. *12
  EPCISBody [1…1]
[-]		 -

Required. Contains all of the EPCIS events for the decommission message.

    EventList [1…1]
[-]		 -

Required. Contains all events within the transaction including event details. The details of the decommission event are also included (e.g. event time, EPCs).

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

ObjectEvent for the Decommissioning Events. EventList = ObjectEvent when:

  • action = DELETE
  • bizStep = urn:epcglobal:cbv:bizstep:decommissioning
  • disposition = urn:epcglobal:cbv:disp:inactive
        eventTime [1…1]
[1/*]		 DateTime

Required. The date/time time stamp when the decommission event occurred. *13
        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]. *14
        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. *15
        action [1…1]
[0/*]		 String

Required. The action value must equal DELETE for a decommission event. *16
        bizStep [1…1]
[0/*]		 AnyURI

Required. The bizStep value must equa0l urn:epcglobal:cbv:bizstep:decommissioning for a decommission event. *17
        disposition [1…1]
[0/*]		 AnyURI

Required. The status of the message. The disposition value must equal urn:epcglobal:cbv:disp:inactive for a decommission event. *18
        readPoint [1…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 decommission 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 more granular location identifier. *19
        bizLocation [0…1]
[-]		 -

The business location of the message sender who executes the event. This may be a site-level SGLN, or a more granular location identifier.

Per GS1 standards, not used for the decommissioning event.

          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 more granular location identifier.

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

The transaction identifier associated with the decommissioned product.20
            @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.21
        extension [0…1]
[-]		 -

Not used - GS1 Reserved.
        tl:locationId [0…1]
[0/*]		 String

External Subscriber Location identifier. When an external Serialized Operations Manager subscriber submits a message, the system uses 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 subscriber are attributed to that company.
          @type [1…1]
[0/*]		 String

Required. Attribute identifies the location types. *22

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

Extensions used for Decommission ObjectEvent.
          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. *23
          tl:disaggregateFromParent [0…1]
[1/*]		 Boolean

Valid values:

  • true - instructs the backend to disaggregate a serial number from its parent container (if aggregated) when setting the PackagingSerialNumberStatus of the serial number to DECOMMISSIONED or DESTROYED.
  • false - (default) instructs the backend 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:marketCountryCode [0…1]
[0/2]		 String

The market country code. *24

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

Conditionally required for Russia. The full business information (e.g. business type, contact information) associated with the authorizing party that decommissioned the serial numbers.
            tl:businessId [1…*]
[1/*]		 String

Required. Identifier associated with the authorizing party.  *25
              @type [1…1]
[1/*]		 String

Required. The type of the Business ID identifier. *26

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.
            tl:businessClassification [0…1]
[0/*]		 String

Business classification.

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

Populate with the business name and address of the authorizing business entity.

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

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

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

Second line of the address for the company indicated in tl:businessName.  *29
              tl:city [1…1]
[1/*]		 String

Required. The city for the company indicated in tl:businessName. *30
              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 only for India. *31

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

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

The postal code for the company indicated in tl:businessName. *33
              tl:country [1…1]
[1/*]		 String

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

See the ISOCountryCode enumeration list for valid values.

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

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

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

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

Maximum 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). *37
          tl:decommissionReasonCode [0…1]
[0/*]		 String

Reason code for decommission. *38

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

The reason the product was decommissioned. *39
          tl:destructionMethod [0…1]
[0/*]		 String

Method of destruction.40

See the DestructionMethod enumeration list for valid values.