Decommission and destruction APIs

Why do I use these messages?

Use the following messages to indicate that items or serial numbers are withdrawn from the supply chain as a result of decommissioning or destruction.

Decommissioning a serial number indicates that it has been withdrawn from the supply chain, but it can be reused again later (e.g. the serial number is decommissioned because it was commissioned with incorrect information). Destroying a serial number indicates that it is permanently withdrawn from the supply chain (e.g. the item that the serial number represents was physically destroyed).

Which report do these messages generate?

These messages generate one of the following reports in the Russia Compliance application if their contents meet the report conditions:

  • 552 - Withdrawal – Captures information about serialized items that are removed from supply chain circulation as the result of a quality sample, decommissioning, or destruction in a warehouse.
  • 542 - Destruction – Captures information about serialized items that are disposed of in a destruction facility (i.e. the items are decommissioned or destroyed in TraceLink).

TraceLink disaggregates the decommissioned or destroyed product if the serial numbers are aggregated to parent containers, which prompts a disaggregation event and initiates the 913 - Unit Extract report.

ESM Decommission (EPCIS v1.2)

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

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 requiredRequired. 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.

 
<epcis:EPCISDocument xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:tl="http://epcis.tracelink.com/ns" 
xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" 
xmlns:epcglobal="urn:epcglobal:xsd:1" schemaVersion="1" creationDate="2014-02-28T19:12:53Z">
<EPCISHeader>
    <sbdh:StandardBusinessDocumentHeader>
        <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
        <sbdh:Sender>
            <sbdh:Identifier Authority="GLN">81100001014507</sbdh:Identifier>
        </sbdh:Sender>
        <sbdh:Receiver>
            <sbdh:Identifier Authority="GLN">0614141123452</sbdh:Identifier>
        </sbdh:Receiver>
        <sbdh:DocumentIdentification>
            <sbdh:Standard>EPCglobal</sbdh:Standard>
            <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
            <sbdh:InstanceIdentifier>2013082106310032</sbdh:InstanceIdentifier>
            <sbdh:Type>Events</sbdh:Type>
            <sbdh:CreationDateAndTime>2015-04-30T19:12:53Z</sbdh:CreationDateAndTime>
        </sbdh:DocumentIdentification>
    </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2015-06-30T08:30:21Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207026272</epc>
                    <epc>urn:epc:id:sgtin:068202.0401034.15870395191309</epc>
                    <epc>urn:epc:id:sgtin:068202.5401034.40000000000019</epc>
                </epcList>
                <action>DELETE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:decommissioning</bizStep>
                <disposition>urn:epcglobal:cbv:disp:inactive</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:8888882.02867.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:8888882.02867.0</id>
                </bizLocation>
                <bizTransactionList>
                    <bizTransaction type="http://epcis.tracelink.com/hc/btt/removal" date="2019-04-01">123456789</bizTransaction>
                </bizTransactionList>
                <tl:decomissionEventExtensions>
                    <tl:transactionDate>2015-06-30</tl:transactionDate>
                    <tl:marketCountryCode>RU</tl:marketCountryCode>
                    <tl:businessPartyInfo>
                        <tl:businessId type="GLN">8888882028677</tl:businessId>
                        <tl:businessClassification>MANUFACTURER</tl:businessClassification>
                        <tl:BusinessPartyDetail>
                            <tl:businessName>Russian Pharma</tl:businessName>
                            <tl:street1>Bolshoy Devyatinsky Lane 8</tl:street1>
                            <tl:city>Moskva</tl:city>
                            <tl:stateOrRegion>Presnensky</tl:stateOrRegion>
                            <tl:postalCode>121099</tl:postalCode>
                            <tl:country>RU</tl:country>
                            <tl:addressObjectGUID>19406454-0022-000C-00B0-000000000152</tl:addressObjectGUID>
                            <tl:houseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</tl:houseGUID>
                        </tl:BusinessPartyDetail>
                    </tl:businessPartyInfo>
                    <tl:warehouseOperatorName>Sergei Smith</tl:warehouseOperatorName>
                    <tl:decommissionReasonCode>DAMAGED</tl:decommissionReasonCode>
                    <tl:reasonDescription>Damaged from production</tl:reasonDescription>
                </tl:decomissionEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description
Class 1
action Action DELETE is required for ObjectEvent decommissioning !!! The error occurs if the source does not equal "DELETE".
bizStep bizStep urn:epcglobal:cbv:bizstep:decommissioning is required for decommissioning !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:decommissioning".
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if bizTransaction is present and the source is empty or null, or if the source is not a valid value from the enumeration list.
disposition Dispositio​n urn:epcglobal:cbv:di​sp:inactive is required for decommissioning !!! The error occurs if the source does not equal "urn:epcglobal:cbv:di​sp:inactive".
epc Invalid EPC format !!! The error occurs if the source cannot be translated.
epc Invalid EPC format !!! The error occurs if the source is invalid.
ObjectEvent ObjectEvent is required for decommissioning !!! The error occurs if the source is empty or null.
readPoint | id Source read point ID is required !!! The error occurs if the source is empty or null.
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:businessClassification Valid business classification value is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:businessId Business party identifier is required !!! The error occurs if the source is empty or null.
tl:businessId | @type Party type attribute is required when BusinessId is populated !!! The error occurs if businessId is populated, but the source is empty or null.
tl:businessId | @type Valid business identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:locationId | @type Valid location identifier type is required if location ID is populated !!! The error occurs if the source empty or null, or is present, but there is no matching entry in the lookup file.
tl:businessName Business party name is required !!! The error occurs if the source is empty or null.
tl:city Business party city is required !!! The error occurs if the source is empty or null.
tl:country Business party country is required !!! The error occurs if the source is empty or null.
tl:decommissionReasonCode Valid reason code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:destructionMethod Valid destruction method code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:district 3-digit numeric District code required for country India !!! The error occurs if country = "IN", but the source is not a 3-digit numeric code.
tl:marketCountryCode Market Country Code must be at least two characters !!! The error occurs if the source is less than 2 characters.
tl:stateOrRegion Business party state or region is required !!! The error occurs if the source is empty or null.
tl:street1 Business party street address is required !!! The error occurs if the source is empty or null.
tl:warehouseOperatorName Warehouse operator name for China product is required !!! The error occurs if epc = "http://epcis.tracelink.com/hc/cn-edmc/obj/", but the source is empty or null.
Class 2
tl:addressObjectGUID AddressObjectGUID cannot be blank for Country RU The error occurs if tl:country = "RU", but the source is empty or null.
tl:businessPartyInfo Reporting Party is required when Transactions are included in the request and products are sold in Russia The error occurs if a Target Market in Product Master Data = "RU", but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Decommission Event (EPCIS v1.2)

