Decommission Event Message Guidelines (EPCIS v1.0)

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. 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:SS:mmZ. *2
  EPCISHeader [1…1]
[-]		 - Required. The XML file control header.
    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 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 sbdh:Sender element must only be used once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The GLN identifier for the sender. The value of the sbdh:Identifier element is a GLN per GS1 standards. *4
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages. *5
        sbdh:ContactInformation [0…*]
[-]		 - Not used.
      sbdh:Receiver [1…*]
[-]		 - Required. This field indicates 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. The GLN identifier for the receiver. The value of the sbdh:Identifier element is a GLN per GS1 standards.
          @Authority [1…1]
[1/*]		 String Required. The receiver identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages.
        sbdh:ContactInformation [0…*]
[-]		 - Not used.
      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. 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. *10
  EPCISBody [1…1]
[-]		 - Required. All of the EPCIS events for this message.
    EventList [1…1]
[-]		 - Required. All events within the transaction including event details. A Decommission Event is indicated by the action, bizstep, and disposition. The details of the decommission event are also included (such as event time, epcs). 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. The date/time time stamp of when the decommission event occurred. Format YYYY-MM-DDThh:mm:ss:sssZ. *11
Mandatory per Section 9.5 of [EPCIS1.0.1].
        recordTime [0…1]
[0/*]		 DateTime This field is not used.
        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. Numerous EPC identifiers can be provided, which creates a list of items/cases. *13
        action [1…1]
[0/*]		 String Required. The action taken in the message. 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 [0…1]
[-]		 - The location where the event occurred; that is, the warehouse GLN location ID and storage location (e.g. shelf, bin, etc.) 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 finer-grain location identifier. *17
        bizLocation [1…1]
[-]		 - -
          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.
        bizTransactionList [0…1]
[-]		 - Not used.
        locationId [0…1]
[-]		 String Serialized Operations Manager External Subscriber Location identifier. Type of identifier defined by type enum below. *18

When messages are submitted by an external Serialized Operations Manager Partner, the system will use the partner 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.
          @type [1…1]
[1/*]		 String Required. Attribute that identifies the location types. *19

See the MessagePartyIdType enumeration list for valid values.
        tl:decommissionEventExtensions [0…1]
[-]		 - The extensions used for decommissioning the ObjectEvent.
          tl:transactionDate [0…1]
[0/*]		 Date The date, in XML date format YYYY-MM-DD, associated with the business transaction document in the bizTransactionList. This date may or may not be the same as the eventTime field. *20
          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. *21
          tl:businessPartyInfo [0…1]
[-]		 - Conditionally required for Brazil and South Korea. The full business information (e.g. business type, contact information) associated with the business entity that authorized the decommissioning the serial numbers.
            tl:businessId [1…*]
[1/*]		 String Required. The identifier associated with the business entity who decommissioned the serial number(s). This value is mandatory for regulatory reporting. Different countries require different values as noted below: *22
The business identifier is sometimes used as the LookupId in the TraceLink system. If multiple @type identifiers are sent for the businessId without addresses, the first businessId | @type sent will be stored as the LookupId while all additional identifiers sent will be ignored.
              @type [1…1]
[1/*]		 String

Required. The type of the Business ID identifier.

See the BusinessAndLocationId enumeration list for valid values.
            tl:businessClassification [0…1]
[0/*]		 String Conditionally required for Argentina. The identifier of the business type.

See the BusinessClassification enumeration list for valid values.
            tl:businessPartyDetail [0…1]
[-]		 - Conditionally required for US. The business name and address of the sold from or transfer from business entity (the entity that decommissioned the serial numbers).
              tl:businessName [1…1]
[1/*]		 String Required. The business name of the entity that authorized the decommissioning of the serial numbers. *23
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the address for the company indicated in tl:businessName. *24
              tl:street2 [0…1]
[0/*]		 String The second line of the address for the company indicated in tl:businessName. *25
              tl:city [1…1]
[1/*]		 String The city for the company indicated in tl:businessName. *26
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India.
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 tl:businessName, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *27
              tl:postalCode [0…1]
[1/*]		 String The postal code for the company indicated in tl:businessName. *28
              tl:country [1…1]
[1/*]		 String Required. The country where the company indicated in tl:businessName is located. The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *29
          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). *30
          tl:decommissionReasonCode [0…1]
[0/*]		 String The reason code for decommission. *31

See the DecommissionReasonCode (Decommission EPCIS v1.0) enumeration list for valid values.
          tl:reasonDescription [0…1]
[0/*]		 String A brief description of why the product was decommissioned. *32