Aggregation Update 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.

The MDLP Bulk API currently has a limit of 20 events per message.

The following data is sent in the request to TraceLink:

Elements									Occurs Length	Type	Notes
soapenv:Envelope									[1...1] [-]	-	Required. The SOAP envelope root element.
	soapenv:Header								[1...1] [-]	-	Required. Not used. The SOAP message header.
	soapenv:Body								[1...1] [-]	-	Required. The SOAP message body.
		urn:AggregateUpdate							[1...1] [-]	-	Required. Aggregation Update message.
			AggregationUpdateRequest						[0...1] [-]	-	Required. Aggregate request to associate child serial numbers to a parent container.
				Aggregations					[0...*] [-]	-	Aggregation group element.
					Aggregation				[0...*] [-]	-	Required. Aggregation event. See the Aggregation \| Strict element for important configuration information.
						Container			[1...1] [-]	-	Required. Parent container serial information. If the Aggregation \| Container is specified, all items must currently be a child of the specified container.
							@sn		[1...1] [1/*]	String	Required. Parent container's serial number. *1
							@namespace		[0...1] [0/*]	String	Not used.
						Items			[1...1] [-]	-	Required. Child serial information.
							Item		[1...*] [-]	-	Required. List of one or more child serial numbers to aggregate to parent container's serial number.
								@sn	[1...1] [1/*]	String	Required. Child serial number in one of the following formats: AI(01)+AI(21) formatted numbers are: 01 + [GTIN14] + 21 + [serial number] Ex: `015088202503022521100000090109` AI(00) formatted numbers are: 00 + [SSCC18 code] Ex: `00008820200000047506` CN_CUR_CODE formatted serial numbers are: 20 digit China EDMC code Ex: `81530070000022519351`
								@namespace	[0...1] [1/*]	String	Not used.
						EventDateTime			[0...1] [-]	Date	Timestamp of the date and time of the aggregation event with the UTC time zone indicator in YYYY-MM-DDThh:mm:ss.sZ format. If omitted, the system will record the current date and time. *2
						Location			[0...1] [1/*]	String	Site-level SGLN of the location where the event occurred. The SGLN format is the numeric component only, with urn prefix stripped (e.g. `8888882.02867.0` instead of `urn:epc:id:sgln:8888882.02867.0` typically found in EPCIS events). *3
						Strict			[1...1] [-]	Boolean	Required. Flag that determines if the system performs an implicit disaggregation and then aggregates the items. Valid values: If `true`, the aggregated item(s) must not already have a parent. If they do, an error will be returned. If `false`, the items are re-associated to the new parent and the items' previous aggregations are adjusted.
						ResetAggregation			[0...1] [-]	Boolean	Flag indicating to disaggregate all existing items in a container and aggregate the new set of items into that container. Valid values: If `true`, TraceLink disaggregates all existing items in the specified container and aggregates the new set of items into that container. If `false` (default), TraceLink does not disaggregate all existing items in the specified container.
						ParentCompanyPrefix			[0...1] [-]	String	Conditionally required if the container serial number is unknown to TraceLink and must be commissioned. The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
						ParentFilterValue			[0...1] [-]	String	The filter value used in GTIN-14 and SSCC serial numbers.
						ParentFormat			[0...1] [-]	String	Conditionally required if the container serial number is unknown to TraceLink and must be commissioned. The format of the parent serial numbers. Valid values: `AI(01)+AI(21)` `AI(00)` `CN_CUR_CODE`
						ParentPackagingLevel			[0...1] [0/*]	String	The packaging level of the commissioned item using the supported enumeration values. *4 See the PackLevel enumeration list for valid values.
				Disaggregations					[0...*] [-]	-	Disaggregation group header.
					Disaggregation				[1...*] [-]	-	Required. Disaggregation event.
						Container			[0...*] [-]	-	Conditionally required if Disaggregation \| Strict is set to `true`. Parent container serial number. If Disaggregation \| Container is specified, all items must currently be a child of the specified container. If omitted, Disaggregation \| Strict must be set to `false`.
							@sn		[1...1] [1/*]	String	Required. Parent serial number. *5
							@namespace		[0...1] [1/*]	String	Not used.
						Items			[1...1] [-]	-	Required. Child serial numbers.
							Item		[1...*] [-]	-	Required. List of one or more child serial numbers to disaggregate from the parent container serial number.
								@sn	[1...1] [1/*]	String	Required. Child serial number in one of the following formats: AI(01)+AI(21) formatted numbers are: 01 + [GTIN14] + 21 + [serial number] Ex: `015088202503022521100000090109` AI(00) formatted numbers are: 00 + [SSCC18 code] Ex: `00008820200000047506` CN_CUR_CODE formatted serial numbers are: 20 digit China EDMC code Ex: `81530070000022519351`
								@namespace	[0...1] [1/*]	String	Not used.
						EventDateTime			[0...1] [-]	Date	Required. Timestamp of the date and time of the disaggregation event with the UTC time zone indicator in YYYY-MM-DDThh:mm:ss.sZ format. If omitted, the system will record the current date and time. *6
						Location			[0...1] [1/*]	String	Required. Site-level SGLN of the location where the event occurred. SGLN format is the numeric component only, with urn prefix stripped (e.g. `8888882.02867.0` instead of `urn:epc:id:sgln:8888882.02867.0` typically found in EPCIS events). *7
						Strict			[1...1] [-]	Boolean	Flag that determines whether Disaggregation \| Container must be provided. If `true`, the parent container must be specified. If `false`, the parent container is not specified and the child serial numbers are implicitly disaggregated from their parent containers.