Market Release 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 - |
- | Required. Not used. | ||||||
| soapenv:Body | 1...1 - |
- | Required. SOAP message body. | ||||||
| urn:MarketRelease | 1...1 - |
- | Required. Queries the status of the specified lot. | ||||||
| PackagingCode | 0...1 1/* |
String | Conditionally required if both InternalMaterialCode and CountryDrugCode are empty or null. Packaging level item code.1 | ||||||
| PackagingType | 0...1 1/* |
String | Conditionally required if PackagingCode is present. Identifies the packaging level item code type.2 See the PackagingItemCodeType enumeration list for valid values. |
||||||
| InternalMaterialCode | 0...1 1/* |
String | Conditionally required if both PackagingCodeand CountryDrugCode are empty or null. Identifies the product using the internal item code configured in Product Master Data.3 | ||||||
| CountryDrugCode | 0...1 1/* |
String |
Conditionally required if both PackagingCodeand InternalMaterialCode are empty or null. Country drug code associated with the specified lot.4 |
||||||
| CountryDrugCodeType | 0...1 1/* |
String | Conditionally required if CountryDrugCode is present. Country drug code type.5 See the CountryDrugCode enumeration list for valid values. |
||||||
| Lot | 1...1 1/* |
String | Required. Lot number for the market release.6 | ||||||
| Items | 0...1 - |
- | List of one or more serial numbers to release. Use for only a partial lot market release. | ||||||
| Item | 1...* - |
- | Required. The serial number to release into circulation. | ||||||
| @sn | 1...1 1/* |
String |
Required. Serial number in one of the following formats: AI(01)+AI(21)
AI(00)
CN_CUR_CODE
|
||||||
| TargetMarketCountryCode | 1...1 1/* |
String | Required. The two character ISO country code for the market country.7 See the ISOCountryCode enumeration list for valid values. |
||||||
| EventDateTime | 0...1 - |
Date | Date and time of the market release, in GMT YYYY-MM-DDTHH:MM:SSZ format.8 If omitted, TraceLink uses the current date and time. |
||||||
| EventLocation | 0...1 1/* |
String | Site level location where the event occurs. Defaults to company level SGLN. SGLN format is 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).9 | ||||||
| @identifierType | 1...1 1/* |
String | Required. The event location identifier type.10 See the BusinessAndLocationId enumeration list for valid values. |
||||||
| @identifierValue | 1...1 1/* |
String | Required. The event location value. | ||||||
| Transactions | 0...1 - |
- | List of one or more transaction identifiers. | ||||||
| Transaction | 1...* - |
- | Required. The transaction identifier associated with the market release. | ||||||
| ItemID | 0...1 1/* |
String | Required. The transaction identifier associated with the status update, for regulatory reporting and business tracking purposes.11 | ||||||
| ItemType | 0...1 1/* |
String | Required. The transaction identifier type.12 Valid values:
|
||||||
| Date | 0...1 1/* |
String | The date of the transaction in YYYY-MM-DD format.13 | ||||||
| ProductionQuantities | 0...1 - |
- | Group of ProductionQuantity values for each packaging level in the hierarchy. Use to optionally validate serial number quantities. | ||||||
| ProductionQuantity | 0...* - |
- | List of each aggregation hierarchy level. | ||||||
| ItemType | 0...1 - |
- | Conditionally required if CompanyPrefix is empty or null. Identifies the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. | ||||||
| ItemCodeType | 1...1 1/* |
String |
Required. Packaging item code type.14 Valid values:
|
||||||
| ItemCode | 1...1 1/* |
String | Required. Packaging level item code value.15 | ||||||
| CompanyPrefix | 0...1 0/* |
String |
Conditionally required if PackagingItemCode is empty or null. GS1 company prefix.16 |
||||||
| PackagingLevel | 1...1 1/* |
String | Required. The packaging level of the commissioned item.17 See the PackLevel enumeration list for valid values. |
||||||
| QuantityReported | 1...1 1/* |
Integer | Required. Quantity report for the released product.18 | ||||||