CMOs and 3PLs use this message to decommission serial numbers on behalf of the product's MAH who owns Serialized Operations Manager. The event data uses the GS1 EPCIS format with extensions in the TraceLink namespace for additional decommission data elements that provide business and regulatory information.

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

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. *41
  @creationDate [1…1]
[1/*]		 DateTime

Required. Date the message was created in XML DateTime format YYYY-MM-DDTHH:MM:SS:mmZ. *42

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. *43
      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. *44

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. *45

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. *46
        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. *47
        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. *48
        sbdh:Type [1…1]
[0/*]		 String

Required. The document type. The sbdh:Type value is set to Events for a shipment event. *49
        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. *50
  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.

        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. *51
        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). *52
        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. *53
        action [1…1]
[0/*]		 String

Required. The action taken in the transaction. The action value is set to DELETE for a decommission event. *54
        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. *55
        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. *56
        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. *57

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. *58
            @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. *59
        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. *60
          @type [1…1]
[1/*]		 String

Required. Attribute that identifies the location types. *61

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. *62
          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. *63

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

Required. 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). *64

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). *65

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

Reason code for decommissioning. *67

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

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

Method of destruction. *69

See the DestructionMethod enumeration list for valid values.

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<epcis:EPCISDocument xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:tl="http://epcis.tracelink.com/ns" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
    xmlns:epcglobal="urn:epcglobal:xsd:1" schemaVersion="1.2" creationDate="2018-01-30T08:30:21Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">6667771013655</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8887771013655</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>201911221845200002</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-11-22T18:45:20.0Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2019-11-22T18:45:20.0Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024594</epc>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024595</epc>
                </epcList>
                <action>DELETE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:decommissioning</bizStep>
                <disposition>urn:epcglobal:cbv:disp:inactive</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:6667771.01365.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:6667771.01365.0</id>
                </bizLocation>
                <tl:locationId type="GLN">6667771013655</tl:locationId>
                <tl:decommissionEventExtensions>
                    <tl:transactionDate>2019-11-22</tl:transactionDate>
                    <tl:disaggregateFromParent>false</tl:disaggregateFromParent>
                    <tl:marketCountryCode>RU</tl:marketCountryCode>
                    <tl:businessPartyInfo>
                        <tl:businessId type="SGLN">088202.867778.0</tl:businessId>	
                        <tl:businessClassification>DISTRIBUTOR</tl:businessClassification>	
                        <tl:BusinessPartyDetail>	
                            <tl:businessName>Russia Pharma</tl:businessName>
                            <tl:street1>Bolshoy Devyatinsky Lane 8</tl:street1>
                            <tl:city>Moskva</tl:city>
                            <tl:stateOrRegion>Presnensky</tl:stateOrRegion>
                            <tl:postalCode>121099</tl:postalCode>
                            <tl:country>RU</tl:country>
                            <tl:addressObjectGUID>19406454-0022-000C-00B0-000000000152</tl:addressObjectGUID>
                            <tl:houseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</tl:houseGUID>
                        </tl:BusinessPartyDetail>
                    </tl:businessPartyInfo>
                    <tl:warehouseOperatorName>Sergei Smith</tl:warehouseOperatorName>
                    <tl:decommissionReasonCode>DAMAGED</tl:decommissionReasonCode>
                    <tl:reasonDescription>Defect from production</tl:reasonDescription>
                </tl:decommissionEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description Inbound / Outbound
Class 1
sbdh:Sender | sbdh:Identifier Source message sender is required !!! The error occurs if the source is empty or null. OB
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. IB
Partner type in source type attribute is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
sbdh:Receiver | sbdh:Identifier Source message receiver is required !!! The error occurs if the source is empty or null. OB
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. IB
Partner type in source type attribute is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
ObjectEvent ObjectEvent is required for decommissioning !!! The error occurs if the source is empty or null. IB
epc Invalid EPC format !!! The error occurs if the number could not be translated, or has any other unrecognized content. IB
Serial number is required !!! The error occurs if the source is empty or null. OB
action Action DELETE is required for decommissioning !!! The error occurs if the source does not equal "DELETE" for the decommission event. IB
bizstep bizStep urn:epcglobal:cbv:bizstep:decommissioning is required for decommissioning !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:decommissioning". IB
disposition Disposition urn:epcglobal:cbv:disp:inactive is required for decommissioning !!! The error occurs if the source does not equal "urn:epcglobal:cbv:disp:inactive". IB
readPoint | id Source read point ID is required !!! The error occurs if the source is empty or null. IB
Event Location Required !!! The error occurs if the source is empty or null. OB
Valid decommission event location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB
Valid Event Location Type Required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. OB
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if bizTransaction is present and the source is empty or null, or if the source is not a valid value from the enumeration list. IB
Valid transaction identifier type is required if TransactionIdentifier is populated !!! The error occurs if TransactionIdentifier is present and the source is empty or null, or if the source is not a valid value from the enumeration list. OB
locationId | @type Valid location identifier type is required if location ID is populated !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. IB
tl:transactionDate Transaction date is required !!! The error occurs if the source is empty or null. OB
tl:marketCountryCode Market Country Code must be at least two characters !!! The error occurs if the source is less than two characters. IB
tl:businessId Business party identifier is required !!! The error occurs if tl:businessPartyInfo is populated, but the source is empty or null. IB
Destroying business party ID is required !!! The error occurs if tl:businessPartyInfo is populated, but the source is empty or null. OB
tl:businessId | @type Valid business identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
Party type attribute is required when BusinessId is populated !!! The error occurs if tl:businessId is populated, but the source is empty or null. IB
tl:businessClassification Valid business classification value is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
tl:businessName Business name of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:street1 Street address of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:city City of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:district 3-digit numeric District code required for country India !!! The error occurs if tl:country = "IN", but the source is not a 3-digit numeric code. IB/OB
tl:stateOrRegion State or region of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:country Country of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:warehouseOperatorName Warehouse operator name for China product is required !!! The error occurs if cmn:NumberList | cmn:Serial | @format = "CN-EDMC", but source is empty or null. IB/OB
tl:decommissionReasonCode Valid reason code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
tl:destructionMethod Valid destruction method code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
Class 2
Class 2 errors are thrown in response to the Serialized Operations Manager Decommission (EPCIS v1.2) inbound message.
decommissionEvent Required field DecommissionEvent is empty The error occurs if the source is empty or null.
More than one DecommissionEvent found The error occurs if more than one source is found.
decommissionParam More than one decommissionParam found The error occurs if more than one source is found.
no decommissionParam found The error occurs if the source is empty or null.
inFilename, origFilename, origCompanyname, origFileDate, cntrlID File <inFilename> is a potential duplicate match with file <origFilename> sent from <origFilename> received on <origFileDate>, based on both files having the same File Control Number <cntrlID>. The error occurs if file is a duplicate.
message message body is null The error occurs if the source is empty or null.
tl:addressObjectGUID AddressObjectGUID cannot be blank for Country RU. The error occurs if tl:country = "RU", but the source is empty or null.
tl:businessPartyInfo Reporting Party is required when Transactions are included in the request and products are sold in Russia The error occurs if a Target Market in Product Master Data = "RU", but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Decommission (SOAP)

Guidelines

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.

Data Element Occurs
Length		 Type Description
soapenv:Envelope [1...1]
[-]		 - Required. SOAP Envelope root element.
  soapenv:Header [1...1]
[-]		 - Required. SOAP Message Header. Not used by TraceLink.
  soapenv:Body [1...1]
[-]		 - Required. SOAP Message Body.
    urn:Decommission [1...1]
[-]		 - Required. Decommission message.
      DecommissionRequest [0...1]
[-]		 - Required. The decommission request message to decommission a set of serial numbers.
        DisaggregateFromParent [0...1]
[1/*]		 Boolean

A flag that determines whether the system automatically disaggregates child serial numbers from the parent container, where relevant.

  • If set to true, the system automatically disaggregates child serial numbers from the parent container if they are aggregated.

  • If set to false, and the serial number to be decommissioned is aggregated to a parent container, the system returns an error. Defaults to false.
        SerialNumberList [0...1]
[-]		 - Required.The list of one or more serial numbers that will be decommissioned.
          SerialNumber [1...*]
[-]		   Required. The parent container's serial number.
            @sn [1...1]
[1/*]		 String Required. A parent serial number. See Serial Number Data Examples. *70
          @namespace [0...1]
[1/*]		 String Not supported by TraceLink. See Serial Number Data Examples.
        Sampled [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled. *71
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Damaged [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is damaged. *72
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Recalled [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was recalled. *73
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Expired [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is expired. *74
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Misplaced [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was misplaced. *75
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Dispensed [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was dispensed.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Disposed [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was disposed.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Repackaged [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is repackaged.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledByAuthorities [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled by authorities.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Stolen [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is stolen.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Withdrawn [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is withdrawn.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledCustomsControl [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for customs inspection.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledFederalInspection [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for federal inspection.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledClinicalStudy [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for performing clinical studies.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledPharmaStudy [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for post-registration pharmaceutical study supporting submitted changes to a dossier.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledMarketingDemo [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for marketing demonstration purposes.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Spoilage [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is spoiled (e.g. due to heat, oxygen, moisture, microorganisms).
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        WithdrawnExperiment [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is withdrawn from circulation of SSCC or SGTIN, piled or accumulated in the course of the experiment.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Defective [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is defective.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        InappropriatelyStored [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was inappropriately stored.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Returned [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was returned.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Other [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was decommissioned for other reasons.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        ReasonCode [0...1]
[-]		 String

A code that indicates the reason for the change in serial number status.  *76

See the ReasonCode enumeration list for valid values.

This is an optional field. If not specified, defaults to STATUSUPDATE.
        EventDateTime [0...1]
[-]		 Date The date and time of the event in XSD GMT date format (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system will record the current date-time. *77
        Transactions [0...1]
[-]		   Required. The transaction identifiers associated with the decommission. If providing the Excel 2003 format of the report, this is not required.
          Transaction [0...*]
[1/*]		 String Required. The list of one or more transaction identifiers associated with the decommission event.
            ItemID [0...1]
[1/*]		 String Conditionally required for Turkey. The transaction identifier associated with decommissioning. *78
            ItemType [0...1]
[1/*]		 String

Required. The transaction identifier type using the supported enumeration values (e.g. DESTRUCTION). *79

See the TransactionId enumeration list for valid values.
            Date [0...1]
[1/*]		 String Required. The date of the transaction in XML YYYY-MM-DD format. This value is used for regulatory reporting of the transaction date. *80
        ReasonDescription [0...1]
[1/*]		 String Conditionally required for Turkey (where the limit is 100 characters and the value must be in Turkish). The reason for the destruction. *81
        DestructionMethod [0...1]
[1/*]		 String

Required. The method of product destruction. *82

See the DestructionMethod enumeration list for valid values.
        LongRunningRestSupport [-]
[-]		 Boolean Not used.
        ReportingPartyIdentifier [0...1]
[-]		 - Required.The identifier of the business party that will be reporting the event to the government. *83
          @identifiertype [0...1]
[1/*]		 String

Required. Indicates the reporting business party identifier type. *84

See the IdentifierType enumeration list for valid values.
          @identifiervalue [0...1]
[1/*]		 String Required. Indicates the identifier value of the reporting business party. *85
        MarketCountryCode [0...1]
[2/3]		 String The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *86
        LocationType [0...1]
[1/*]		 String

The type of location where the event occurred. See the LocationId enumeration list for valid values.
        Location [0...1]
[1/*]		 String

Required. The site-level location identifier where the event occurred. This element defaults to the company level if no location is provided. *87

In most cases, this value is an SGLN, the format for which must be the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:tracelink:soap">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:Decommission>
            <DecommissionRequest>
                <DisaggregateFromParent>true</DisaggregateFromParent>
                <SerialNumberList>
                    <SerialNumber sn="00008820200000047506" namespace="?"/>
                </SerialNumberList>
                <Sampled>false</Sampled>
                <Damaged>false</Damaged>
                <Recalled>false</Recalled>
                <Expired>false</Expired>
                <MarketReleased>false</MarketReleased>
                <Misplaced>false</Misplaced>
                <Dispensed>false</Dispensed>
                <Disposed>false</Disposed>
                <Repackaged>false</Repackaged>
                <SampledByAuthorities>false</SampledByAuthorities>
                <Stolen>false</Stolen>
                <Withdrawn>false</Withdrawn>
                <SampledArchival>false</SampledArchival>
                <SampledCustomsControl>false</SampledCustomsControl>
                <SampledFederalInspection>false</SampledFederalInspection>
                <SampledClinicalStudy>false</SampledClinicalStudy>
                <SampledPharmaStudy>false</SampledPharmaStudy>
                <SampledMarketingDemo>false</SampledMarketingDemo>
                <SampledSelectiveControl>false</SampledSelectiveControl>
                <Spoilage>false</Spoilage>
                <WithdrawnExperiment>false</WithdrawnExperiment>
                <Defective>false</Defective>
                <InappropriatelyStored>false</InappropriatelyStored>
                <Returned>false</Returned>
                <Other>false</Other>
                <ReasonCode>STATUSUPDATE</ReasonCode>
                <EventDateTime>2015-06-01T17:10:16Z</EventDateTime>
                <Transactions>
                    <Transaction>
                        <ItemID>100250</ItemID>
                        <ItemType>DESTRUCTION</ItemType>
                        <Date>2015-06-01</Date>
                    </Transaction>
                </Transactions>
                <ReasonDescription>Depoda Hasarlı mallar</ReasonDescription>
                <ReportingPartyIdentifier identifiertype="COMPANYID" identifiervalue="8888882028677"/>
                <MarketCountryCode>TR</MarketCountryCode>
		 <LocationType>SGLN</LocationType>
                <Location>8888882.02867.0</Location>
            </DecommissionRequest>
        </urn:Decommission>
    </soapenv:Body>
</soapenv:Envelope>

Errors

Exception Code Exception Message
BADAGGREGATESTATE Operation could not be performed because serial number <serial number> and serial number <parent serial number> are currently in different states, or the operation would result in them having different states. Parent and child serial numbers are not permitted to be in different states.
CANNOTBEAGGREGATED Operation could not be performed because serial number <serial number> is aggregated to container <parent serial number>.
CROSSLOCATIONS Operation cannot be performed against serial numbers in multiple locations.
EVENTTIMEAFTERNOW Event time stamp must not be in the future.
EVENTTIMEBEFORELASTEVENT Event time stamp is earlier than the last event for serial number <serial number>.
MLTUPLE_ATTRIBUTES_DECOMMISSION The serial number(s) could not be decommissioned. The Decommission API request may only specify a single reason code.
NEVERCOMMISSIONED Serial number <serial number> was never commissioned.
NOSOMSERVICE No Serialized Operations Manager service found.
NOTCOMMISSIONED Serial number <serial number> is not commissioned.
NOTCOMMISSIONEDLOCATION Serial Number <serial number> was not commissioned at this location.
NOTVALIDLOCATION Location <location identifier> was not valid for serial number <serial number>.
SNNOTFOUND Serial number  <serial number> does not exist.
SOMDUPLICATESNS The following serial numbers were listed more than once: <serial number>.
VALIDATION Destruction Method is required for products sold in Russia.
Item Attribute is required for products sold in Russia.
Location is required for products sold in Russia.
Reporting Party is required when Transactions are included in the request and products are sold in Russia.
The parameter <field name> is missing or had an invalid value.
Transaction Identifier for 'Removal from Circulation' is required for products sold in Russia.

Guidelines

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.

The following fields are included in the message response:

Data Element Occurs
Length		 Type Description
S:Envelope [1...1]
[-]		 - Required. SOAP Envelope root element.
  S:Body [1...1]
[-]		 - Required. SOAP Message Body.
    ns2:DecommissionResponse [1...1]
[-]		 - Required. Decommission response message.
      TLResponse [0...1]
[-]		 - Required. TraceLink response message.
        Success [0...1]
[-]		 - Required. Indicates if the decommission request successfully processed. *88
        ExceptionReturn [0...1]
[-]		 - Conditionally required if Success = false; omitted otherwise. Error information.
          CallException [1...*]
[-]		 - Required. Error details including the exception code and error message, if available.
            ExceptionCode [0...1]
[0/*]		 String Required. Error code.
            ExceptionMessage [0...1]
[0/*]		 String Conditionally required if error condition is available. Message that further describes error condition.

Example

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">				
	<S:Body>			
		<ns2:DecommissionResponse xmlns:ns2="urn:tracelink:soap" xmlns:ns3="http://tracelink.com/som">		
			<TLResponse>	
				<Success>true</Success>
			</TLResponse>	
		</ns2:AggregateResponse>		
	</S:Body>			
</S:Envelope>

ESM Destroy (EPCIS v1.2)

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

Message Type: SOM_ESM_DESTROY

Info Exchange Display Name: ESM Destroy

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. *89
  @creationDate [1…1]
[1/*]		 DateTime Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *90
  EPCISHeader [0…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. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *91
      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 Sender element must be 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. *92

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 an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *93

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:Receiver [1...*]
[–]		 -

Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that 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. *94

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 an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String Required. This attribute defines the receiver identifier type. 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. *95

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:DocumentIdentification [1…1]
[–]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *96
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0. *97
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. Reference information that 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. *98
        sbdh:Type [1…1]
[0/*]		 String Required. Identifies the document type. The Type value is set to Events for a shipment event. *99
        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. *100
  EPCISBody [1…1]
[–]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1…1]
[–]		 - Required. The ObjectEvent for destroying events is the only event expected in the EventList.
      ObjectEvent [1...*]
[–]		 - Required. The ObjectEvent describing destroying events.

EventList = ObjectEventDestroying when :

  • action = DELETE
  • bizStep = urn:epcglobal:cbv:bizstep:destroying
  • disposition = urn:epcglobal:cbv:disp:destroyed
        eventTime [1…1]
[1/*]		 DateTime Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. The system expects the Z to be appendedif it is not included; however, the system assumes that the time is GMT and therefore appends the Z. *101
        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]. *102
        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. *103
        action [1…1]
[0/*]		 String Required. The action value must equal DELETE. *104
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:destroying. *105
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:destroyed. *106
        readPoint [0…1]
[–]		 - Required. Location where the event occurs. Define using the GS1-conformant party identifier types with full urn or http prefix. SGLN is strongly preferred, but other party types are supported.

Links to location party address data if present in VocabularyElement | @id.
          id [1…1]
[0/*]		 AnyURI Required. The party identifier of the location where the destroying 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. *107

This location identifier links to VocabularyElement | @id if location address information is present in the EPCISMasterData header extension.

See the MDPartyTypeAttributes enumeration list for valid values.
        bizLocation [0…1]
[–]		 - The business location of the message sender who executes the event. Not used for a destroying 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 finer-grain location identifier.
        bizTransactionList [0…1]
[–]		 - Business transaction list group.
          bizTransaction [1…*]
[0/*]		 AnyURI

The transaction identifier associated with the decommissioned product.108
            @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.109
        tl:locationId [0…1]
[0/*]		 String Serialized Operations Manager External Subscriber Location identifier. When messages are submitted by an external Serialized Operations Manager subscriber, the system uses the subscriber company integration user to perform the action and log this in the audit trail so that all transactions executed by the external Serialized Operations Manager subscriber are attributed to that company. *110
          @type [1…1]
[1/*]		 String Required. The location types. *111

See the MessagePartyIDType enumeration list for valid values.
        tl:destroyEventExtensions [1…1]
[–]		 - Required. Extensions used for ObjectEvent Destroying.
          tl:transactionDate [0…1]
[0/*]		 Date Date associated with the business message document in bizTransactionList in XML date format YYYY-MM-DD. This date may or may not be the same as the eventTime. *112
          tl:disaggregateFromParent [0…1]
[–]		 Boolean Valid values: *113
  • true - instructs 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 - instructs backend to operate 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 will default to false.
          tl:marketCountryCode [0…1]
[0/2]		 String Market country code. *114
          tl:businessPartyInfo [0…1]
[–]		 - Required. The full business information (e.g. business type, contact information) associated with the authorizing party that destroyed the serial numbers.
            tl:businessId [1...*]
[1/*]		 String Required. The identifier associated with the authorizing party.  *115
              @type [1…1]
[1/*]		 String Required. The type of the BusinessId identifier. *116
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]
[–]		 - 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 destruction of the serial numbers. *117
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the street address. *118
              tl:street2 [0…1]
[0/*]		 String The second line of the street address. *119
              tl:city [1…1]
[1/*]		 String Required. The city. *120
              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. *121
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code *122
              tl:postalCode [0…1]
[1/*]		 String The ZIP or other postal code. *123
              tl:country [1…1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *124

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).  *125

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).  *126

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

Reason code for decommission. *128

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

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

Method of destruction.130

See the DestructionMethod enumeration list for valid values.
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<epcis:EPCISDocument xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:tl="http://epcis.tracelink.com/ns" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"
    xmlns:epcglobal="urn:epcglobal:xsd:1" schemaVersion="1.2" creationDate="2017-01-30T08:30:21Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">81100001014507</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">0614141123452</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>2017013006310032</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2017-01-30T08:30:21Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2017-01-30T08:30:21Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207026272</epc>
                    <epc>urn:epc:id:sgtin:068202.0401034.15870395191309</epc>
                    <epc>urn:epc:id:sgtin:068202.5401034.40000000000019</epc>
                </epcList>
                <action>DELETE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:destroying</bizStep>
                <disposition>urn:epcglobal:cbv:disp:destroyed</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:8888882.02867.0</id>
                </readPoint>
                <bizTransactionList>
		      <bizTransaction type="http://epcis.tracelink.com/hc/btt/removal" date="2019-04-01">123456789</bizTransaction>
		 </bizTransactionList>
                <tl:locationId type="GLN">8888882028677</tl:locationId>
                <tl:destroyEventExtensions>
                    <tl:transactionDate>2017-01-30</tl:transactionDate>
                    <tl:disaggregateFromParent>false</tl:disaggregateFromParent>
                    <tl:marketCountryCode>US</tl:marketCountryCode>
                    <tl:businessPartyInfo>
                        <tl:businessId type="SGLN">088202.867777.0</tl:businessId>
                        <tl:businessClassification>DISTRIBUTOR</tl:businessClassification>
                        <tl:BusinessPartyDetail>
                            <tl:businessName>Russia Pharma</tl:businessName>
                            <tl:street1>Bolshoy Devyatinsky Lane 8</tl:street1>
                            <tl:city>Moskva</tl:city>
                            <tl:stateOrRegion>Presnensky</tl:stateOrRegion>
                            <tl:postalCode>121099</tl:postalCode>
                            <tl:country>RU</tl:country>
                            <tl:addressObjectGUID>19406454-0022-000C-00B0-000000000152</tl:addressObjectGUID>
                            <tl:houseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</tl:houseGUID>
                        </tl:BusinessPartyDetail>
                    </tl:businessPartyInfo>
                    <tl:warehouseOperatorName>Sergei Smith</tl:warehouseOperatorName>
                    <tl:decommissionReasonCode>DEFECTIVE</tl:decommissionReasonCode>	
                    <tl:reasonDescription>Defect from production</tl:reasonDescription>
		    <tl:destructionMethod>INCINERATION</tl:destructionMethod>
                </tl:destroyEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description
Class 1
action Action DELETE is required for destroying !!! The error occurs if the source does not equal "DELETE".
bizStep bizStep urn:epcglobal:cbv:bizstep:destroying is required for destroying !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:destroying".
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if bizTransaction is present and the source is empty or null, or if the source is not a valid value from the enumeration list.
disposition Dispositio​n urn:epcglobal:cbv:disp:destroyed is required for destroying !!! The error occurs if the source does not equal "urn:epcglobal:cbv:disp:destroyed".
epc Invalid EPC format !!! The error occurs if the source value could not be translated.
Serial number in source epc is required !!! The error occurs if the source is empty or null.
locationId | @type Location identifier type is required if location ID is populated !!! The error occurs if locationId is populated, but the source is empty or null.
locationId | @type Valid Location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
ObjectEvent ObjectEvent is required for destroying !!! The error occurs if the source is empty or null.
readPoint | id Source read point ID is required !!! The error occurs if the source is empty or null.
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:businessClassification Valid business classification value is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:businessId Business party identifier is required !!! The error occurs if the source is empty or null.
tl:businessId | @type Valid business identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Party type attribute is required when BusinessId is populated !!!! The error occurs if the source is empty or null.
tl:businessName Transfer from business party name is required !!! The error occurs if the source is empty or null.
tl:city Transfer from business party city is required !!! The error occurs if the source is empty or null.
tl:country Transfer from business party country is required !!! The error occurs if the source is empty or null.
tl:decommissionReasonCode Valid reason code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:destructionMethod Valid destruction method code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:district 3-digit numeric District code required for country India !!! The error occurs if Country = "IN", but the source is not a 3 character numeric code.
tl:marketCountryCode Market Country Code must be at least two characters !!! The error occurs if the source is present but is less than 2 characters.
tl:stateOrRegion Transfer from business party state or region is required !!! The error occurs if the source is empty or null.
tl:street1 Transfer from business party street address is required !!! The error occurs if the source is empty or null.
tl:warehouseOperatorName Warehouse operator name for China product is required !!! The error occurs if epc = "http://epcis.tracelink.com/hc/cn-edmc/obj/", but the source is empty or null.
Class 2
tl:addressObjectGUID AddressObjectGUID cannot be blank for Country RU The error occurs if tl:country = "RU", but the source is empty or null.
tl:businessPartyInfo Reporting Party is required when Transactions are included in the request and products are sold in Russia The error occurs if a Target Market in Product Master Data = "RU", but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Destroy Event (EPCIS v1.2)

CMOs and 3PLs use this message to decommission serial numbers on behalf of the product's MAH who owns Serialized Operations Manager. The event data uses the GS1 EPCIS format with extensions in the TraceLink namespace for additional decommission data elements that provide business and regulatory information.

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

Message Type:snd SOM_DESTROY_EVENT

Info Exchange Display Name: Destroy 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 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. Must be 1.2. *131
  @creationDate [1…1]
[1/*]		 DateTime

Required. The date that the message was created in XML DateTime format YYYY-MM-DDTHH:MM:SS:mmZ. *132
  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. *133
      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. A GLN, SGLN, or any other supported business party type. *134

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. *135

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. *136

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. *137

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. *138
        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. *139
        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. *140
        sbdh:Type [1…1]
[0/*]		 String

Required. The document type. The sbdh:Type value is set to Events for a shipment event. *141
        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. *142
  EPCISBody [1…1]
[-]		 -

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

Required. All events within the message including event details. A Decommission Event is indicated by the action, bizstep, and disposition. The details of the destroy event are also included (e.g. event time, epcs). The ObjectEvent for destroy events is the only event expected in the EventList.
      ObjectEvent [1...*]
[-]		 -

Required. The ObjectEvent field records destroy 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 when the destroy event occurred. *143
        recordTime [0…1]
[0/*]		 DateTime

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). *144
        epcList [1…1]
[-]		 -

Required. The EPCs of each destroyed 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. *145
        action [1…1]
[0/*]		 String

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

Required. The business step taken in the event. The bizStep value is set to urn:epcglobal:cbv:bizstep:destroying for a destroy event. *147
        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 transaction. The disposition value is set to urn:epcglobal:cbv:disp:destroyed for a destroy event. *148
        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 destroying event occurs. This may be a site-level SGLN or a finer-grain location identifier. *149

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 destroying event.
        bizTransactionList [0…1]
[-]		 -

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

The transaction identifier associated with the destroyed product. *150
            @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. *151
        locationId [0…1]
[-]		 String

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

When messages 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 transactions executed by the external Serialized Operations Manager Partner are attributed to that company.
          @type [1…1]
[1/*]		 String

Conditionally required if locationId is populated. Attribute identifies the location types.

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

The extensions used for destroying 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. *152
          tl:disaggregateFromParent [0…1]
[1/*]		 Boolean

When set to true, instructs 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

This field indicates the market country code. *153
          tl:businessPartyInfo [0…1]
[0/*]		 -

Required.Authorizing party information for the destroying event.

Master data lookup is supported for destroying 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 [0…1]
[0/*]		 String

The classification of 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 destruction of 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 the businessName field 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). *154

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). *155

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

The reason code for destroy. *157

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

A brief description of why the product was destroyed. *158
          tl:destructionMethod [0…1]
[0/*]		 String

Method of destruction. *159

See the DestructionMethod enumeration list for valid values.

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>					
<epcis:EPCISDocument xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:tl="http://epcis.tracelink.com/ns" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader"					
    xmlns:epcglobal="urn:epcglobal:xsd:1" schemaVersion="1.2" creationDate="2017-01-30T08:30:21Z">					
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">6667771013655</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8887771013655</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>201911221845200002</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-11-22T18:45:20.0Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2019-11-22T18:45:20.0Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024594</epc>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024595</epc>
                </epcList>
                <action>DELETE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:destroying</bizStep>
                <disposition>urn:epcglobal:cbv:disp:destroyed</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:6667771.01365.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:6667771.01365.0</id>
                </bizLocation>
                <tl:locationId type="GLN">6667771013655</tl:locationId>
                <tl:destroyEventExtensions>
                    <tl:transactionDate>2019-11-22</tl:transactionDate>
                    <tl:disaggregateFromParent>false</tl:disaggregateFromParent>
                    <tl:marketCountryCode>RU</tl:marketCountryCode>
                    <tl:businessPartyInfo>
                        <tl:businessId type="SGLN">088202.867778.0</tl:businessId>	
                        <tl:businessClassification>DISTRIBUTOR</tl:businessClassification>	
                        <tl:BusinessPartyDetail>	
                            <tl:businessName>Russia Pharma</tl:businessName>
                            <tl:street1>Bolshoy Devyatinsky Lane 8</tl:street1>
                            <tl:city>Moskva</tl:city>
                            <tl:stateOrRegion>Presnensky</tl:stateOrRegion>
                            <tl:postalCode>121099</tl:postalCode>
                            <tl:country>RU</tl:country>
                            <tl:addressObjectGUID>19406454-0022-000C-00B0-000000000152</tl:addressObjectGUID>
                            <tl:houseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</tl:houseGUID>
                        </tl:BusinessPartyDetail>
                    </tl:businessPartyInfo>
                    <tl:warehouseOperatorName>Sergei Smith</tl:warehouseOperatorName>
                    <tl:decommissionReasonCode>PRODUCTION_DEFECT</tl:decommissionReasonCode>
                    <tl:reasonDescription>Defect from production</tl:reasonDescription>
                </tl:destroyEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description Inbound/Outbound
Class 1
sbdh:Sender | sbdh:Identifier Source message sender is required !!! The error occurs if the source is empty or null. OB
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB
Partner type in source type attribute is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
sbdh:Receiver | sbdh:Identifier Source message receiver is required !!! The error occurs if the source is empty or null. OB
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB
Partner type in source type attribute is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
ObjectEvent ObjectEvent is required for destroying!!! The error occurs if the source is empty or null. IB
epc Invalid EPC format !!! The error occurs if the number could not be translated, or has any other unrecognized content. IB
Serial number is required !!! The error occurs if the source is empty or null. OB
Valid serial number is required !!! The error occurs if the serial number is invalid. OB
action Action DELETE is required for destroying!!! The error occurs if the source does not equal "DELETE" for the destroy event. IB
bizstep bizStep urn:epcglobal:cbv:bizstep:destroying is required for destroying !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:destroying". IB
disposition Disposition urn:epcglobal:cbv:disp:destroyed is required for destroying!!! The error occurs if the source does not equal "urn:epcglobal:cbv:disp:destroyed". IB
readPoint | id Event Location Required !!! The error occurs if the source is empty or null. OB
Valid Event Location Type Required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. OB
Source read point ID is required !!! The error occurs if the source is empty or null. IB
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if bizTransaction is present and the source is empty or null, or if the source is not a valid value from the enumeration list. IB
Valid transaction identifier type is required if TransactionIdentifier is populated !!! The error occurs if transactionIdentifier is present and the source is empty or null, or if the source is not a valid value from the enumeration list. OB
locationId | @type @type occurs fewer times than its minimum number of occurrences. The error occurs if the source is empty or null. IB
Location identifier type is required if location ID is populated !!! The error occurs if the source is empty or null. IB
Valid location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB
tl:transactionDate Destroy Event Transaction Date is required !!! The error occurs if the source is empty or null. OB
tl:marketCountryCode Market Country Code must be at least two characters !!! The error occurs if data is less than two characters. IB
tl:businessId Business party identifier is required !!! The error occurs if tl:businessPartyInfo is populated, but the source is empty or null. IB
Destroying business party ID is required !!! The error occurs if tl:businessPartyInfo is populated, but the source is empty or null. OB
tl:businessId | @type Valid business identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
Party type attribute is required when BusinessId is populated !!! The error occurs if tl:businessId is populated, but the source is empty or null. IB
tl:businessClassification Valid business classification value is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
tl:businessName Business name of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:street1 Street address of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:city City of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:district 3-digit numeric District code required for country India !!! The error occurs if tl:country = "IN", but the source is not a 3-digit numeric code. IB/OB
tl:stateOrRegion State or region of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:country Country of business party is required !!! The error occurs if the source is empty or null. IB/OB
tl:warehouseOperatorName Warehouse operator name for China product is required !!! The error occurs if epcList | epc = "http://epcis.tracelink.com/obj/cn-edmn/", but the source is empty or null. IB/OB
tl:decommissionReasonCode Valid reason code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
tl:destructionMethod Valid destruction method code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
Class 2
Class 2 errors are thrown in response to the Serialized Operations Manager Destroy (EPCIS v1.2) inbound message.
destroyEvent Required field DestroyEvent is empty The error occurs if the source is empty or null.
More than one DestroyEvent found The error occurs if more than one source is found.
destroyParams no DestroyParams found The error occurs if the source is empty or null.
More than one DestroyParams found The error occurs if more than one source is found.
inFilename, origFilename, origCompanyname, origFileDate, cntrlID File <inFilename> is a potential duplicate match with file <origFilename> sent from <origFilename> received on <origFileDate>, based on both files having the same File Control Number <cntrlID>. The error occurs if file is a duplicate.
message message body is null The error occurs if the source is empty or null.
tl:addressObjectGUID AddressObjectGUID cannot be blank for Country RU. The error occurs if tl:country = "RU", but the source is empty or null.
tl:businessPartyInfo Reporting Party is required when Transactions are included in the request and products are sold in Russia The error occurs if a Target Market in Product Master Data = "RU", but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Destroy (SOAP)

Guidelines

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.

The following data is sent in the request to TraceLink:

Data Element Occurs
Length		 Type Description
soapenv:Envelope [1...1]
[–]		 - Required. SOAP Envelope root element.
  soapenv:Header [1...1]
[–]		 - Not used by TraceLink.
  soapenv:Body [1...1]
[–]		 - Required. SOAP Message Body.
    urn:Destroy [1...1]
[–]		 - Required. Destroy Message.
      DestroyRequest [0...1]
[–]		 - Required. The destroy request message to destroy a set of serial numbers.
        DisaggregateFromParent [0...1]
[1/*]		 Boolean

A flag that determines whether the system automatically disaggregates child serial numbers from the parent container, where relevant.

  • If set to true, the system automatically disaggregates child serial numbers from the parent container if they are aggregated.

  • If set to false, and the serial number to be destroyed is aggregated to a parent container, the system returns an error. Defaults to false.
        Items [0...1]
[–]		 - Required. The list of one or more serial numbers to be destroyed.
          Item [1...*]
[–]		 - Required. The serial number to be destroyed.
            @sn [1...1]
[1/*]		 String Required. A serial number that will be destroyed. See Serial Number Data Examples. *160
            @namespace [0...1]
[1/*]		 String Not supported by TraceLink.
        Sampled [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled. *161
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Damaged [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was damaged. *162
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Recalled [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was recalled. *163
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Expired [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is expired. *164
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Misplaced [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was misplaced. *165
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Dispensed [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was dispensed. *166
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Disposed [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was disposed. *167
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Repackaged [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is repackaged. *168
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledByAuthorities [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled by authorities. *169
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Stolen [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is stolen. *170
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Withdrawn [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is withdrawn. *171
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledArchival [0...1]
[1/*]		 Boolean

Item attribute set with Serial Number State and Item State indicating the item was sampled for archival purposes.

One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledCustomsControl [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for customs inspection.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledFederalInspection [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for federal inspection.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledClinicalStudy [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for performing clinical studies.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledPharmaStudy [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for post-registration pharmaceutical study supporting submitted changes to a dossier.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledMarketingDemo [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was sampled for marketing demonstration purposes.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        SampledSelectiveControl [0...1]
[1/*]		 Boolean

Item attribute set with Serial Number State and Item State indicating the item was sampled for selective control.

One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Spoilage [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is spoiled (e.g. due to heat, oxygen, moisture, microorganisms).
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        WithdrawnExperiment [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is withdrawn from circulation of SSCC or SGTIN, piled or accumulated in the course of the experiment.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Defective [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item is defective.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        InappropriatelyStored [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was inappropriately stored.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Returned [0...
1][1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was returned.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        Other [0...1]
[1/*]		 Boolean Item attribute set with Serial Number State and Item State indicating the item was destroyed for other reasons.
One, and only one, of the following reason code elements may be set to true:
  • Sampled
  • Damaged
  • Recalled
  • Expired
  • Misplaced
  • Dispensed
  • Disposed
  • Repackaged
  • SampledArchival
  • SampledByAuthorities
  • Stolen
  • Withdrawn
  • SampledCustomsControl
  • SampledFederalInspection
  • SampledClinicalStudy
  • SampledPharmaStudy
  • SampledMarketingDemo
  • SampledSelectiveControl
  • Spoilage
  • WithdrawnExperiment
  • Defective
  • InappropriatelyStored
  • Returned
  • Other
        ReasonCode [0...1]
[–]		 String A code that indicates the reason for the change in serial number status. *172
This is an optional field. If not specified, defaults to STATUSUPDATE.

See the ReasonCode enumeration list for valid values.
        EventDateTime [0...1]
[–]		 Date The date and time of the event in XSD GMT date format (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system will record the current date-time. *173
        Transactions [0...1]
[–]		 -

Required. The transaction identifiers associated with the destruction.

          Transaction [0...*]
[1/*]		 String Required. The list of one or more transaction identifiers associated with the destruction.
            ItemID [0...1]
[1/*]		 String Required. The transaction identifier associated with the destruction. *174
For Turkey and China, provide the destruction order number.
            ItemType [0...1]
[1/*]		 String Required. The transaction identifier type using the supported enumeration values (e.g. DESTRUCTION).  *175

See the TransactionId enumeration list for valid values.
            Date [0...1]
[1/*]		 String Required. The date of the transaction in XML YYYY-MM-DD format. This value is used for regulatory reporting of the transaction date. *176
        ReasonDescription [0...1]
[1/*]		 String Conditionally required for Turkey, where the description must be in Turkish and not exceed 100 characters. The reason for the destruction. *177
        DestructionMethod [0...1]
[1/*]		 String Required. The method of product destruction. *178

See the DestructionMethod enumeration list for valid values.
        LongRunningRestSupport [-]
[-]		 Boolean Not used.
        ReportingPartyIdentifier [0...1]
[1/*]		 String Required. The identifier of the business party that will be reporting the event to the government. *179
          @identifiertype [0...1]
[1/*]		 String Required. The reporting business party identifier type. *180

See the IdentifierType enumeration list for valid values.
          @identifiervalue [0...1]
[1/*]		 String The identifier value of the reporting business party. *181
        MarketCountryCode [0...1]
[2/3]		 String The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *182
        LocationType [0...1]
[1/*]		 String

The type of location where the event occurred. See the LocationId enumeration list for valid values.
        Location [0...1]
[1/*]		 String Required. The site-level location identifier where the event occurred. This element defaults to the company level if no location is provided. *183
In most cases, this value is an SGLN, the format for which must be the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:tracelink:soap">	
    <soapenv:Header/>	
    <soapenv:Body>	
        <urn:Destroy>	
            <DestroyRequest>
                <DisaggregateFromParent>true</DisaggregateFromParent>			
                <Items>	
                    <Item sn="88102321100002083327"/>	
                </Items>	
                <Sampled>false</Sampled>
                <Damaged>false</Damaged>
                <Recalled>false</Recalled>
                <Expired>false</Expired>
                <MarketReleased>false</MarketReleased>
                <Misplaced>true</Misplaced>
                <Dispensed>false</Dispensed>
                <Disposed>false</Disposed>
                <Repackaged>false</Repackaged>
                <SampledByAuthorities>false</SampledByAuthorities>
                <Stolen>false</Stolen>
                <Withdrawn>false</Withdrawn>
                <SampledArchival>false</SampledArchival>
                <SampledCustomsControl>false</SampledCustomsControl>
                <SampledFederalInspection>false</SampledFederalInspection>
                <SampledClinicalStudy>false</SampledClinicalStudy>
                <SampledPharmaStudy>false</SampledPharmaStudy>
                <SampledMarketingDemo>false</SampledMarketingDemo>
                <SampledSelectiveControl>false</SampledSelectiveControl>
                <Spoilage>false</Spoilage>
                <WithdrawnExperiment>false</WithdrawnExperiment>
                <Defective>false</Defective>
                <InappropriatelyStored>false</InappropriatelyStored>
                <Returned>false</Returned>
                <Other>false</Other>
                <ReasonCode>STATUSUPDATE</ReasonCode>	
                <EventDateTime>2015-07-28T22:15:00Z</EventDateTime>	
                <Transactions>	
                    <Transaction>	
                        <ItemID>10025241</ItemID>	
                        <ItemType>DESTRUCTION</ItemType>	
                        <Date>2015-07-28</Date>	
                    </Transaction>	
                </Transactions>	
                <ReasonDescription>Unable to locate case in the warehouse</ReasonDescription>	
                <MarketCountryCode>CN</MarketCountryCode>
		<LocationType>SGLN<LocationType>
                <Location>8888882.02867.0</Location>	
            </DestroyRequest>	
        </urn:Destroy>	
    </soapenv:Body>	
</soapenv:Envelope>

Errors

Exception Code Exception Message
BADAGGREGATESTATE Operation could not be performed because serial number <serial number> and serial number <parent serial number> are currently in different states, or the operation would result in them having different states. Parent and child serial numbers are not permitted to be in different states.
CANNOTBEAGGREGATED Operation could not be performed because serial number <serial number> is aggregated to container <parent serial number>.
CROSSLOCATIONS Operation cannot be performed against serial numbers in multiple locations.
EVENTTIMEAFTERNOW Event time stamp must not be in the future.
EVENTTIMEBEFORELASTEVENT Event time stamp is earlier than the last event for serial number <serial number>.
MLTUPLE_ATTRIBUTES_DECOMMISSION The serial number(s) could not be decommissioned. The Decommission API request may only specify a single reason code.
NEVERCOMMISSIONED Serial number <serial number> was never commissioned.
NOSOMSERVICE No Serialized Operations Manager service found.
NOTCOMMISSIONED Serial number <serial number> is not commissioned.
NOTCOMMISSIONEDLOCATION Serial Number <serial number> was not commissioned at this location.
NOTVALIDLOCATION Location <location identifier> was not valid for serial number <serial number>.
SNNOTFOUND Serial number  <serial number> does not exist.
SOMDUPLICATESNS The following serial numbers were listed more than once: <serial number>.
VALIDATION Destruction Method is required for products sold in Russia.
Item Attribute is required for products sold in Russia.
Location is required for products sold in Russia.
Reporting Party is required when Transactions are included in the request and products are sold in Russia.
The parameter <field name> is missing or had an invalid value.
Transaction Identifier for 'Removal from Circulation' is required for products sold in Russia.

Guidelines

The following data is included in the message response:

Data Element Occurs
Length		 Type Description
S:Envelope [1...1]
[–]		 - Required. SOAP Envelope root element.
  S:Body [1...1]
[–]		 - Required. SOAP Message Body.
    ns2:DestroyResponse [1...1]
[–]		 - Required. Destroy response message.
      TLResponse [0...1]
[–]		 - Required. TraceLink response.
        Success [0...1]
[–]		 - Required. Indicates if Destroy request processed successfully. *184
        ExceptionReturn [0...1]
[–]		 - Conditionally required if Success = false, otherwise omitted. Contains error information.
          CallException [1...*]
[–]		 - Required. Error details including exception code and error message, if available.
            ExceptionCode [0...1]
[0/*]		 String Required. Error code.
            ExceptionMessage [0...1]
[0/*]		 String Conditionally required if exception message exists. Message that further describes error condition.

Example

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">	
   <S:Body>	
      <ns2:DestroyResponse xmlns:ns2="urn:tracelink:soap" xmlns:ns3="http://tracelink.com/som">	
         <TLResponse>	
            <Success>true</Success>	
         </TLResponse>	
      </ns2:DestroyResponse>	
   </S:Body>	
</S:Envelope>