Get Serialized Hierarchy Request Guidelines
See How To Use this Guide before interpreting the guidelines below.
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:GetSerializedNumberHierarchy | 1...1 – |
– | Required. Queries for a serial number to determine its states, attributes, parent, and children. | |||||||||
| SerialNumberHierarchyQueryRequest | 0...1 – |
– |
Required. Querying a ContainerSerialNumber yields a hierarchy containing all child serial numbers for the given container number. If a serial number is given, no other parameters will be used for the query. The following combinations of fields will retrieve the aggregation hierarchy:
 This request will only return up to 100,000 serial numbers. |
|||||||||
| ContainerSerialNumber | 1...1 1/* |
String | Serial number of a pallet or case for which the full sub-aggregations will be retrieved down to the each.1 If included, only the value of ContainerSerialNumber is used to retrieve the hierarchy, and all other parameters are ignored. |
|||||||||
| DeliveryNumber | 0...1 1/* |
String | Delivery for an outbound shipment.
If omitted, LotNumber must be included along with one of the following product identifiers:2
|
|||||||||
| SenderInfo | 0...1 - |
- | Conditionally required if the same DeliveryNumber is used for multiple shipments. Captures information about the business entity and location that is sending the shipment. | |||||||||
| FromBusinessPartyInfo | 0...1 - |
- | Captures the identifiers associated with the business entity that is sending the shipment. | |||||||||
| BusinessId | 0...* - |
- | Captures the identifiers associated with the business entity that is sending the shipment. | |||||||||
| @type | 1...1 1/* |
String |
Conditionally required if the same BusinessId is present. Captures the sold from business identifier value. See the BusinessAndLocationId enumeration list for valid values. |
|||||||||
| ShipFromLocationInfo | 0...1 - |
- | Captures the identifiers associated with the location that is sending the shipment. | |||||||||
| FacilityId | 0...* - |
- | Indicates the identifiers associated with the business location that is sending the shipment. | |||||||||
| @type | 1...1 1/* |
String |
Conditionally required if the FacilityId is present. Indicates the ship from location identifier value. See the BusinessAndLocationId enumeration list for valid values. |
|||||||||
| PackagingCode | 0...1 – |
String | Conditionally required with LotNumber or with LotNumber and DeliveryNumber if CountryDrugCode and InternalMaterialNumber are not provided. Packaging level item code and type. If packaging level item code is included, both the type and value must be specified. | |||||||||
| ItemCodeType | 0...1 1/* |
String | Required. Identifies the packaging level
item code type. Valid values:
|
|||||||||
| ItemCode | 0...1 1/* |
String | Required. Packaging level item code value (e.g. the GTIN-14 or GS1 Company Prefix value). | |||||||||
| CountryDrugCodeType | 0...1 1/* |
String | Conditionally required if CountryDrugCode is populated. 3 See the CountryDrugCode enumeration list for valid values. |
|||||||||
| CountryDrugCode | 0...1 1/* |
String | Conditionally required with either LotNumber or with LotNumber and DeliveryNumber if PackagingCode and InternalMaterialNumber are not provided. Country Drug Code associated with the serial number being queried. 4 | |||||||||
| InternalMaterialNumber | 0...1 1/* |
String |
Conditionally required with either LotNumber or with LotNumber and DeliveryNumber if PackagingCode and CountryDrugCode are not provided. Use to identify the product using the internal material number configured in Product Master Data. 5 |
|||||||||
| LotNumber | 0...1 1/* |
String | Conditionally required with CountryDrugCode, InternalMaterialNumber, or PackagingCode if DeliveryNumber is not provided. Lot number of the associated serial number being queried.6 | |||||||||
| SerialNumberFormat | 1...* 1/* |
String | Required. Serial number format returned from this API. PC_URI and TAG_URI formats are only possible if complete master data was provided to support serial number translation. See the SNFormat enumeration list for valid values. |
|||||||||
| asynchronousMode | 0...1 1/* |
String | If requesting the status of a lot containing more than 100,000 serial numbers, it is recommended to send the message asynchronously. A RequestId token returns in the Get Serialized Hierarchy response. Use the RequestId value in the Fetch Lot Status Result Request message to retrieve the full lot status when available. Valid values:7
|
|||||||||
