Decommission Request Guidelines

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

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. *1
					@namespace		[0...1] [1/*]	String	Not supported by TraceLink. See Serial Number Data Examples.
				Sampled			[0...1] [1/*]	Boolean	Item attribute set with SerialNumberState and ItemState, indicating the item was sampled. 2 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 SerialNumberState and ItemState, indicating the item is damaged. 3 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 SerialNumberState and ItemState, indicating the item was recalled. 4 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 SerialNumberState and ItemState, indicating the item is expired. 5 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 SerialNumberState and ItemState, indicating the item was misplaced. 6 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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 SerialNumberState and ItemState, 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. *7 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. *8
				Transactions			[0...1] [-]		Conditionally required for China (only if providing China the DestroyWarehouseOut report), Turkey, or Russia. 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. *9
						ItemType	[0...1] [1/*]	String	Required. The transaction identifier type using the supported enumeration values (e.g. `DESTRUCTION`). *10 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. *11
				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. *12
				DestructionMethod			[0...1] [1/*]	String	Conditionally required if at least one Target Market in Product Master Data = `RU`. The method of product destruction. *13 See the DestructionMethod enumeration list for valid values.
				LongRunningRestSupport			[-] [-]	Boolean	Not used.
				ReportingPartyIdentifier			[0...1] [-]	-	Conditionally required if `Transactions` is populated and at least one Target Market in Product Master Data = `RU`.The identifier of the business party that will be reporting the event to the government. *14
					@identifiertype		[0...1] [1/*]	String	Required. Indicates the reporting business party identifier type. *15 See the IdentifierType enumeration list for valid values.
					@identifiervalue		[0...1] [1/*]	String	Required. Indicates the identifier value of the reporting business party. *16
				MarketCountryCode			[0...1] [2/3]	String	The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *17
				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	Conditionally required if at least one Target Market in Product Master Data = `RU`. The site-level location identifier where the event occurred. This element defaults to the company level if no location is provided. *18 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).