Customs clearance APIs
Why do I use these messages?
Use these messages to record that a customs agency has approved items for import to Russia and provide supporting documentation.
Which report do these messages generate?
These messages generate the 335 - FTS Data report in the Russia Compliance application if their contents meet the report conditions.
Country Clearance (XML)

Message Type: SOM_COUNTRY_CLEARANCE
Info Exchange Display Name: Country Clearance

Data Element | Occurs Length |
Type | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
som:SOMCountryClearanceMessage | - |
1...1- | Required. Transaction root element. | ||||||
som:ControlFileHeader | - |
1...1- | Required. The message document's header information. | ||||||
cmn:FileSenderNumber | 1/20 |
1...1String | Required. The company identifier of the file’s sender.1 | ||||||
cmn:FileReceiverNumber | 1/20 |
1...1String | Required. The company identifier of the file’s recipient.2 | ||||||
cmn:FileControlNumber | 1/* |
1...1String | Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages.3 | ||||||
cmn:FileDate | 1/* |
1...1Date | Required. The date that the message is sent in YYYY-MM-DD format. Date and times must be in GMT.4 | ||||||
cmn:FileTime | 1/* |
1...1Time | Required.Time file generated in XML in HH:MM:SSZ format. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z .5 |
||||||
som:MessageBody | - |
1...1- | Required. Country Clearance message details. | ||||||
cmn:EventDateTime | 0/* |
1...1DateTime | Required. Timestamp of date and time of the product release with the UTC time zone indicator in XML YYYY-MM-DDTHH:MM:SS.nnZ format. | ||||||
cmn:EventTimeZoneOffset | 6/6 |
0…1String | Event time zone offset. Default value is +00:00 if the source is not populated. | ||||||
cmn:ClearanceType | 0/* |
1...1String | Required. Identifies the clearance type.6 See the ClearanceType enumeration list for valid values. |
||||||
cmn:ImportFromCountry | 1/* |
1...1String | Required. Country the product is being imported from using the standard two-letter abbreviation
specified in ISO 3166-1 alpha-2:1997 country code.7 See the ISOCountryCode enumeration list for valid values. |
||||||
cmn:ImportToCountry | 1/* |
1...1String | Required. Country the product is being imported into using the standard two-letter abbreviation
specified in ISO 3166-1 alpha-2:1997 country code.8 See the ISOCountryCode enumeration list for valid values. |
||||||
cmn:RegistrationDate | 0/* |
0…1Date | Conditionally required if cmn:ClearanceType = CUSTOMS . Registration date in YYYY-MM-DD XML date
format.9 |
||||||
cmn:CustomsAuthorityCode | 0/* |
0…1String | Conditionally required if cmn:ClearanceType = CUSTOMS . Customs authority code.10 |
||||||
cmn:DeclarationReleaseNumber | 0/* |
0…1String | Conditionally required if cmn:ClearanceType = CUSTOMS . Declaration release number for
product.11 |
||||||
cmn:ActionCode | 0/* |
0…1String | Conditionally required if cmn:ClearanceType = CUSTOMS . Action code.12See the ActionCode enumeration list for valid values. |
||||||
cmn:EventLocation | 0/* |
0…1String | Required. Business or location identifier for the entity that is importing the products. | ||||||
cmn:EventLocationType | 0/* |
0…1String | Required. Business or location identifier type for the entity that is importing the products. See the BusinessAndLocationId enumeration list for valid values. |
||||||
cmn:ImportingPartyId | 1/* |
1...1String | Required. Importing party identifier.13 | ||||||
@type | - |
1...1String | Required. Importing party identifier type.14 See the BusinessAndLocationId enumeration list for valid values. |
||||||
cmn:ItemList | - |
0…1- | Conditionally required if both cmn:HomogeneousContainersList and cmn:HeterogeneousContainersList are not populated. List of items. Each item is a single product of loose items (e.g. sampled serial numbers). | ||||||
cmn:Items | - |
1…*- | Required. Products that are being imported. One item will be present for each unique product. | ||||||
cmn:NumberList | - |
1...1- | Required. Contains the list of serial numbers of eaches. | ||||||
cmn:Serial | 1/* |
1…*String | Required. The serial number being imported. Serial number is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01) (21) formatted serial number for GTINs.15 | ||||||
cmn:CustomsValue | - |
0…1Decimal | Conditionally required if cmn:ClearanceType = CUSTOMS . Per unit customs cost for each
order item in order item list.16 |
||||||
@currencyCode | 3/3 |
1...1String | Required. Currency ISO code using ISO 4217-2015 format.17 | ||||||
cmn:TransactionIdentifier | 0/* |
0…*String | The transaction identifier associated with the country clearance.18 | ||||||
@type | 1/* |
1...1String | Required. The transaction identifier type.19 See the ClearanceTransactionId enumeration list for valid values. |
||||||
@date | - |
1...1Date | Required. Transaction date attribute in YYYY-MM-DD format.20 | ||||||
cmn:HomogeneousContainersList | - |
0…1- | Conditionally required if both cmn:HomogeneousContainersList and cmn:HeterogeneousContainersList are not populated. List of homogeneous containers. Each container represents one or more batches of the same product. | ||||||
cmn:HomogeneousContainer | - |
1…*- | Required. Cases or pallets containing the same product. | ||||||
cmn:NumberList | - |
1...1- | Required. Contains the list of serial numbers of eaches. | ||||||
cmn:Serial | 1/* |
1…*String | Required. Contains the serial number or numbers that are being imported. Serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI(01)(21) formatted serial number for GTINs.21 | ||||||
cmn:CustomsValue | 0/* |
0…1Decimal | Conditionally required if cmn:ClearanceType = CUSTOMS . Per unit customs cost for each
order item in order item list.22![]() |
||||||
@currencyCode | 3/3 |
1...1String | Required. Currency ISO code using ISO 4217-2015 format.23 | ||||||
cmn:TransactionIdentifier | 0/* |
0…*String | The transaction identifier associated with the country clearance.24 | ||||||
@type | 1/* |
1...1String | Required. The transaction identifier type.25 See the ClearanceTransactionId enumeration list for valid values. |
||||||
@date | - |
1...1Date | Required. Transaction date attribute.26 | ||||||
cmn:HeterogeneousContainersList | - |
0…1- | Conditionally required if both cmn:ItemList and cmn:HomogeneousContainersList are not populated. List of heterogeneous containers. Each container is a case or pallet with different products inside. | ||||||
cmn:HeterogeneousContainer | - |
1…*- | Required. Case or pallet containing a mix of different products. | ||||||
cmn:Serial | 1/* |
1...1String | Required. Contains the serial number or numbers that are being imported. Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs.27 | ||||||
cmn:ContainerContents | - |
1…*- | Required. Contents of heterogeneous containers. | ||||||
cmn:PackagingItemCode | 1/* |
1...1String | Required. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that are being imported.28 | ||||||
@type | 1/* |
1...1String | Required. The product code type for the
packaging item code.29 See the ItemCode enumeration list for valid values. |
||||||
cmn:LotNumber | 1/* |
1...1String | Required. The lot number associated with the specified serial numbers used to identify the serial numbers that are being updated.30 | ||||||
cmn:CustomsValue | 0/* |
0…1Decimal | Conditionally required if cmn:ClearanceType = CUSTOMS . Per unit customs cost for each
order item in order item list.31 |
||||||
@currencyCode | 3/3 |
1...1String | Required. Currency ISO code using ISO 4217-2015 format.32 | ||||||
cmn:TransactionIdentifier | 0/* |
0…*String | The transaction identifier(s) associated with the country clearance, if available.33 | ||||||
@type | 1/* |
1...1String | Required. The transaction identifier type.34 See the ClearanceTransactionId enumeration list for valid values. |
||||||
@date | - |
1...1Date | Required. Transaction date attribute.35 |

<?xml version="1.0" encoding="UTF-8"?> <som:SOMCountryClearanceMessage xmlns:som="urn:tracelink:mapper:sl:serialized_operations_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes"> <som:ControlFileHeader> <cmn:FileSenderNumber>8888882028644</cmn:FileSenderNumber> <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber> <cmn:FileControlNumber>20130821065245</cmn:FileControlNumber> <cmn:FileDate>19-09-20</cmn:FileDate> <cmn:FileTime>06:52:45.02</cmn:FileTime> </som:ControlFileHeader> <som:MessageBody> <cmn:EventDateTime>2019-09-20T06:30:32.12</cmn:EventDateTime> <cmn:EventTimeZoneOffset>+04:02</cmn:EventTimeZoneOffset> <cmn:ClearanceType>CUSTOMS</cmn:ClearanceType> <cmn:ImportFromCountry>FR</cmn:ImportFromCountry> <cmn:ImportToCountry>RU</cmn:ImportToCountry> <cmn:RegistrationDate>2019-09-20</cmn:RegistrationDate> <cmn:CustomsAuthorityCode>201960876</cmn:CustomsAuthorityCode> <cmn:DeclarationReleaseNumber>198765</cmn:DeclarationReleaseNumber> <cmn:ActionCode>REEXPORT</cmn:ActionCode> <cmn:EventLocation>0333331013655</cmn:EventLocation> <cmn:EventLocationType>GCP</cmn:EventLocationType> <cmn:ImportingPartyId type="GLN">0333331013655</cmn:ImportingPartyId> <cmn:ItemList> <cmn:Items> <cmn:NumberList> <cmn:Serial>015088202501033321100000060001</cmn:Serial> <cmn:Serial>015088202501033321100000060002</cmn:Serial> <cmn:Serial>015088202501033321100000060003</cmn:Serial> <cmn:Serial>015088202501033321100000060004</cmn:Serial> <cmn:Serial>015088202501033321100000060005</cmn:Serial> <cmn:Serial>015088202501033321100000060006</cmn:Serial> <cmn:Serial>015088202501033321100000060007</cmn:Serial> <cmn:Serial>015088202501033321100000060008</cmn:Serial> <cmn:Serial>015088202501033321100000060009</cmn:Serial> </cmn:NumberList> <cmn:CustomsValue currencyCode="RUB">1976.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-01">9876987321</cmn:TransactionIdentifier> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-10-04">7777222</cmn:TransactionIdentifier> </cmn:Items> <cmn:Items> <cmn:NumberList> <cmn:Serial>015088202501033321100000060011</cmn:Serial> <cmn:Serial>015088202501033321100000060012</cmn:Serial> <cmn:Serial>015088202501033321100000060013</cmn:Serial> <cmn:Serial>015088202501033321100000060014</cmn:Serial> <cmn:Serial>015088202501033321100000060015</cmn:Serial> <cmn:Serial>015088202501033321100000060016</cmn:Serial> <cmn:Serial>015088202501033321100000060017</cmn:Serial> <cmn:Serial>015088202501033321100000060018</cmn:Serial> <cmn:Serial>015088202501033321100000060019</cmn:Serial> </cmn:NumberList> <cmn:CustomsValue currencyCode="RUX">1976.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">9876987321</cmn:TransactionIdentifier> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-10-21">7777222</cmn:TransactionIdentifier> </cmn:Items> <cmn:Items> <cmn:NumberList> <cmn:Serial>015088202501033321100000060021</cmn:Serial> <cmn:Serial>015088202501033321100000060022</cmn:Serial> </cmn:NumberList> <cmn:CustomsValue currencyCode="USD">2000.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-01-11">9876982222</cmn:TransactionIdentifier> </cmn:Items> </cmn:ItemList> <cmn:HomogeneousContainersList> <cmn:HomogeneousContainer> <cmn:NumberList> <cmn:Serial>015088202501033321100000060010</cmn:Serial> <cmn:Serial>015088202501033321100000060012</cmn:Serial> <cmn:Serial>015088202501033321100000060013</cmn:Serial> <cmn:Serial>015088202501033321100000060014</cmn:Serial> <cmn:Serial>015088202501033321100000060015</cmn:Serial> <cmn:Serial>015088202501033321100000060016</cmn:Serial> <cmn:Serial>015088202501033321100000060017</cmn:Serial> <cmn:Serial>015088202501033321100000060018</cmn:Serial> <cmn:Serial>015088202501033321100000060019</cmn:Serial> </cmn:NumberList> <cmn:CustomsValue currencyCode="RUB">1976.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">9876987322</cmn:TransactionIdentifier> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-11-11">774784</cmn:TransactionIdentifier> </cmn:HomogeneousContainer> <cmn:HomogeneousContainer> <cmn:NumberList> <cmn:Serial>015088202501033321100000060030</cmn:Serial> <cmn:Serial>015088202501033321100000060032</cmn:Serial> <cmn:Serial>015088202501033321100000060033</cmn:Serial> </cmn:NumberList> <cmn:CustomsValue currencyCode="RUB">111</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">9876987322</cmn:TransactionIdentifier> </cmn:HomogeneousContainer> <cmn:HomogeneousContainer> <cmn:NumberList> <cmn:Serial>015088202501033321100000060040</cmn:Serial> <cmn:Serial>015088202501033321100000060042</cmn:Serial> <cmn:Serial>015088202501033321100000060043</cmn:Serial> <cmn:Serial>015088202501033321100000060044</cmn:Serial> </cmn:NumberList> <cmn:CustomsValue currencyCode="USD">5500.76</cmn:CustomsValue> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-11-11">774784</cmn:TransactionIdentifier> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">7322</cmn:TransactionIdentifier> </cmn:HomogeneousContainer> </cmn:HomogeneousContainersList> <cmn:HeterogeneousContainersList> <cmn:HeterogeneousContainer> <cmn:Serial>015088202501033321100000060020</cmn:Serial> <cmn:ContainerContents> <cmn:PackagingItemCode type="GTIN-14">00882025030223</cmn:PackagingItemCode> <cmn:LotNumber>ABC123</cmn:LotNumber> <cmn:CustomsValue currencyCode="RUB">1976.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">9876987323</cmn:TransactionIdentifier> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-12-12">121211</cmn:TransactionIdentifier> </cmn:ContainerContents> <cmn:ContainerContents> <cmn:PackagingItemCode type="CN-RESCODE">999999999</cmn:PackagingItemCode> <cmn:LotNumber>HKHYT45792</cmn:LotNumber> <cmn:CustomsValue currencyCode="RUB">777</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">444987323</cmn:TransactionIdentifier> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-12-12">121211</cmn:TransactionIdentifier> </cmn:ContainerContents> </cmn:HeterogeneousContainer> <cmn:HeterogeneousContainer> <cmn:Serial>015088202501033321100000060021</cmn:Serial> <cmn:ContainerContents> <cmn:PackagingItemCode type="GTIN-14">00882025030223</cmn:PackagingItemCode> <cmn:LotNumber>ABC123</cmn:LotNumber> <cmn:CustomsValue currencyCode="USD">1976.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">9876987323</cmn:TransactionIdentifier> </cmn:ContainerContents> </cmn:HeterogeneousContainer> <cmn:HeterogeneousContainer> <cmn:Serial>015088202501033321100000060022</cmn:Serial> <cmn:ContainerContents> <cmn:PackagingItemCode type="GTIN-14">00882025030223</cmn:PackagingItemCode> <cmn:LotNumber>ABC123</cmn:LotNumber> <cmn:CustomsValue currencyCode="USD">1976.00</cmn:CustomsValue> <cmn:TransactionIdentifier type="DECLARATIONCONFORMITY" date="2019-09-20">9777</cmn:TransactionIdentifier> </cmn:ContainerContents> </cmn:HeterogeneousContainer> <cmn:HeterogeneousContainer> <cmn:Serial>015088202501033321100000060023</cmn:Serial> <cmn:ContainerContents> <cmn:PackagingItemCode type="GTIN-14">00882025030223</cmn:PackagingItemCode> <cmn:LotNumber>ABC123</cmn:LotNumber> <cmn:CustomsValue currencyCode="RUZ">4444</cmn:CustomsValue> <cmn:TransactionIdentifier type="CERTIFICATECONFORMITY" date="2019-09-20">9876987323</cmn:TransactionIdentifier> </cmn:ContainerContents> </cmn:HeterogeneousContainer> </cmn:HeterogeneousContainersList> </som:MessageBody> </som:SOMCountryClearanceMessage>

Data Element | Error Message | Description |
---|---|---|
Class 1 | ||
cmn:ClearanceType | Valid clearance type code is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
cmn:ImportFromCountry | Valid import from country is required !!! | The error occurs if the source is greater than 2 characters, or is empty or null. |
cmn:ImportToCountry | Valid import to country is required !!! | The error occurs if the source is greater than 2 characters, or is empty or null. |
cmn:RegistrationDate | Registration date is required !!! | The error occurs if cmn:ClearanceType = "CUSTOMS", but the source is empty or null. |
cmn:CustomsAuthorityCode | Customs authority code is required !!! | The error occurs if cmn:ClearanceType = "CUSTOMS", but the source is empty or null. |
cmn:DeclarationReleaseNumber | Declaration release number is required !!! | The error occurs if cmn:ClearanceType = "CUSTOMS", but the source is empty or null. |
cmn:ActionCode | Valid action code is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
cmn:EventLocation | Event location in the country clearance event is required !!! | The error occurs if the source is empty or null. |
cmn:EventLocationType | Valid event location type is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
cmn:ImportingPartyId | Importing party identifier is required !!! | The error occurs if the source is empty or null. |
cmn:ImportingPartyId | @type | Valid importing party identifier type is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
cmn:ItemList | At least one of Item List, Homogeneous Containers List, or Heterogeneous Containers List is required !!! | The error occurs if cmn:ItemList, cmn:HomogeneousContainersList, and cmn:HeterogeneousContainersList are all empty or null. |
cmn:Items | cmn:NumberList | cmn:Serial | Serial number is required if itemList is present !!! | The error occurs if the source is empty or null. |
cmn:Items | cmn:CustomsValue | Customs value is required !!! | The error occurs if cmn:ClearanceType = "CUSTOMS", but the source is empty or null. |
cmn:Items | cmn:CustomsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
cmn:Items | cmn:TransactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if cmn:TransactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
cmn:Items | cmn:TransactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
cmn:HomogeneousContainersList | At least one of Item List, Homogeneous Containers List, or Heterogeneous Containers List is required !!! | The error occurs if cmn:ItemList, cmn:HomogeneousContainersList, and cmn:HeterogeneousContainersList are all empty or null. |
cmn:HomogeneousContainer | cmn:NumberList | cmn:Serial | Serial number is required if homogeneousContainersList is present !!! | The error occurs if the source is empty or null. |
cmn:HomogeneousContainer | cmn:CustomsValue | Customs value is required !!! | The error occurs if cmn:ClearanceType = "CUSTOMS", but the source is empty or null. |
cmn:HomogeneousContainer | cmn:CustomsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
cmn:HomogeneousContainer | cmn:TransactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if cmn:TransactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
cmn:HomogeneousContainer | cmn:TransactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
cmn:HeterogeneousContainersList | At least one of Item List, Homogeneous Containers List, or Heterogeneous Containers List is required !!! | The error occurs if cmn:ItemList, cmn:HomogeneousContainersList, and cmn:HeterogeneousContainersList are all empty or null. |
cmn:HeterogeneousContainer | cmn:Serial | Serial number is required if heterogeneousContainersList is present !!! | The error occurs if the source is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:PackagingItemCode | Packaging item code is required !!! | The error occurs if the source is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:PackagingItemCode | @type | Valid packaging item code type required if packagingItemCode is populated !!! | The error occurs if cmn:PackagingItemCode is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:LotNumber | Lot number is required !!! | The error occurs if the source is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:CustomsValue | Customs value is required !!! | The error occurs if cmn:clearanceType = "CUSTOMS", but the source is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:CustomsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:TransactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if cmn:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
cmn:HeterogeneousContainer | cmn:ContainerContents | cmn:TransactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
Class 2 | ||
cmn:Serial | Serial Number <SerialNumber> does not exist. | The error occurs if the serial number does not exist in TraceLink. |
Serial Number <Serial> was never commissioned. | The error occurs if the status of the serial number is not commissioned or registered. | |
Serial Number <Serial> is repeated in the transaction. All serial numbers should appear only once. | The error occurs if a serial number appears multiple times in this message. | |
cmn:Items | cmn:NumberList | cmn:Serial | All serial numbers per row must belong to the same product (GTIN). | The error occurs if loose item serial numbers do not belong to the same product. |
Loose Item Serial Numbers must be in GTIN (01) (21) format. | The error occurs if a loose item serial number is not in GTIN(01)(21) format. | |
Serial Number <Serial> is not disaggregated from parent serial number. | The error occurs if a loose item serial number is aggregated to a parent serial number. | |
Serial Number <Serial> has Packaging Level of <PackagingLevel>. Loose Item serial numbers must have Packaging Level of Each. | The error occurs if a loose item serial number is not at the "each" packaging level. | |
cmn:HomogeneousContainer | cmn:NumberList | cmn:Serial | Serial Numbers for pallets and cases must be in SSCC (00) format. | The error occurs if serial numbers are not in SSCC(00) format. |
Container Serial Number <Serial> contains items that belong to multiple products or lots. This container must be entered as a Mixed Container | The error occurs if the serial number includes different products or lots instead of a single product or lot. | |
cmn:HeterogeneousContainer | cmn:Serial | Serial Numbers for pallets and cases must be in SSCC (00) format. | The error occurs if serial numbers are not in SSCC(00) format. |
cmn:PackagingItemCode | Packaging Code <PackagingCode> does not exist. | The error occurs if the packaging code is not a GTIN. |
cmn:PackagingItemCode, cmn:LotNumber | Container Serial Number <Serial> must include country clearance information for each unique product within the container. The following items are missing from this transaction: <list of packaging code-Lot Number combinations that are missing> | The error occurs if the heterogeneous container contains a Packaging Item Code and Lot Number combination that is not included in the message. |
cmn:PackagingItemCode, cmn:LotNumber | Lot <Packaging Code - Lot Number> in heterogeneous container serial number <serial> cannot appear multiple times in the container | The error occurs if the Packaging Item Code and Lot Number combination is repeated in this message within a single heterogeneous container serial number. |
cmn:PackagingItemCode, cmn:LotNumber | Item <Packaging Code - Lot Number> does not exist in container serial number <Serial> | The error occurs if the Packaging Item Code and Lot Number combination does not exist in the heterogeneous container. |
Class 3 | ||
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered. |
Country Clearance (EPCIS v1.2)

Message Type: SOM_COUNTRY_CLEARANCE
Info Exchange Display Name: Country Clearance

Data Element | Occurs Length |
Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
epcis:EPCISDocument | - |
1…1- | Required. EPCIS message root element. | |||||||||
@schemaVersion | 0/* |
1…1Decimal | Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2 .36 |
|||||||||
@creationDate | 1/* |
1…1DateTime | Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format.37 | |||||||||
EPCISHeader | - |
0…1- | Required. The XML file control header. | |||||||||
sbdh:StandardBusinessDocumentHeader | - |
1…1- | Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification. | |||||||||
sbdh:HeaderVersion | 0/* |
1…1String | Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0 .38 |
|||||||||
sbdh:Sender | - |
1...*- | Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages. | |||||||||
sbdh:Identifier | 1/* |
1…1String | Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type.39 Send SGLN and all other party types with the GS1-conformant uri prefix. For example:
See the MDPartyTypeAttributes enumeration list for valid values. ![]() |
|||||||||
@Authority | 1/* |
1…1String | Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values.40See the MDPartyTypeEnums enumeration list for valid values. |
|||||||||
sbdh:Receiver | - |
1...*- | Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that receives the standard business document. The Receiver element is used only once with GS1 XML messages. | |||||||||
sbdh:Identifier | 1/* |
1…1String | Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type.41 Send SGLN and all other party types with the GS1-conformant uri prefix. For example:
See the MDPartyTypeAttributes enumeration list for valid values. ![]() |
|||||||||
@Authority | 1/* |
1…1String | Required. The receiver identifier type. The Authority was previously expected to be set to "GLN" for GS1 XML messages. An update made in December 2016 changed this to accept additional values.42 See the MDPartyTypeEnums enumeration list for valid values. |
|||||||||
sbdh:DocumentIdentification | - |
1…1- | Required. Contains the identification group for the message. | |||||||||
sbdh:Standard | 0/* |
1…1String | Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal .43 |
|||||||||
sbdh:TypeVersion | 0/* |
1…1String | Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0 .44 |
|||||||||
sbdh:InstanceIdentifier | 1/* |
1…1String | Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others.45 | |||||||||
sbdh:Type | 0/* |
1…1String | Required. The document type. The Type value is set to Events for a commission event.46 |
|||||||||
sbdh:CreationDateAndTime | 0/* |
1…1DateTime | Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z .47 |
|||||||||
EPCISBody | - |
1…1- | Required. Contains all of the EPCIS events for this message. | |||||||||
EventList | - |
1…1- | Required. EventList must include one or more instances of ObjectEvent for country clearance. | |||||||||
ObjectEvent | - |
1...*- | Required.
The ObjectEvent indicates the message type. Indicates a country clearance event when:
|
|||||||||
eventTime | 1/* |
1…1DateTime | Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. The system expects the Z to be appendedif it is not included; however, the system assumes that the time is GMT and therefore appends the Z.48 | |||||||||
eventTimeZoneOffset | 1/* |
1…1String | Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].49 | |||||||||
epcList | - |
1…1- | This element group is not mapped. Send an empty tag (<epcList/>). Serial numbers are mapped from the tl:itemList, tl:homogeneousContainersList, and tl:heterogeneousContainersList element groups in tl:countryClearanceEventExtensions. | |||||||||
action | 0/* |
1…1String | Required. The action type of the event. This value must equal OBSERVE .50 |
|||||||||
bizStep | 0/* |
0…1AnyURI | Required. The business step taken in the event. This value must equal urn:epcglobal:cbv:bizstep:inspecting .51 |
|||||||||
disposition | 0/* |
0…1AnyURI |
Required. The status of the message. This value must equal |
|||||||||
readPoint | - |
0…1- | Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a more granular location identifier. For country clearance, this is the importing party identifier. | |||||||||
id | 0/* |
1…1AnyURI | Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a finer-grain location identifier. For country clearance, this is the importing
party identifier.53 See the MDPartyTypeAttributes enumeration list for valid values. |
|||||||||
tl:countryClearanceEventExtensions | - |
0…1- | Main extension body. | |||||||||
tl:clearanceType | 1/* |
1…1String | Required. Identifies the clearance type.54 See the ClearanceType enumeration list for valid values. |
|||||||||
tl:importFromCountry | 1/* |
1…1String | Required. Country the product is being imported from using the standard two-letter abbreviation
specified in ISO 3166-1 alpha-2:1997 country code.55 See the ISOCountryCode enumeration list for valid values. |
|||||||||
tl:importToCountry | 1/* |
1…1String | Required. Country the product is being imported into using the standard two-letter abbreviation
specified in ISO 3166-1 alpha-2:1997 country code.56 See the ISOCountryCode enumeration list for valid values. |
|||||||||
tl:registrationDate | 0/* |
0…1Date | Conditionally required if tl:clearanceType = CUSTOMS . Registration date in YYYY-MM-DD XML date
format.57 |
|||||||||
tl:customsAuthorityCode | 0/* |
0…1String | Conditionally required for Russia if tl:clearanceType = CUSTOMS . Customs authority code.58 |
|||||||||
tl:declarationReleaseNumber | 0/* |
0…1String | Conditionally required for Russia if tl:clearanceType = CUSTOMS . Declaration release number for
product.59 |
|||||||||
tl:actionCode | 0/* |
0…1String | Conditionally required for Russia if tl:clearanceType = CUSTOMS . Action code.60See the ActionCode enumeration list for valid values. |
|||||||||
tl:importingPartyId | 1/* |
1…1String | Required. Importing party identifier.61 | |||||||||
@type | 1/* |
1…1String | Required. Importing party identifier type.62 See the BusinessAndLocationId enumeration list for valid values. |
|||||||||
tl:itemList | - |
0…1- | Conditionally required if both tl:homogeneousContainersList and tl:heterogeneousContainersList are not populated. List of items. Each item is a single product of loose items (e.g. sampled serial numbers). | |||||||||
tl:items | - |
1...*- | Required. Products that are being imported. One item will be present for each unique product. | |||||||||
tl:numberList | 1/* |
1…1String | Required. Contains the list of serial numbers of eaches. | |||||||||
tl:serial | 1/* |
1...*String | Required. The serial number being imported. Serial number is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs.63 | |||||||||
tl:customsValue | - |
0…1Decimal | Conditionally required if tl:clearanceType = CUSTOMS . Per unit customs cost for each
order item in order item list.64 |
|||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.65 See the ISOCurrency enumeration list for valid values. |
|||||||||
tl:transactionIdentifier | 0/* |
0...*String | The transaction identifier associated with the country clearance.66 | |||||||||
@type | 1/* |
1…1String | Required. The transaction identifier type.67 See the ClearanceTransactionId enumeration list for valid values. |
|||||||||
@date | - |
1…1Date | Required. Transaction date attribute in YYYY-MM-DD format.68 | |||||||||
tl:homogeneousContainersList | - |
0…1- | Conditionally required if both tl:itemList and tl:heterogeneousContainersList are not populated. List of homogeneous containers. Each container represents one or more batches of the same product. | |||||||||
tl:homogeneousContainer | - |
1...*- | Required. Cases or pallets containing the same product. | |||||||||
tl:numberList | 1/* |
1…1String | Required. Contains the list of serial numbers of eaches. | |||||||||
tl:serial | 1/* |
1...*String | Required. Contains the serial number or numbers that are being imported. Serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI(01)(21) formatted serial number for GTINs.69 | |||||||||
tl:customsValue | 0/* |
0…1Decimal | Conditionally required if tl:clearanceType = CUSTOMS . Per unit customs cost for each
order item in order item list.70 |
|||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.71 See the ISOCurrency enumeration list for valid values. |
|||||||||
tl:transactionIdentifier | 0/* |
0...*String | The transaction identifier associated with the country clearance.72 | |||||||||
@type | 1/* |
1…1String | Required. The transaction identifier type.73 See the ClearanceTransactionId enumeration list for valid values. |
|||||||||
@date | - |
1…1Date | Required. Transaction date attribute.74 | |||||||||
tl:heterogeneousContainersList | - |
0…1- | Conditionally required if both tl:itemList and tl:homogeneousContainersList are not populated. List of heterogeneous containers. Each container is a case or pallet with different products inside. | |||||||||
tl:heterogeneousContainer | - |
1...*- | Required. Case or pallet containing a mix of different products. | |||||||||
tl:serial | 1/* |
1…1String | Required. Contains the serial number or numbers that are being imported. Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(00) formatted serial numbers for SSCCs.75 | |||||||||
tl:containerContents | - |
1...*- | Required. Contents of heterogeneous containers. | |||||||||
tl:packagingItemCode | 1/* |
1…1String | Required. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that are being imported.76 | |||||||||
@type | 1/* |
1…1String | Required. The product code type for the
packaging item code.77 See the ItemCode enumeration list for valid values. |
|||||||||
cbvmda:lotNumber | 1/* |
1…1String | Required. The lot number associated with the specified serial numbers used to identify the serial numbers that are being updated.78 | |||||||||
tl:customsValue | 0/* |
0…1Decimal | Required. Per unit customs cost for each order item in order item list.79 | |||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.80 See the ISOCurrency enumeration list for valid values. |
|||||||||
tl:transactionIdentifier | 0/* |
0...*String | The transaction identifier(s) associated with the country clearance, if available.81 | |||||||||
@type | 1/* |
1…1String | Required. The transaction identifier type.82 See the ClearanceTransactionId enumeration list for valid values. |
|||||||||
@date | - |
1…1Date | Required. Transaction date attribute.83 |

<?xml version="1.0" encoding="UTF-8"?> <epcis:EPCISDocument xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:tl="http://epcis.tracelink.com/ns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" schemaVersion="1.2" creationDate="2019-05-15T17:45:20.00Z"> <EPCISHeader> <sbdh:StandardBusinessDocumentHeader> <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion> <sbdh:Sender> <sbdh:Identifier Authority="GLN">0882028677019</sbdh:Identifier> </sbdh:Sender> <sbdh:Receiver> <sbdh:Identifier Authority="GLN">0333331013655</sbdh:Identifier> </sbdh:Receiver> <sbdh:DocumentIdentification> <sbdh:Standard>EPCglobal</sbdh:Standard> <sbdh:TypeVersion>1.0</sbdh:TypeVersion> <sbdh:InstanceIdentifier>201901311745200001</sbdh:InstanceIdentifier> <sbdh:Type>Events</sbdh:Type> <sbdh:CreationDateAndTime>2019-05-15T17:45:20.00Z</sbdh:CreationDateAndTime> </sbdh:DocumentIdentification> </sbdh:StandardBusinessDocumentHeader> </EPCISHeader> <EPCISBody> <EventList> <ObjectEvent> <eventTime>2019-05-15T00:12:23.8307Z</eventTime> <eventTimeZoneOffset>-05:00</eventTimeZoneOffset> <epcList/> <action>OBSERVE</action> <bizStep>urn:epcglobal:cbv:bizstep:inspecting</bizStep> <disposition>http://epcis.tracelink.com/disp/cleared_customs</disposition> <readPoint> <id>urn:epc:id:sgln:7777776.67345.0</id> </readPoint> <tl:countryClearanceEventExtensions> <tl:clearanceType>CUSTOMS</tl:clearanceType> <tl:importFromCountry>FR</tl:importFromCountry> <tl:importToCountry>RU</tl:importToCountry> <tl:registrationDate>2019-07-14</tl:registrationDate> <tl:customsAuthorityCode>201960876</tl:customsAuthorityCode> <tl:declarationReleaseNumber>198765</tl:declarationReleaseNumber> <tl:actionCode>EXPORT</tl:actionCode> <tl:importingPartyId type="BR_CNES">0333331013655</tl:importingPartyId> <tl:itemList> <tl:items> <tl:numberList> <tl:serial>015088202501033321100000060001</tl:serial> <tl:serial>015088202501033321100000060002</tl:serial> <tl:serial>015088202501033321100000060003</tl:serial> <tl:serial>015088202501033321100000060004</tl:serial> <tl:serial>015088202501033321100000060005</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876987321</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875986412</tl:transactionIdentifier> </tl:items> <tl:items> <tl:numberList> <tl:serial>015088202501033321100000060006</tl:serial> <tl:serial>015088202501033321100000060007</tl:serial> <tl:serial>015088202501033321100000060008</tl:serial> <tl:serial>015088202501033321100000060009</tl:serial> <tl:serial>015088202501033321100000060010</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876987322</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875986413</tl:transactionIdentifier> </tl:items> </tl:itemList> <tl:homogeneousContainersList> <tl:homogeneousContainer> <tl:numberList> <tl:serial>015088202501033321100000060011</tl:serial> <tl:serial>015088202501033321100000060012</tl:serial> <tl:serial>015088202501033321100000060013</tl:serial> <tl:serial>015088202501033321100000060014</tl:serial> <tl:serial>015088202501033321100000060015</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876987324</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875986415</tl:transactionIdentifier> </tl:homogeneousContainer> <tl:homogeneousContainer> <tl:numberList> <tl:serial>015088202501033321100000060016</tl:serial> <tl:serial>015088202501033321100000060017</tl:serial> <tl:serial>015088202501033321100000060018</tl:serial> <tl:serial>015088202501033321100000060019</tl:serial> <tl:serial>015088202501033321100000060020</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876987326</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875986417</tl:transactionIdentifier> </tl:homogeneousContainer> </tl:homogeneousContainersList> <tl:heterogeneousContainersList> <tl:heterogeneousContainer> <tl:serial>urn:epc:id:sscc:030944.10105363280</tl:serial> <tl:containerContents> <tl:packagingItemCode type="GTIN-14">00882025030223</tl:packagingItemCode> <cbvmda:lotNumber>ABC123</cbvmda:lotNumber> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876987327</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875986418</tl:transactionIdentifier> </tl:containerContents> </tl:heterogeneousContainer> <tl:heterogeneousContainer> <tl:serial>urn:epc:id:sscc:030944.10105363281</tl:serial> <tl:containerContents> <tl:packagingItemCode type="GTIN-14">00882025030233</tl:packagingItemCode> <cbvmda:lotNumber>ABC456</cbvmda:lotNumber> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876988327</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875987418</tl:transactionIdentifier> </tl:containerContents> </tl:heterogeneousContainer> <tl:heterogeneousContainer> <tl:serial>urn:epc:id:sscc:030944.10105363282</tl:serial> <tl:containerContents> <tl:packagingItemCode type="GTIN-14">00882025030244</tl:packagingItemCode> <cbvmda:lotNumber>ABC789</cbvmda:lotNumber> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-07-12">9876987328</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-07-12">4875986419</tl:transactionIdentifier> </tl:containerContents> </tl:heterogeneousContainer> </tl:heterogeneousContainersList> </tl:countryClearanceEventExtensions> </ObjectEvent> </EventList> </EPCISBody> </epcis:EPCISDocument>

Data Element | Error Message | Description |
---|---|---|
Class 1 | ||
action | Action OBSERVE is required for country clearance event !!! | The error occurs if the source does not equal "OBSERVE". |
bizStep | bizStep urn:epcglobal:cbv:bizstep:inspecting is required for country clearance event !!! | The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:inspecting". |
disposition | Disposition http://epcis.tracelink.com/disp/cleared_customs is required for country clearance event !!! | The error occurs if the source does not equal "http://epcis.tracelink.com/disp/cleared_customs". |
readPoint | Valid readPoint identifier type is required !!! | The error occurs if the source is present, but there is no matching entry in the lookup file. |
Event location in the country clearance event is required !!! | The error occurs if the source is empty or null. | |
tl:clearanceType | Valid clearance type code is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
tl:importFromCountry | Valid import from country is required !!! | The error occurs if the source is not 2 characters, or is empty or null. |
tl:importToCountry | Valid import to country is required !!! | The error occurs if the source is not 2 characters, or is empty or null. |
tl:registrationDate | Registration date is required !!! | The error occurs if tl:clearanceType = "CUSTOMS", but the source is empty or null. |
tl:actionCode | Valid action code is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
tl:importingPartyId | Importing party identifier is required !!! | The error occurs if the source is empty or null. |
tl:importingPartyId | @type | Valid importing party identifier type is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
tl:items | At least one of Item List, Homogeneous Containers List, or Heterogeneous Containers List is required !!! | The error occurs if tl:itemList, tl:homogeneousContainersList, and tl:heterogeneousContainersList are all empty or null. |
tl:items | tl:numberList | tl:serial | Serial number is required if itemList is present !!! | The error occurs if the source is empty or null. |
tl:items | tl:customsValue | Customs value is required !!! | The error occurs if tl:clearanceType = "CUSTOMS", but the source is empty or null. |
tl:items | tl:customsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
tl:items | tl:transactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if tl:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:items | tl:transactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
tl:homogeneousContainer | At least one of Item List, Homogeneous Containers List, or Heterogeneous Containers List is required !!! | The error occurs if tl:itemList, tl:homogeneousContainersList, and tl:heterogeneousContainersList are all empty or null. |
tl:homogeneousContainer | tl:numberList | tl:serial | Serial number is required if homogeneousContainersList is present !!! | The error occurs if the source is empty or null. |
tl:homogeneousContainer | tl:customsValue | Customs value is required !!! | The error occurs if tl:clearanceType = "CUSTOMS", but the source is empty or null. |
tl:homogeneousContainer | tl:customsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
tl:homogeneousContainer | tl:transactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if tl:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:homogeneousContainer | tl:transactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | At least one of Item List, Homogeneous Containers List, or Heterogeneous Containers List is required !!! | The error occurs if tl:itemList, tl:homogeneousContainersList, and tl:heterogeneousContainersList are all empty or null. |
tl:heterogeneousContainer | tl:serial | Serial number is required if heterogeneousContainersList is present !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:packagingItemCode | Packaging item code is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:packagingItemCode | @type | Valid packaging item code type required if packagingItemCode is populated !!! | The error occurs if tl:packagingItemCode is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:heterogeneousContainer | tl:containerContents | cbvmda:lotNumber | Lot number is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:customsValue | Customs value is required !!! | The error occurs if tl:clearanceType = "CUSTOMS", but the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:customsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:transactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if tl:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:transactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
Class 2 | ||
tl:serial | Serial Number <SerialNumber> does not exist. | The error occurs if the serial number does not exist in TraceLink. |
Serial Number <Serial> was never commissioned. | The error occurs if the status of the serial number is not commissioned or registered. | |
Serial Number <Serial> is repeated in the transaction. All serial numbers should appear only once. | The error occurs if a serial number appears multiple times in this message. | |
tl:items | tl:numberList | tl:serial | All serial numbers per row must belong to the same product (GTIN). | The error occurs if loose item serial numbers do not belong to the same product. |
Loose Item Serial Numbers must be in GTIN (01) (21) format. | The error occurs if a loose item serial number is not in GTIN(01)(21) format. | |
Serial Number <Serial> is not disaggregated from parent serial number. | The error occurs if a loose item serial number is aggregated to a parent serial number. | |
Serial Number <Serial> has Packaging Level of <PackagingLevel>. Loose Item serial numbers must have Packaging Level of Each. | The error occurs if a loose item serial number is not at the "each" packaging level. | |
tl:homogeneousContainer | tl:numberList | tl:serial | Serial Numbers for pallets and cases must be in SSCC (00) format. | The error occurs if serial numbers are not in SSCC(00) format. |
Container Serial Number <Serial> contains items that belong to multiple products or lots. This container must be entered as a Mixed Container | The error occurs if the serial number includes different products or lots instead of a single product or lot. | |
tl:heterogeneousContainer | tl:serial | Serial Numbers for pallets and cases must be in SSCC (00) format. | The error occurs if serial numbers are not in SSCC(00) format. |
tl:packagingItemCode | Packaging Code <PackagingCode> does not exist. | The error occurs if the packaging code is not a GTIN. |
tl:packagingItemCode, tl:lotNumber | Container Serial Number <Serial> must include country clearance information for each unique product within the container. The following items are missing from this transaction: <list of packaging code-Lot Number combinations that are missing> | The error occurs if the heterogeneous container contains a Packaging Item Code and Lot Number combination that is not included in the message. |
tl:packagingItemCode, tl:lotNumber | Lot <Packaging Code - Lot Number> in heterogeneous container serial number <serial> cannot appear multiple times in the container | The error occurs if the Packaging Item Code and Lot Number combination is repeated in this message within a single heterogeneous container serial number. |
tl:packagingItemCode, tl:lotNumber | Item <Packaging Code - Lot Number> does not exist in container serial number <Serial> | The error occurs if the Packaging Item Code and Lot Number combination does not exist in the heterogeneous container. |
Class 3 | ||
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered. |
ESM Country Clearance (EPCIS v1.2)

Message Type: SOM_ESM_COUNTRY_CLEARANCE
Info Exchange Display Name: ESM Country Clearance

Data Element | Occurs Length |
Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
epcis:EPCISDocument | - |
1…1- | Required. EPCIS message root element. | |||||||||
@schemaVersion | 0/* |
1…1Decimal | Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2 .84 |
|||||||||
@creationDate | 1/* |
1…1DateTime | Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format.85 | |||||||||
EPCISHeader | - |
0…1- | Required. The XML file control header. | |||||||||
sbdh:StandardBusinessDocumentHeader | - |
1…1- | Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification. | |||||||||
sbdh:HeaderVersion | 0/* |
1…1String | Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0 .86 |
|||||||||
sbdh:Sender | - |
1…*- | Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages. | |||||||||
sbdh:Identifier | 1/* |
1…1String | Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type.87 Send SGLN and all other party types with the GS1-conformant uri prefix, for example:
![]() See the MDPartyTypeAttributes enumeration list for valid values. |
|||||||||
@Authority | 1/* |
1…1String | Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values.88See the MDPartyTypeEnums enumeration list for valid values. |
|||||||||
sbdh:Receiver | - |
1…*- | Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that receives the standard business document. The Receiver element is used only once with GS1 XML messages. | |||||||||
sbdh:Identifier | 1/* |
1…1String | Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type.89 Send SGLN and all other party types with the GS1-conformant uri prefix, for example:
![]() See the MDPartyTypeAttributes enumeration list for valid values. |
|||||||||
@Authority | 1/* |
1…1String | Required. The receiver identifier type. The Authority was previously expected to be set to "GLN" for GS1 XML messages. An update made in December 2016 changed this to accept additional values.90 See the MDPartyTypeEnums enumeration list for valid values. |
|||||||||
sbdh:DocumentIdentification | - |
1…1- | Required. Contains the identification group for the message. | |||||||||
sbdh:Standard | 0/* |
1…1String | Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal .91 |
|||||||||
sbdh:TypeVersion | 0/* |
1…1String | Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0 .92 |
|||||||||
sbdh:InstanceIdentifier | 1/* |
1…1String | Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others.93 | |||||||||
sbdh:Type | 0/* |
1…1String | Required. Identifies the document type. The Type value is set to "Events" for a shipment event.94 | |||||||||
sbdh:CreationDateAndTime | 0/* |
1…1DateTime | Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z . |
|||||||||
EPCISBody | - |
1…1- | Required. Contains all of the EPCIS events for this message. | |||||||||
EventList | - |
1…1- | Required. The EventList must include one or more Object Events for country clearance. | |||||||||
ObjectEvent | - |
1…*- | Required.
The ObjectEvent indicates the message type. Indicates a country clearance event when:
|
|||||||||
eventTime | 1/* |
1…1DateTime | Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section
9.5 of [EPCIS1.0.1].
The system expects the Z to be appended if it is not included, however, the system assumes that the time is GMT and therefore appends the Z .95 |
|||||||||
eventTimeZoneOffset | 1/* |
1…1String | Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time, whether it is standard time or Daylight saving time. Per Section 7.2.8 of [EPCIS1.0.1].96 | |||||||||
epcList | - |
1…1- | This element group is not mapped. Send an empty tag
(i.e. <epcList/> ). Serial numbers are mapped from the tl:itemList,
tl: homogeneousContainersList, and tl:heterogeneousContainersList element groups in tl:countryClearanceEventExtensions. |
|||||||||
action | 0/* |
1…1String | Required. The action type of the event. This value must equal OBSERVE .97 |
|||||||||
bizStep | 0/* |
0…1AnyURI | Required. The business step taken in the event. This value must equal urn:epcglobal:cbv:bizstep:inspecting .98 |
|||||||||
disposition | 0/* |
0…1AnyURI |
Required. Indicates the status of the message. This value must equal |
|||||||||
readPoint | - |
0…1- | Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a more granular location identifier. For country clearance, this is the importing party identifier. | |||||||||
id | 0/* |
1…1AnyURI | Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a more granular location identifier. For country clearance, this is the importing
party identifier.100 See the MDPartyTypeAttributes enumeration list for valid values. |
|||||||||
tl:countryClearanceEventExtensions | - |
0…1- | Main extension body. | |||||||||
tl:clearanceType | 1/* |
1…1String | Required. Identifies the clearance type.101 See the ClearanceType enumeration list for valid values. |
|||||||||
tl:importFromCountry | 1/* |
1…1String | Required. Country the product is being imported from using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code.102 | |||||||||
tl:importToCountry | 1/* |
1…1String | Required. Country the product is being imported into using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code.103 | |||||||||
tl:registrationDate | 0/* |
0…1Date | Conditionally required if tl:clearanceType = CUSTOMS . Registration date in YYYY-MM-DD XML date
format.104 |
|||||||||
tl:customsAuthorityCode | 0/* |
0…1String | Conditionally required for Russia if tl:clearanceType = CUSTOMS . Customs authority code.105 |
|||||||||
tl:declarationReleaseNumber | 0/* |
0…1String | Conditionally required for Russia if tl:clearanceType = CUSTOMS . Declaration release number for
product.106 |
|||||||||
tl:actionCode | 0/* |
0…1String | Conditionally required for Russia if tl:clearanceType = CUSTOMS . Action code.107See the ActionCode enumeration list for valid values. |
|||||||||
tl:importingPartyId | 1/* |
1…1String | Required. Importing party identifier.108 | |||||||||
@type | 1/* |
1…1String | Required. Importing party identifier type.109 See the BusinessAndLocationId enumeration list for valid values. |
|||||||||
tl:itemList | - |
0…1- | Conditionally required if both tl:homogeneousContainersList and tl:heterogeneousContainersList are not present. List of items. Each item is a single product of loose items (e.g. sampled serial numbers). | |||||||||
tl:items | - |
1…*- | Required. Products that are being imported. One item will be present for each unique product. | |||||||||
tl:numberList | 1/* |
1…1String | Required. Contains the list of serial numbers of eaches. | |||||||||
tl:serial | 1/* |
1…1String | Required. The serial number being imported. Serial number is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01) (21) formatted serial number for GTINs.110 | |||||||||
tl:customsValue | - |
1…1Decimal | Required. Per unit customs cost for each order item in order item list.111 | |||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.112 See the ISOCurrency enumeration list for valid values. |
|||||||||
tl:transactionIdentifier | 0/* |
1…*String | Required. The transaction identifier associated with the country clearance.113 | |||||||||
@type | 1/* |
1…1String | Required. The transaction identifier type.114 See the ClearanceTransactionId enumeration list for valid values. |
|||||||||
@date | - |
1…1Date | Required. Transaction date attribute in YYYY-MM-DD format.115 | |||||||||
tl:homogeneousContainersList | - |
0…1- | Conditionally required if both tl:itemList and tl:heterogeneousContainersList are not present. List of homogeneous containers. Each container represents one or more batches of the same product. | |||||||||
tl:homogeneousContainer | - |
1…*- | Required. Cases or pallets containing the same product. | |||||||||
tl:numberList | 1/* |
1…1String | Required. Contains the list of serial numbers of cases or pallets. | |||||||||
tl:serial | 1/* |
1…*String | Required. Contains the serial number or numbers that are being imported. Serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI(00) formatted serial number for SSCCs.116 | |||||||||
tl:customsValue | 0/* |
1…1Decimal | Required. Per unit customs cost for each order item in order item list.117 | |||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.118 See the ISOCurrency enumeration list for valid values. |
|||||||||
tl:transactionIdentifier | 0/* |
1…*String | Required. The transaction identifier associated with the country clearance.119 | |||||||||
@type | 1/* |
1…1String | Required. The transaction identifier type.120 See the ClearanceTransactionId enumeration list for valid values. |
|||||||||
@date | - |
1…1Date | Required. Transaction date attribute.121 | |||||||||
tl:heterogeneousContainersList | - |
0…1- | Conditionally required if both tl:itemList and tl:homogeneousContainersList are not present. List of heterogeneous containers. Every container is a case or pallet with different products inside. | |||||||||
tl:heterogeneousContainer | - |
1…*- | Required. Case or pallet containing a mix of different products. | |||||||||
tl:serial | 1/* |
1…1String | Required. Contains the serial number or numbers that are being imported. Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(00) formatted serial number for SSCCs.122 | |||||||||
tl:containerContents | - |
1…*- | Required. Contents of heterogeneous containers. | |||||||||
tl:packagingItemCode | 1/* |
1…1String | Required. The packaging level item code (e.g. GTIN-14, CN-ResCode) associated with the serialized items that are being imported.123 | |||||||||
@type | 1/* |
1…1String | Required. The product code type for the
packaging item code.124 See the ItemCode enumeration list for valid values. |
|||||||||
cbvmda:lotNumber | 1/* |
1…1String | Required. The lot number associated with the specified serial numbers used to identify the serial numbers that are being updated.125 | |||||||||
tl:customsValue | 0/* |
1…1Decimal | Required. Per unit customs cost for each order item in order item list.126 | |||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.127 See the ISOCurrency enumeration list for valid values. |
|||||||||
tl:transactionIdentifier | 0/* |
1…*String | Required. The transaction identifier(s) associated with the country clearance, if available.128 | |||||||||
@type | 1/* |
1…1String | Required. The transaction identifier type.129 See the ClearanceTransactionId enumeration list for valid values. |
|||||||||
@date | - |
1…1Date | Required. Transaction date attribute.130 |

<?xml version="1.0" encoding="UTF-8"?> <epcis:EPCISDocument xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:tl="http://epcis.tracelink.com/ns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" schemaVersion="1.2" creationDate="2019-05-15T17:45:20.00Z"> <EPCISHeader> <sbdh:StandardBusinessDocumentHeader> <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion> <sbdh:Sender> <sbdh:Identifier Authority="GLN">0882028677019</sbdh:Identifier> </sbdh:Sender> <sbdh:Receiver> <sbdh:Identifier Authority="GLN">0333331013655</sbdh:Identifier> </sbdh:Receiver> <sbdh:DocumentIdentification> <sbdh:Standard>EPCglobal</sbdh:Standard> <sbdh:TypeVersion>1.0</sbdh:TypeVersion> <sbdh:InstanceIdentifier>201901311745200001</sbdh:InstanceIdentifier> <sbdh:Type>Events</sbdh:Type> <sbdh:CreationDateAndTime>2019-05-15T17:45:20.00Z</sbdh:CreationDateAndTime> </sbdh:DocumentIdentification> </sbdh:StandardBusinessDocumentHeader> </EPCISHeader> <EPCISBody> <EventList> <ObjectEvent> <eventTime>2019-05-15T00:12:23.8307Z</eventTime> <eventTimeZoneOffset>+00:00</eventTimeZoneOffset> <epcList/> <action>OBSERVE</action> <bizStep>urn:epcglobal:cbv:bizstep:inspecting</bizStep> <disposition>https://epcis.tracelink.com/disp/cleared_customs</disposition> <readPoint> <id>urn:epc:id:sgln:7777776.67345.0</id> </readPoint> <tl:countryClearanceEventExtensions> <tl:clearanceType>CUSTOMS</tl:clearanceType> <tl:importFromCountry>FR</tl:importFromCountry> <tl:importToCountry>RU</tl:importToCountry> <tl:registrationDate>2019-05-14</tl:registrationDate> <tl:customsAuthorityCode>201960876</tl:customsAuthorityCode> <tl:declarationReleaseNumber>198765</tl:declarationReleaseNumber> <tl:actionCode>CUSTOMS</tl:actionCode> <tl:itemList> <tl:items> <tl:numberList> <tl:serial>015088202501033321100000060001</tl:serial> <tl:serial>015088202501033321100000060002</tl:serial> <tl:serial>015088202501033321100000060003</tl:serial> <tl:serial>015088202501033321100000060004</tl:serial> <tl:serial>015088202501033321100000060005</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876987321</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875986412</tl:transactionIdentifier> </tl:items> <tl:items> <tl:numberList> <tl:serial>015088202501033321100000060006</tl:serial> <tl:serial>015088202501033321100000060007</tl:serial> <tl:serial>015088202501033321100000060008</tl:serial> <tl:serial>015088202501033321100000060009</tl:serial> <tl:serial>0150882025010333211000000600010</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876987322</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875986413</tl:transactionIdentifier> </tl:items> </tl:itemList> <tl:homogenousContainersList> <tl:homogeneousContainer> <tl:numberList> <tl:serial>00138526195501000048</tl:serial> <tl:serial>00138526195501000049</tl:serial> <tl:serial>00138526195501000050</tl:serial> <tl:serial>00138526195501000051</tl:serial> <tl:serial>00138526195501000052</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876987324</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875986415</tl:transactionIdentifier> </tl:homogeneousContainer> <tl:homogeneousContainer> <tl:numberList> <tl:serial>00138526195501000055</tl:serial> <tl:serial>00138526195501000056</tl:serial> <tl:serial>00138526195501000057</tl:serial> <tl:serial>00138526195501000058</tl:serial> <tl:serial>00138526195501000059</tl:serial> </tl:numberList> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876987326</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875986417</tl:transactionIdentifier> </tl:homogeneousContainer> </tl:homogenousContainersList> <tl:heterogenousContainersList> <tl:heterogenousContainer> <tl:serial>00138526195501000095</tl:serial> <tl:containerContents> <tl:packagingItemCode type="GTIN-14">00882025030223</tl:packagingItemCode> <cbvmda:lotNumber>ABC123</cbvmda:lotNumber> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876987327</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875986418</tl:transactionIdentifier> </tl:containerContents> </tl:heterogenousContainer> <tl:heterogenousContainer> <tl:serial>00138526195501000088</tl:serial> <tl:containerContents> <tl:packagingItemCode type="GTIN-14">00882025030233</tl:packagingItemCode> <cbvmda:lotNumber>ABC456</cbvmda:lotNumber> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876988327</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875987418</tl:transactionIdentifier> </tl:containerContents> </tl:heterogenousContainer> <tl:heterogenousContainer> <tl:serial>00138526195501000077</tl:serial> <tl:containerContents> <tl:packagingItemCode type="GTIN-14">00882025030244</tl:packagingItemCode> <cbvmda:lotNumber>ABC789</cbvmda:lotNumber> <tl:customsValue currencyCode="RUB">1976.00</tl:customsValue> <tl:transactionIdentifier type="CERTIFICATECONFORMITY" date="2019-05-12">9876987328</tl:transactionIdentifier> <tl:transactionIdentifier type="DECLARATIONCONFORMITY" date="2019-05-12">4875986419</tl:transactionIdentifier> </tl:containerContents> </tl:heterogenousContainer> </tl:heterogenousContainersList> </tl:countryClearanceEventExtensions> </ObjectEvent> </EventList> </EPCISBody> </epcis:EPCISDocument>

Data Element | Error Message | Description |
---|---|---|
Class 1 | ||
sbdh:Sender | sbdh:Identifier | @Authority | Valid Sender/Identifier Authority is required !!! | The error occurs if the source is present, but there is no matching entry in the lookup file. |
sbdh:Receiver | sbdh:Identifier | @Authority | Valid Receiver/Identifier Authority is required !!! | The error occurs if the source is present, but there is no matching entry in the lookup file. |
action | Action OBSERVE is required for country clearance event !!! | The error occurs if the source does not equal "OBSERVE". |
bizStep | bizStep urn:epcglobal:cbv:bizstep:inspecting is required for country clearance event !!! | The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:inspecting". |
readPoint | Valid readPoint identifier type is required !!! | The error occurs if the source is present, but there is no matching entry in the lookup file. |
tl:clearanceType | Valid clearance type code is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
tl:importFromCountry | Valid import from country is required !!! | The error occurs if the source is greater than 2 characters, or is empty or null. |
tl:importToCountry | Valid import to country is required !!! | The error occurs if the source is greater than 2 characters, or is empty or null. |
tl:registrationDate | Registration date is required !!! | The error occurs if tl:clearanceType = "CUSTOMS", but the source is empty or null. |
tl:actionCode | Valid action code is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
tl:importingPartyId | Importing party identifier is required !!! | The error occurs if the source is empty or null. |
tl:importingPartyId | @type | Valid importing party identifier type is required !!! | The error occurs if the source is empty or null, or is not a valid value from the enumeration list. |
tl:items | tl:numberList | tl:serial | Serial number is required if itemList is present !!! | The error occurs if the source is empty or null. |
tl:items | tl:customsValue | Customs value is required !!! | The error occurs if the source is empty or null. |
tl:items | tl:customsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
tl:items | tl:transactionIdentifier | Transaction identifier is required !!! | The error occurs if the source is empty or null. |
tl:items | tl:transactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if tl:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:items | tl:transactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
tl:homogeneousContainer | tl:numberList | tl:serial | Serial number is required if homogeneousContainersList is present !!! | The error occurs if the source is empty or null. |
tl:homogeneousContainer | tl:customsValue | Customs value is required !!! | The error occurs if the source is empty or null. |
tl:homogeneousContainer | tl:customsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
tl:homogeneousContainer | tl:transactionIdentifier | Transaction identifier is required !!! | The error occurs if the source is empty or null. |
tl:homogeneousContainer | tl:transactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if tl:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:homogeneousContainer | tl:transactionIdentifier | @date | Transaction date is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:serial | Serial number is required if heterogeneousContainersList is present !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:packagingItemCode | Packaging item code is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:packagingItemCode | @type | Valid packaging item code type required if packagingItemCode is populated !!! | The error occurs if tl:packagingItemCode is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:heterogeneousContainer | tl:containerContents | cbvmda:lotNumber | Lot number is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:customsValue | Customs value is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:customsValue | @currencyCode | Valid currency code for customs value is required !!! | The error occurs if the source is less than 3 characters, or is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:transactionIdentifier | Transaction identifier is required !!! | The error occurs if the source is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:transactionIdentifier | @type | Valid transaction identifier type is required !!! | The error occurs if tl:transactionIdentifier is populated, but the source is either not a valid value from the enumeration list or is empty or null. |
tl:heterogeneousContainer | tl:containerContents | tl:transactionIdentifier | @date | Transaction date is is required !!! | The error occurs if the source is empty or null. |
Class 2 | ||
tl:serial | Serial Number <SerialNumber> does not exist. | The error occurs if the serial number does not exist in TraceLink. |
Serial Number <Serial> was never commissioned/registered. | The error occurs if the status of the serial number is not commissioned or registered. | |
tl:packagingItemCode | Packaging Code <PackagingCode> does not exist. | The error occurs if the packaging code is not a GTIN. |
cbvmda:lotNumber | Lot Number<LotNumber> does not exist for Packaging Code <PackagingCode> . | The error occurs if the specified lot number does not exist for the specified packaging code. |
Class 3 | ||
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered. |