ESM Decommission Guidelines (EPCIS v1.0)

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 [1…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. 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. Defines the sender identifier type as a GLN. The @Authority value is set to GLN for GS1 XML messages. *5
      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. GLN identifier for the receiver. The value of the sbdh:Identifier element is a GLN per GS1 standards.
          @Authority [1…1]
[1/*]		 String Required. Defines the receiver identifier type as a GLN. The @Authority value is set to GLN for GS1 XML messages.
      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. *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 Header Version as these are hard-coded values. The sbdh:TypeVersion is set to 1.0. *7
        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 is a hard-coded value. This identifier confirms this document as being distinct from others. *8
        sbdh:Type [1…1]
[0/*]		 String Required. Document type. The sbdh:Type value is set to Events for an aggregation event. *9
        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. *10
  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 [1…*]
[-]		 - Required. Records decommission events.
        eventTime [1…1]
[1/*]		 DateTime Required. The date/time time stamp when the decommission event occurred. *11
        eventTimeZoneOffset [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 value must equal DELETE for a decommission event. *14
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:decommissioning for a decommission event. *15
        disposition [0…1]
[0/*]		 AnyURI Required. The status of the transaction. The disposition value must equal urn:epcglobal:cbv:disp:inactive for a decommission event. *16
        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 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. *17
        bizLocation [1…1]
[-]		 - The business location of the message sender who executed the event.
          id [1…*]
[1/*]		 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. 
        tl:decommissionEventExtensions [0…1]
[-]		 - Required. 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 message document in the bizTransactionList. This date may or may not be the same as the eventTime field. *18
          tl:marketCountryCode [0…1]
[2/2]		 String This field indicates the market country code. *19
          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 decommissioned 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 required for regulatory reporting. Different countries require different values. *20
Country Requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • For company's physically located in Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @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: provide the business classification of the sold from party using one of the provided enumerations. 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 who decommissioned the serial numbers. *21
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the address for the company indicated in tl:businessName. *22
              tl:street2 [0…1]
[0/*]		 String The second line of the address for the company indicated in tl:businessName. *23
              tl:city [1…1]
[1/*]		 String Required. The city for the company indicated in tl:businessName. *24
              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. *25
              tl:postalCode [0…1]
[1/*]		 String The postal code for the company indicated in tl:businessName. *26
              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-1 alpha-2:1997 country code. *27
          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). *28
          tl:decommissionReasonCode [0…1]
[0/*]		 String Reason code for decommission. *29

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