Commission 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. SOAP Header message. Not used by TraceLink. | |||||||
| soapenv:Body | 1...1 - |
- | Required. SOAP Message Body. | |||||||
| urn:Commission | 1...1 - |
- | Required. Commission message. | |||||||
| CommissionRequest | 0...1 - |
- | Required. Commission request message to commission a set of serial numbers. Commissioned serial numbers can later be recommissioned with new product information if needed. See Decommission for details. | |||||||
| EventDateTime | 0...1 - |
Date | Date and time of the event in XSD date format in GMT (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system will record the current date time.1 | |||||||
| SerialNumberEncodingEnum | 0...1 1/* |
String |
Required. Serial number format.2 See the Encoding enumeration list for valid values. |
|||||||
| PackagingLevel | 0...1 1/* |
String |
Packaging level associated with the serial number.3 See the PackLevel enumeration list for valid values. |
|||||||
| Location | 0...1 1/* |
String | Required. Site level SGLN of the
location where the event occurred. Will default to company-level if no location is provided.
SGLN format will be 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).4 |
|||||||
| MaterialCode | 0...1 1/* |
String | Conditionally required when commissioning an AI(01)+AI(21) or CN_CUR_CODE if CountryDrugCode is not present. Internal Material Number for the product. 5 | |||||||
| ItemCode | 0...1 1/* |
String | Required.Packaging level item code value (e.g. the GTIN-14, CN-ResCode, or GS1 Company Prefix value).6 | |||||||
| ItemCodeType | 0...1 1/* |
String |
Required. Identifies the packaging level item code type. 7 Valid values:
|
|||||||
| FilterValue | 0...1 1/* |
String | Conditionally required if EPCIS event generation is expected. Filter Value associated with AI(01)+AI(21) GTIN or AI(00) SSCC. Use only when Serial Number Manager Templates are not configured. This value is used to convert serial numbers to EPC URI format.8 | |||||||
| CompanyPrefix | 0...1 1/* |
String | Conditionally required if EPCIS event generation is expected. GS1 Company Prefix associated with AI(01)+AI(21) GTIN or AI(00) SSCC. Use only when Serial Number Manager Templates are not configured. This value is used to convert serial numbers to EPC URI format.9 | |||||||
| MarketCountryCode | 0...1 2/3 |
String | The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.10 | |||||||
| CountryDrugCode | 0...1 1/* |
String | Conditionally required when commissioning an AI(01)+AI(21) or CN_CUR_CODE if MaterialCode is not present. Country Drug Code associated with the serial number at time of commissioning.11 | |||||||
| CountryDrugCodeType | 0...1 1/* |
String |
Conditionally required if CountryDrugCode is populated. Country Drug Code type. Either Internal Material Number or Country Drug Code is required when commissioning an AI(01)+AI(21) or CN_CUR_CODE number.12 See the CountryDrugCode enumeration list for valid values. |
|||||||
| LotNumber | 0...1 1/* |
String | Conditionally required when commissioning an AI(01)+AI(21) or CN_CUR_CODE number. Lot Number associated with the serial number at time of commissioning. 13 | |||||||
| ExpirationDate | 0...1 10/10 |
Date | Conditionally required when commissioning an AI(01)+AI(21) or CN_CUR_CODE number. Expiration Date associated with serial number at time of commissioning. Date is in xsd, date format: YYYY-MM-DD.14 | |||||||
| ManufacturingDate | 0...1 10/10 |
Date | Manufacturing date associated with serial number at time of commissioning. In XSD date format YYYY-MM-DD.15 | |||||||
| BarcodeContent | 0...1 1/* |
String | Actual barcode content associated with serial number in commissioning event.16 | |||||||
| ItemState | 0...1 1/* |
String |
Business process state of the
physical item associated with the serial number. If omitted, ItemState is set to See the ItemState enumeration list for valid values. |
|||||||
| LongRunningRestSupport | - - |
Boolean | Not used. | |||||||
| Items | 1...1 - |
- | Required. List of one or more serial numbers that will be commissioned. | |||||||
| Item | 1...* - |
- | Required. Serial Number to commission. | |||||||
| @sn | 1...1 1/* |
String | Required. Serial number. See Serial Number Data Examples.18 | |||||||
| @namespace | 0...1 1/* |
String | Not supported by TraceLink. See Serial Number Data Examples. | |||||||