Receipt APIs

Why do I use these messages?

Use the following messages to receive any type delivery (i.e. purchase, return, or transfer) and move the serial numbers from the delivery into inventory.

Administrators for companies that Own Serialized Operations Manager can configure the app to automatically receive transfer shipments without submitting a receipt message. See the Company Administration Online Help for more information.

Which reports do these messages generate?

These messages generate one of the following reports in the Russia Compliance application if their contents meet the report conditions:

Receipt (XML)

This message allows shipment data to be received in two parts (i.e. shipment information and serial numbers). For example, shipment information can originate from an ERP system and serial numbers from WMS system or 3PL partner.

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

Message Type: SOM_RECEIPT

Info Exchange Display Name: Shipment Receipt

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.

Data Element Occurs
Length		 Type Description
SOMReceiptMessage [1...1]
[-]		 - Required. The SOMReceiptMessage input is the root element of the Serialized Operations Manager Receipt message. This element contains additional elements/segments that detail the message's header information (e.g. sender, receiver information) as well as the body of the actual message. This is the first element in the document.
  som:ControlFileHeader [1...1]
[-]		 - Required. The message document's header information.
    cmn:FileSenderNumber [1...1]
[1/20]		 String Required. The company identifier of the file’s sender. *1
    cmn:FileReceiverNumber [1...1]
[1/20]		 String Required. The company identifier of the file’s recipient. *2
    cmn:FileControlNumber [1...1]
[1/20]		 String Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages. *3
    cmn:FileDate [1...1]
[10/10]		 Date 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]
[9/9]		 Time 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. The Message Body includes all of the Serialized Operations Manager Receipt message details including, but not restricted to, location, delivery, and order information.
    cmn:LocationId [0...1]
[0/34]		 String Required. The LocationId field specifies the identifier of the facility/warehouse so as to scope the Receipt status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Receipt status update will be applied globally to all matching serial numbers in the system. *6
    cmn:DeliveryNumber [1...1]
[1/*]		 String Required. This field indicates the DeliveryNumber that links the order information to the serialized pick information for this customer delivery. *7
    cmn:DeliveryCompleteFlag [1...1]
[1/*]		 Boolean Required. This mandatory field supports incremental receipts. If all of the information (e.g. order details, picked serial numbers) are provided in a single message, the delivery complete flag is set to true. Values must be lowercase. *8

When set to true, the DeliveryCompleteFlag instructs TraceLink to:

  1. Process an outbound delivery.
  2. Update the status of all serial numbers and sub-child aggregations to be shipped.
  3. Trigger generation of regulatory reporting messages based on customer configuration.

If only partial information is provided in the message (e.g. only the order details are provided and picked items are sent incrementally) the delivery complete flag is set to false for all intermediate messages. The flag is then set to true when all information has been communicated to TraceLink and the delivery is complete.
    cmn:RegisterUnknownSNs [0...1]
[0/*]		 Boolean Determines whether the serial numbers that are unknown to SOM should be registered. Valid values: *9
  • true – register all serial numbers that do not currently exist in Serialized Operations Manager in an available state.
  • false – (default) all serial numbers that do not currently exist in Serialized Operations Manager are rejected.
    som:OrderDetails [0...1]
[-]		 - Conditionally required if som:AddReceivedItems is present. The OrderDetails complex message communicates pertinent details such as the business transaction identifiers, date, order item pick list, sender, and recipient information. This element is mandatory before the delivery complete flag can be set. However, it can be communicated at any time (e.g. with, before, or after the picked serial numbers have been communicated).
      cmn:CorrectiveReceipt [0...1]
[0/*]		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • true – The receipt is a corrective receipt.
  • false – (default) The receipt is not a corrective receipt.
      cmn:OriginalDeliveryNumber [0...1]
[0/*]		 String Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt.
      cmn:EntryPort [0...1]
[0/*]		 String Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
      cmn:ExitPort [0...1]
[0/*]		 String Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
      cmn:TransactionIdentifier [0...*]
[ 0/*]		 String Conditionally required for the following countries:

The transaction identifier is associated with the picked serial numbers for regulatory reporting purposes. *10
        @type [1...1]
[1/*]		 String Required. The transaction identifier type. *11

See the TransactionId enumeration list for valid values.
        @date [0...1]
[0/*]		 Date Conditionally required if cmn:ShipToCountryCode = RU. The transaction identifier date. *12
      cmn:TransactionDate [1...1]
[1/*]		 Date Required. The date of the transaction in XML YYYY-MM-DD format. This field indicates the date when the transfer of ownership occurred between the shipper and receiver. *13
      cmn:TransactionTime [0...1]
[0/*]		 Time The time of the transaction in XML HH:MM:SS format. *14
      cmn:ShipToCountryCode [1...1]
[2/2]		 String Required. Two-letter ISO country code for ship-to country. This value will be referenced to advise regulatory reporting if it is mandatory for the specified country market. Setting this value alone does not trigger regulatory reporting. The actual trigger for regulatory reporting is governed by customer administrative configuration in the TraceLink application. *15

See the ISOCountryCode enumeration list for valid values.
      cnm:ShipFromCountryCode [0...1]
[2/2]		 String Required. Two-letter ISO country code for the ship-from country. This value will be referenced to advise regulatory reporting if it is required for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application. *16

See the ISOCountryCode enumeration list for valid values.
      cmn:ReceiptDistributionType [0...1]
[1/*]		 String

Conditionally required if cmn:ReceiptDistributionType was not provided in a previously saved incomplete or pending receipt for the delivery number. This field indicates which types of regulatory reporting may be triggered based on the nature of the transaction. Can send the ReceiptDistributionType in a previously saved incomplete or pending receipt for the delivery number.

See the ReceiptDistributionType enumeration list for valid values.
      cmn:TransferWithoutShipment [0…1]
[0/*]		 Boolean

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state.
  • false (default) – Serial numbers are in the Pending Receipt state.

Only use when cmn:ReceiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
      cmn:SupplyType [0...1]
[0/*]		 String Conditionally required if cmn:shipToCountryCode = KR and cmn:ReceiptDistributionType = INCOUNTRYRETURN. Identifies the type of supply that is being performed using one of the permitted values. All values except for Collection apply.

See the SupplyType enumeration list for valid values.

Brazil: populate only if performing a Collection, Donation or SampleDistribution.
      cmn:ContractType [0...1]
[0/*]		 String

Conditionally required if cmn:ShipFromCountryCode = KR and cmn:SalesDistributionType = EXPORTSALE or INCOUNTRYSALE. Identifies if a private or competitive bid contract is used for the sale of goods.

See the ContractType enumeration list for valid values.
      cmn:Comments [0...1]
[0/*]		 String Optional remarks or comments associated with delivery.
      cmn:ContractNumber [0...1]
[0/*]		 String Identification number of the contract. * *17
      cmn:FundingSource [0...1]
[0/*]		 String Required. Source of the funding. *18

See the FundingSource enumeration list for valid values.
      cmn:DeliveryInspection [0...1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.
      cmn:DeliveryInspectionDate [0...1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *19
      cmn:DeliveryInspectionNote [0...1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
      cmn:RemovalFromCirculation [0...1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
      cmn:AggregationInspection [0...1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
      cmn:OrderItemList [0...1]
[-]		 - Conditionally required if cmn:ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. Order item list group is populated to communicate the expected pick quantities for each item code at the EACH (unit) level. This information is used in verification of the actual serial number picked to verify the correct product, correct lot number (if provided) and correct each quantity.
        cmn:AllowShortVerificationCount [0...1]
[0/*]		 Boolean Allow a short verification count flag. When comparing picked or received serial number counts in the ItemList counts this flag instructs the system to whether an error should be generated if the picked or received counts are less than expected. *20
     

 

 cmn:OrderItem [1...*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number, and quantity for each item that will be picked for the order. Each unique item code and lot number are communicated in a separate order item group.
          cmn:OrderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers to the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
          choice%1 [1...1]
[-]		 Choice

Required. Populate only one of cmnl:InternalMaterialCode, cmn:PackagingItemCode, or cmn:CountryDrugCode. One of the three options must be present.

          cmn:InternalMaterialCode [0...1]
[1/*]		 String Conditionally required if neither cmn:PackagingItemCode nor cmn:CountryDrugCode is present. Option 1 for choice%1 in cmn:OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *21
          cmn:PackagingItemCode [0...1]
[1/*]		 String Conditionally required if neither cmn:InternalMaterialCode nor cmn:CountryDrugCode is present. Option 2 for choice%1 in cmn:OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *22
            @type [0...1]
[0/*]		 String Required. The product code type for the packaging item code using the supported enumeration values.

Valid values:

  • CN-RESCODE
  • GTIN-14
  • NTIN
          cmn:CountryDrugCode [0...1]
[1/*]		 String Conditionally required if neither cmn:InternalMaterialCode nor cmn:PackagingItemCode is present. Option 3 for choice%1 in cmn:OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *23
            @type [0...1]
[0/*]		 String Required. The national drug code type using the supported enumeration values. * 24
          cmn:LotNumber [0...1]
[0/*]		 String The lot or batch code for the items to be picked (if available) in an alphanumeric string. *25
          cmn:ExpirationDate [0...1]
[1/*]		 Date Expiration date of the serialized item, in YYYY-MM-DD format.
          cmn:Quantity [1...1]
[1/*]		 Integer Required. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. Quantity must be greater than zero if cmn:IsSerialized = false. *26
          cmn:UnitPrice [0...1]
[-]		 Decimal Required. if:

Unit price of item. *27
            @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format.

See the ISOCurrency enumeration list for valid values.
          cmn:VAT [0...1]
[-]		 Decimal Value Added Tax per unit. *28
            @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *29

See the ISOCurrency enumeration list for valid values.
          cmn:GrossPrice [0...1]
[0/*]		 Decimal Price including unit price and all taxes and fees.  *30
            @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *31

See the ISOCurrency enumeration list for valid values.
          cmn:IsSerialized [0...1]
[-]		 Boolean Indicates if item is not serialized. If omitted, defaults to true. *32
          cmn:TransactionIdentifier [0...*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *33
            @type [1...1]
[1/*]		 String

Required. The transaction identifier type.

Valid values:

  • DESTRUCTION
  • INVOICE
  • NOTAFISCALELETRONICA
  • OTHER
  • PO
  • RETURN
            @date [0...1]
[0/*]		 Date Required. The date of the transaction in XML YYY-MM-DD format. This value is used for regulatory reporting of the transaction date. *34
      cmn:SenderInfo [0...1]
[ -]		 - Required.

This message contains information about the supply chain partner that is sending the return shipment. The FromBusinessParty and ShipFromLocation elements determine whether to use master data lookup to populate the address, license, and contact elements. Only one of FromBusinessParty or ShipFromLocation elements may be present at once.
        choice%1 [0...1]
[ -]		 Choice Option 1 within choice%1 of cmn:SenderInfo contains only the FromBusinessPartyLookupId (in this case, TraceLink will populate all of the FromBusinessPartyInfo field data based on company master data lookup). Populate this element only if no master data lookup is desired.

Option 2 within choice%1 of cmn:SenderInfo contains full FromBusinessPartyInfo business address field data that is populated by the customer directly in the interface. Populate this element fully only if no master data lookup is desired.
        cmn:FromBusinessPartyLookupId [0...1]
[0/*]		 String Option 1 for SenderInfo group. The FromBusinessPartyLookupId is a look-up identifier associated with the sold from business entity from the provided enumeration list. Use this value will as the look-up key in master data to populate the details in FromBusinessPartyInfo. *35
This field is optional, but may be used for master data lookup in TraceLink. An error is thrown if both cmn:FromBusinessPartyLookupId and cmn:FromBusinessPartyInfo are populated.
          @type [1...1]
[1/*]		 String Required. The type of the sold from business entity identifier.

See the BusinessLookupId enumeration list for valid values.
        cmn:FromBusinessPartyInfo [0...1]
[ 1/*]		 - Conditionally required if cmn:SenderInfo is present, but cmn:FromBusinessPartyLookupId is not present. This is option 2 within the SenderInfo field. This field contains full FromBusinessPartyInfo business address field data that will be populated by the customer directly in the interface.

Populate this element fully only if no master data look-up is desired.
          cmn:BusinessId [1...*]
[1/*]		 String Required.   Identifier associated with either the sold from business entity or the sold to business entity. This value is mandatory for regulatory reporting.  *36
            @type [1...1]
[1/*]		 String Required. The business id type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:BusinessClassification [0...1]
[0/*]		 String Conditionally required :
  • For Argentina.
  • If cmn:ShipToCountryCode = KR and cmn:ReceiptDistributionType = INCOUNTRYRETURN.

This field classifies the business type of the TraceLink customer or trading partner.

See the BusinessClassification enumeration list for valid values.

          BusinessInfo [0...1]
[-]		 - Conditionally required for the US: Provide all required child data elements. Populated with the business name and address of the sold from business entity.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The business name of the TraceLink Customer or Trading Partner. *37
            cmn:Street1 [1...1]
[1/*]		 String Required. The first line of the street address for the company indicated in cmn:BusinessName. *38
            cmn:Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in cmn:BusinessName. *39
            cmn:City [1...1]
[1/*		 String Required. The city of the company indicated in cmn:BusinessName. *40
            cmn:Village [0...1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0...1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0...1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0...1]
[0/*]		 String District Code. *41
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1...1]
[1/*]		 String Required. The standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in cmn:BusinessName. *42

See the ISOCountryCode enumeration list for valid values.
            cmn:PostalCode [1...1]
[1/*]		 String Required. The zip or other postal code of the company indicated in cmn:BusinessName. *43
            cmn:Country [1...1]
[1/*]		 String Required. Two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in cmn:BusinessName. *44

See the ISOCountryCode enumeration list for valid values.

            cmn:CorporateFax [0...1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0...1]
[0/*]		 String

The global identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0...1]
[0/*]		 String

The global House identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0...1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0...1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
        choice%2 [0...1]
[-]		 Choice Choice of either cmn:ShipFromLocationLookupId or cmn:ShipFromLocationInfo. Only one can be present.
        cmn:ShipFromLocationLookupId [0...1]
[1/*]		 String Option 1 for the SenderInfo group . This field is a partner identifier (e.g. GLN, DUNS) which triggers the look-up of the partner's address information in TraceLink (the master data). This information then populates the details in the ShipFromLocationInfo. *45
          @type [1...1]
[1/*]		 String Required. The location type.

See the LocationLookupId enumeration list for valid values.
        cmn:ShipFromLocationInfo [0...1]
[-]		 - Conditionally required for the US or if cmn:ShipFromLocationLookupId is not populated. This is Option 2 for the SenderInfo group. The full business information associated with the ship-from location is provided directly. Countries outside the U.S. do not track sold from business and ship-from location separately.
          cmn:FacilityId [1...*]
[1/*]		 String Required. This field is populated with either the ship-from Location Identifier or the ship-to location identifier. *46
For the for US: Provide a DEA, GLN, HIN, or SGLN identifier associated with the ship-from location, and provide the SGLN for the location where the event occurred if not already provided as the selected location identifier.
            @type [1...1]
[1/*]		 String Required. The facility type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:LocationInfo [0...1]
[-]		 String Conditionally required for the US. This field is populated with the business name and address of the business entity. This field is contingent on if this field is associated with the ShipFromLocationInfo or ShipToLocationInfo element.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The business name of the ship-from business entity.
            cmn:Street1 [1...1]
[1/*]		 String Required. The first line of the street address for the company indicated in cmn:BusinessName.
            cmn:Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in cmn:BusinessName.
            cmn:City [1...1]
[1/*]		 String Required. The city of the company indicated in cmn:BusinessName.
            cmn:Village [0...1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0...1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0...1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0...1]
[0/*]		 String District Code.
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1...1]
[1/*]		 String Required. The state, province, or region of the company specified in cmn:BusinessName. Use the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
            cmn:PostalCode [1...1]
[1/*]		 String Required. The zip or other postal code of the company indicated in cmn:BusinessName.
            cmn:Country [1...1]
[1/*]		 String Required. The country code of the company indicated in cmn:BusinessName.

See the ISOCountryCode enumeration list for valid values.

            cmn:CorporateFax [0...1]
[0/*]		 String Comnpany fax number.
            cmn:AddressObjectGUID [0...1]
[0/*]		 String

The global identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0...1]
[0/*]		 String

The global House identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0...1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0...1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
          cmn:LicenseNumber [0...*]
[0/*]		 String Conditionally required for the US. The LicenseNumber field is populated with the license number of the ship-to or ship-from facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *47
            @state [0...1]
[0/*]		 String The state or region in which the trading partner is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. *48
            @agency [0...1]
[0/*]		 String This attribute is used to give additional context to the LicenseNumber field. It indicates the agency that granted the license to the facility (e.g. Florida DOH, NABP). *49
          cmn:ContactInfo [0...1]
[-]		 String The ContactInfo field contains contact information for use by downstream trading partners to authenticate (i.e. verify) the transaction information recorded on the pedigree with the sender party. This field must contain a name and telephone number but could also include an individual's title, email and/or URL.

Do not include for Ship-From Location.

            cmn:Name [0...1]
[0/*]		 String Required. The name of the contact department or individual at the designated company. *50
            cmn:Title [0...1]
[0/*]		 String The title refers to the individual's job title who is indicated in the Name field. Title information is optional within cmn:ContactInfo. *51
            cmn:Telephone [1...1]
[1/*]		 String Required. The phone number of the contact department or individual at the designated company. This value must begin with the “+” character followed by the Country Calling Code. *52
            cmn:Email [0...1]
[0/*]		 String The email address of the contact department or individual at the designated company. Should be included if available. *53
            cmn:Url [0...1]
[0/*]		 String URL information is optional within cmn:ContactInfo. The URL refers to the designated company’s web address that facilitates authentication. *54
      cmn:ReceiverInfo [0...1]
[ -]		 String Required.

Information about the supply chain partner that is receiving the shipment. ReceiverInfo contains an XML Choice element on the ToBusinessPartyLookupId and ShipToLocationLookupId that decide whether master data look-up is used to populate the address, license, and contact elements.

        choice%1 [0...1]
[ -]		 Choice Option 1 within choice%1 of Receiverinfo contains only the ToBusinessPartyLookupId (in this case TraceLink populates all of the ToBusinessPartyInfo field data based on company master data lookup). Populate this element only if master data lookup is desired.

Option 2 within choice%1 of ReceiverInfo contains full ToBusinessPartyInfo business address field data that is populated by the customer directly in the interface. Populate this element fully only if no master data lookup is desired.
        cmn:ToBusinessPartyLookupId [0...1]
[0/*]		 String Option 1 for ReceiverInfo message. A look-up identifier associated with the sold to business entity from the provided enumeration list. Use this value as the look-up key in master data to populate the details in ToBusinessPartyInfo. *55
This field is optional, but may be used for master data lookup in TraceLink. An error is thrown if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
          @type [1...1]
[1/*]		 String Required. The type of the sold to business entity identifier.

See the BusinessLookupId enumeration list for valid values.
        cmn:ToBusinessPartyInfo [0...1]
[-]		 String Conditionally required if the cmn:ReceiverInfo group is populated, but cmn:ToBusinessPartyLookupId is not populated. Option 2 for ReceiverInfo group. This field is populated with the full business information associated with the sold to business entity.
          cmn:BusinessId [1...*]
[1/*]		 String Required. This field is populated with the full business information associated with the sold to business entity. This value is mandatory for regulatory reporting.  *56
            @type [1...1]
[1/*]		 String

Required. The business id type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:BusinessClassification [0...1]
[1/*]		 String Conditionally required:
  • For Argentina.
  • If cmn:shipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN.

This field classifies the business type of the receiving business entity.

See the BusinessClassification enumeration list for valid values.

          cmn:BusinessInfo [0...1]
[0/*]		 String Populated with the business name and address of the sold to business entity.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The name of the receiving business entity.
            cmn:Street1 [1...1]
[1/*]		 String Required. The first line of the street address for the company indicated in cmn:BusinessName.
            cmn:Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in cmn:BusinessName.
            cmn:City [1...1]
[1/*]		 String Required. The city of the company indicated in cmn:BusinessName.
            cmn:Village [0...1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0...1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0...1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0...1]
[0/*]		 String District Code.
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1...1]
[1/*]		 String Required. Two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in cmn:BusinessName.
            cmn:PostalCode [1...1]
[1/*]		 String Required. The zip or other postal code of the company indicated in cmn:BusinessName.
            cmn:Country [1...1]
[1/*]		 String Required. Standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in cmn:BusinessName.

See the ISOCountryCode enumeration list for valid values.
            cmn:CorporateFax [0...1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0...1]
[0/*]		 String

The global identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0...1]
[0/*]		 String

The global House identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0...1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0...1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
        choice%2 [1...1]
[-]		 Choice Can choose either cmn:ShipToLocationLookupId or cmn:ShipToLocationInfo; cannot choose both. No error thrown if none are present.
        cmn:ShipToLocationLookupId [0...1]
[0/*]		 String Option 1 for ReceiverInfo. A look-up identifier associated with the ship-to location using the provided enumeration list. This value will be used as the look-up key in master data to populate the details in ShipToLocationInfo.
          @type [1...1]
[1/*]		 String Required. ship-to location type.

See the LocationLookupId enumeration list for valid values.
        cmn:ShipToLocationInfo [0...1]
[0/*]		 String Conditionally required if cmn:ShipToLocationLookupId is not present. Option 2 for ReceiverInfo group. This field is populated with the full business information associated with the ship-to location, which is provided directly.
          cmn:FacilityId [1...*]
[1/*]		 String Required. This field is populated with either the ship-from Location Identifier or the ship-to location identifier. *57
For the US: Provide a DEA, GLN, HIN, or SGLN identifier associated with the ship-to location.
            @type [1...1]
[1/*]		 String Required. The facility id type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:LocationInfo [0...1]
[1/*]		 String Conditionally required for the US. This field is populated with the business name and address of the business entity.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The name of the receiving business entity.
            cmn:Street1 [1...1]
[1/*]		 String Required. The first line of the street address for the company indicated in cmn:BusinessName.
            cmn:Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in cmn:BusinessName.
            cmn:City [1...1]
[1/*]		 String Required. The city of the company indicated in cmn:BusinessName.
            cmn:Village [0…1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0…1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0...1]
[0/*]		 String District Code.
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1...1]
[1/*]		 String Required. Two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in cmn:BusinessName.
            cmn:PostalCode [1...1]
[1/*]		 String Required. The zip or other postal code of the company indicated in cmn:BusinessName.
            cmn:Country [1...1]
[1/*]		 String Required. Standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in cmn:BusinessName.

See the ISOCountryCode enumeration list for valid values.
            cmn:CorporateFax [0...1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0...1]
[0/*]		 String

The global identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0...1]
[0/*]		 String

The global House identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0...1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0...1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
          cmn:LicenseNumber [0...*]
[0/*]		 String Conditionally required for the US. The LicenseNumber field is populated with the license number of the ship-to or ship-from facility. This element may be repeated to include as many license numbers as required (such as, state and federal license).
              @state [0...1]
[0/*]		 String Use the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the LicenseNumber field. It indicates the state or region in which the trading partner is licensed.
              @agency [0...1]
[0/*]		 String This attribute is used to give additional context to the LicenseNumber field. It indicates the agency that granted the license to the facility (e.g. Florida DOH, NABP).
            cmn:ContactInfo [0...1]
[-]		 String This element contains the contact information to be used by downstream trading partners to verify the message's information. This information may be associated with the fromBusiness, shipFromLocation, toBusiness, and/or shipToLocation elements.
              cmn:Name [0...1]
[0/*]		 String The name field is an attribute of cmn:ContactInfo. It indicates the name of either an individual or department that represents the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Title [0...1]
[0/*]		 String The title field is an optional attribute of cmn:ContactInfo. It indicates the title of the person indicated in the name field of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Telephone [1...1]
[1/*]		 String Required. This value must begin with the + character followed by the Country Calling Code. The telephone field is an optional attribute of cmn:ContactInfo. It indicates the telephone number of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Email [0...1]
[0/*]		 String The email field is a recommended attribute of cmn:ContactInfo. It indicates the email address of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity, and/or the shipToLocation entity, contingent on which entity the attribute is affixed to.
              cmn:Url [0...1]
[0/*]		 String The url field is an optional attribute of cmn:ContactInfo. It indicates the website of either the fromBusiness entity, the shipFromLocation entity, the toBusiness entity and/or the shipToLocation entity, contingent on which entity the url field is affixed to.
      cmn:CarrierInfo [0...*]
[-]		 - Information about the transportation partner that is transporting the shipment.
        choice1 [1...1]
[-]		 Choice Required. Must choose populate cmn:CarrierBusinessPartyLookupId or cmn:CarrierBusinessPartyInfo.
        cmn:CarrierBusinessPartyLookupId [0...1]
[1/*]		 String Conditionally required if cmn:CarrierBusinessPartyInfo is not populated. This is Option 1 for cmn:CarrierInfo . This value indicates the look-up identifier associated with the Carrier entity from the provided enumeration list. This value will be used as the look-up key in master data to populate the details in CarrierBusinessPartyInfo. *58
          @type [1...1]
[1/*]		 String Required. The business party type.

See the BusinessLookupId enumeration list for valid values.
        cmn:CarrierBusinessPartyInfo [0...1]
[-]		 - Conditionally required for Brazil, or if cmn:CarrierBusinessPartyLookupId is not populated. Option 2 for cmn:CarrierInfo choice%1 group. The full business information associated with the transportation carrier business entity is provided.
          cmn:BusinessId [1...*]
[1/*]		 String Required. The identifier associated with the transport carrier business entity. This value is mandatory for regulatory reporting.
For Brazil: provide the BR_CNPJ, BR_CPF, BR_CNES or BR_PROF_REG, and BR_CNPJ is the value preferred by ANVISA if the company has one.
            @type [1...1]
[1/*]		 String Required. The business id type.

See the BusinessAndLocationId enumeration list for valid values.

Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY
          cmn:BusinessClassification [0...1]
[0/*]		 String This field classifies the business type of the carrier party.

Valid values:

  • DISTRIBUTOR
  • HEALTHCARE
  • LOGISTICS
  • MANUFACTURER
  • PHARMACY
  • WHOLESALER
          cmn:BusinessInfo [0...1]
[-]		 - Populated with the business name and address of the transportation carrier business entity.
            cmn:BusinessName [1...1]
[1/*]		 String Required. The name of the receiving business entity.
            cmn:Street1 [1...1]
[1/*]		 String Required. The first line of the street address for the company indicated in cmn:BusinessName.
            cmn:Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in cmn:BusinessName.
            cmn:City [1...1]
[1/*]		 String Required. The city of the company indicated in cmn:BusinessName.
            cmn:Village [0...1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0...1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0...1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0...1]
[0/*]		 String District Code.
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1...1]
[1/*]		 String Required. Two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in cmn:BusinessName.
            cmn:PostalCode [1...1]
[1/*]		 String Required. The zip or other postal code of the company indicated in cmn:BusinessName.
            cmn:Country [1...1]
[1/*]		 String Required. Standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in cmn:BusinessName.

See the ISOCountryCode enumeration list for valid values.
            cmn:CorporateFax [0...1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0...1]
[0/*]		 String

The global identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0...1]
[0/*]		 String

The global House identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0...1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0...1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
    cmn:WarehouseOperatorName [0...1]
[0/*]		 String Conditionally required for China. This field indicates the name of the person responsible for warehouse operations. This element can be communicated at any time (e.g. with, before, or after the order details or picked items have been communicated). *59
    som:AddReceivedItems [0...1]
[-]		 - Conditionally required if som:RemoveReceivedItems is not populated. The som:AddReceivedItems group is populated with the list of serial numbers for the outermost handling units received for this order. TraceLink will look up the child aggregations of the serial numbers provided in the list and update the container and all sub-child items with the received status.
      cmn:Serial [1...*]
[1/*]		 String Required. This attribute identifies the received serial numbers included in the message and their format. *60
        @format [0...1]
[0/*]		 String Required. The format of the serial number.

See the Format enumeration list for valid values.
        @orderItemNumber [0...1]
[0/*]		 String Order item number attribute associating specific serial numbers to the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
    som:RemoveReceivedItems [0...1]
[-]		 - Conditionally required if som:AddReceivedItems is not populated. The som:RemoveReceivedItems group is populated with the list of serial numbers that were previously reported as received for this delivery, but have been unreceived (e.g. will not be a part of the order). TraceLink will look up the child aggregations of the serial numbers provided in the list and update the container and all sub-child items with the available status and disassociate it from the order.
      cmn:Serial [1...*]
[1/*]		 String Required. This attribute identifies the unreceived serial numbers included in the transaction and their format.
        @format [0...1]
[0/*]		 String Required. The format of the serial number.

See the Format enumeration list for valid values.

 

<?xml version="1.0" encoding="UTF-8"?>
<som:SOMReceiptMessage xmlns="urn:tracelink:mapper:sl:serialized_operations_manager" xmlns:som="urn:tracelink:mapper:sl:serialized_operations_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
    <som:ControlFileHeader>
        <cmn:FileSenderNumber>8888882028655</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>20180612063132</cmn:FileControlNumber>
        <cmn:FileDate>2018-06-12</cmn:FileDate>
        <cmn:FileTime>06:31:32Z</cmn:FileTime>
    </som:ControlFileHeader>
    <som:MessageBody>
        <cmn:LocationId>412333444</cmn:LocationId>
        <cmn:DeliveryNumber>4610044</cmn:DeliveryNumber>
        <cmn:DeliveryCompleteFlag>true</cmn:DeliveryCompleteFlag>
        <cmn:RegisterUnknownSNs>false</cmn:RegisterUnknownSNs>
        <som:OrderDetails>
	     <cmn:CorrectiveReceipt>true</cmn:CorrectiveReceipt>	
	     <cmn:OriginalDeliveryNumber>123456</cmn:OriginalDeliveryNumber>
            <cmn:EntryPort></cmn:EntryPort>
            <cmn:ExitPort></cmn:ExitPort>
            <cmn:TransactionIdentifier type="BOL" date="2018-06-12">BOL-111010</cmn:TransactionIdentifier>
            <cmn:TransactionIdentifier type="PO" date="2018-06-12">PO303005</cmn:TransactionIdentifier>
            <cmn:TransactionIdentifier type="INVOICE" date="2018-06-12">INV9978</cmn:TransactionIdentifier>
            <cmn:TransactionIdentifier type="ASN" date="2018-06-12">ASN53014</cmn:TransactionIdentifier>
            <cmn:TransactionDate>2018-06-12</cmn:TransactionDate>
            <cmn:TransactionTime>06:30:30</cmn:TransactionTime>
            <cmn:ShipToCountryCode>BR</cmn:ShipToCountryCode>
            <cmn:ShipFromCountryCode>US</cmn:ShipFromCountryCode>
            <cmn:ReceiptDistributionType>IMPORTPURCHASE</cmn:ReceiptDistributionType>
            <cmn:TransferWithoutShipment>false</cmn:TransferWithoutShipment>
            <cmn:SupplyType>PatientDistribution</cmn:SupplyType>
            <cmn:ContractType>PrivateContract</cmn:ContractType>
            <cmn:Comments>Purchase for import</cmn:Comments>
            <cmn:ContractNumber>C110</cmn:ContractNumber>
            <cmn:FundingSource>OwnFunds</cmn:FundingSource>
            <cmn:OrderItemList>
                <cmn:OrderItem>
                    <cmn:OrderItemNumber>190</cmn:OrderItemNumber>
                    <cmn:InternalMaterialCode>133661</cmn:InternalMaterialCode>
                    <cmn:LotNumber>PPP555</cmn:LotNumber>
                    <cmn:ExpirationDate>2020-06-12</cmn:ExpirationDate>
                    <cmn:Quantity>500</cmn:Quantity>
                    <cmn:UnitPrice currencyCode="USD">50.00</cmn:UnitPrice>
                    <cmn:IsSerialized>true</cmn:IsSerialized>
                    <cmn:VAT currencyCode="USD">50.00</cmn:VAT>
                    <cmn:GrossPrice currencyCode="USD">100.00</cmn:GrossPrice>
                    <cmn:IsSerialized>false</cmn:IsSerialized>
                    <cmn:TransactionIdentifier type="PO" date="2018-06-12">PO1078</cmn:TransactionIdentifier>
                </cmn:OrderItem>
            </cmn:OrderItemList>
            <cmn:SenderInfo>
                <cmn:FromBusinessPartyInfo>
                    <cmn:BusinessId type="DEA">712333444</cmn:BusinessId>
                    <cmn:BusinessClassification>MANUFACTURER</cmn:BusinessClassification>
                    <cmn:BusinessInfo>
                        <cmn:BusinessName>Clara Manufacturing</cmn:BusinessName>
                        <cmn:Street1>10 Welsh St</cmn:Street1>
                        <cmn:City>Malden</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>MA</cmn:StateOrRegion>
                        <cmn:PostalCode>02148</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000152</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:BusinessInfo>
                </cmn:FromBusinessPartyInfo>
                <cmn:ShipFromLocationInfo>
                    <cmn:FacilityId type="SGLN">9997777.01994.0</cmn:FacilityId>
                    <cmn:LocationInfo>
                        <cmn:BusinessName>Clara Manufacturing</cmn:BusinessName>
                        <cmn:Street1>10 Welsh St</cmn:Street1>
                        <cmn:City>Malden</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>MA</cmn:StateOrRegion>
                        <cmn:PostalCode>02148</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000152</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:LocationInfo>
                </cmn:ShipFromLocationInfo>
            </cmn:SenderInfo>
            <cmn:ReceiverInfo>
                <cmn:ToBusinessPartyLookupId type="GLN">8811891013778</cmn:ToBusinessPartyLookupId>
                <cmn:ShipToLocationInfo>
                    <cmn:FacilityId type="GLN">8811891013778</cmn:FacilityId>
                    <cmn:FacilityId type="DUNS">710040867</cmn:FacilityId>
                    <cmn:LocationInfo>
                        <cmn:BusinessName>Wilbur Pharmaceutical Imports</cmn:BusinessName>
                        <cmn:Street1>154 Broadway</cmn:Street1>
                        <cmn:City>Somerville</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>MA</cmn:StateOrRegion>
                        <cmn:PostalCode>02145</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000155</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbe</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:LocationInfo>
                    <cmn:LicenseNumber state="MA" agency="BORP">773BT8</cmn:LicenseNumber>
                    <cmn:ContactInfo>
                        <cmn:Name>Customer Service</cmn:Name>
                        <cmn:Telephone>+1-781-555-5624</cmn:Telephone>
                        <cmn:Email>support@wilburpharma.com</cmn:Email>
                    </cmn:ContactInfo>
                </cmn:ShipToLocationInfo>
            </cmn:ReceiverInfo>
            <cmn:CarrierInfo>
                <cmn:CarrierBusinessPartyInfo>
                    <cmn:BusinessId type="DEA">712333444</cmn:BusinessId>
                    <cmn:BusinessClassification>MANUFACTURER</cmn:BusinessClassification>
                    <cmn:BusinessInfo>
                        <cmn:BusinessName>Clara Manufacturing</cmn:BusinessName>
                        <cmn:Street1>10 Welsh St</cmn:Street1>
                        <cmn:City>Malden</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>MA</cmn:StateOrRegion>
                        <cmn:PostalCode>02148</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000152</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:BusinessInfo>
                </cmn:CarrierBusinessPartyInfo>
            </cmn:CarrierInfo>
        </som:OrderDetails>
        <cmn:WarehouseOperatorName>Patrick Murphy</cmn:WarehouseOperatorName>
        <som:AddReceivedItems>
            <cmn:Serial format="AI(01)+AI(21)" orderItemNumber="190">010088202501033821100000880001</cmn:Serial>
            <cmn:Serial format="AI(01)+AI(21)" orderItemNumber="190">010088202501033821100000880002</cmn:Serial>
            <cmn:Serial format="AI(01)+AI(21)" orderItemNumber="190">010088202501033821100000880003</cmn:Serial>
            <cmn:Serial format="AI(01)+AI(21)" orderItemNumber="190">010088202501033821100000880051</cmn:Serial>
        </som:AddReceivedItems>
    </som:MessageBody>
</som:SOMReceiptMessage>

 

Data Element Error Message Description
Class 1
choice%1

Missing mandatory choice. One of InternalMaterialCode OR PackagingItemCode OR CountryDrugCode is required !!!

The error occurs if cmn:InternalMaterialCode, cmn:PackagingItemCode, and cmn:CountryDrugCode are empty or null.

Only one of InternalMaterialCode OR PackagingItemCode OR CountryDrugCode is required !!!

The error occurs if more than one value is provided for cmn:InternalMaterialCode, cmn:PackagingItemCode, and cmn:CountryDrugCode.
cmn:BusinessId | @type Valid carrier business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
CarrierBusinessPartyInfo BusinessId is required when ShipToCountry is Brazil !!! The error occurs if cmn:ShipToCountry = BR, but source is empty or null.
Party type attribute is required when source FromBusinessPartyInfo/BusinessId is populated !!! The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessIdis populated, but the source is empty or null.
Party type attribute is required when source CarrierBusinessPartyLookupId is populated !!! The error occurs if cmn:CarrierBusinessPartyLookupId is populated, but the source is empty or null.
Party type attribute is required when source ToBusinessPartyInfo/BusinessId is populated !!! The error occurs if cmn:ToBusinesspartyInfo | cmn:BusinessIdis populated, but the source is empty or null.
cmn:BusinessType | @type Party type attribute is required when source FromBusinessPartyLookupId is populated !!! The error occurs if cmn:FromBusiensspartylookupId is populated, but the source is empty or null.
cmn:BusinessName BusinessName is required if FromBusinessPartyInfo is populated !!! The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
BusinessName is required if ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
BusinessName is required if ToBusinessPartyInfo is populated !!! The error occurs if cmn:ToBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
BusinessName is required if ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo | cmn:LocationInfo is populated, but the source is empty or null.
Carrier name in source cmn:BusinessName is required if cmn:BusinessInfo is populated !!! The error occurs if cmn:CarrierBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
cmn:CarrierInfo | cmn:ToBusinessPartyInfo Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId nor cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
cmn:CarrierInfo | cmn:ToBusinessPartyLookupId Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId nor cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
cmn:City City is required if CarrierBusinessPartyInfo is populated !!! The error occurs if cmn:CarrierBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
City is required if ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
City is required if ToBusinessPartyInfo is populated !!! The error occurs if cmn:ToBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
City is required if ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
City is required if FromBusinessPartyInfo is populated !!! The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
cmn:ContractType Valid Contract Type is required !!! The error occurs if source is populated, but the entry in the lookup file is invalid.
cmn:CountryCode Country is required if FromBusinessPartyInfo is populated !!!" The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
Country is required if ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
Country is required if ToBusinessPartyInfo is populated !!! The error occurs if cmn:ToBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
Country is required if ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
Country is required if CarrierBusinessPartyInfo is populated !!! The error occurs if cmn:CarrierBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
cmn:DeliveryCompleteFlag DeliveryComplete Flag required! The error occurs if the source is empty or null.
Data Error: DeliveryCompleteFlag occurs fewer times than its minimum number of occurrences The error occurs if source is not all lowercase.
cmn:FacilityId FacilityId is required when ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo is populated, but the source is empty or null.
FacilityId is required when ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo is populated, but the source is empty or null.
cmn:FacilityId | @type Party type attribute is required when source ShipToLocationInfo/FacilityId is populated !!! The error occurs if cmn:FacilityId is populated, but the source is empty or null.
Party type attribute is required when source ShipFromLocationInfo/FacilityId is populated !!! The error occurs if cmn:FacilityId is populated, but the source is empty or null.
cmn:FileControlNumber Data Error: FileControlNumber occurs fewer times than its minimum number of occurrences The error occurs if the source is empty or null.
cmn:FileDate Data Error: FileDate occurs fewer times than its minimum number of occurrences The error occurs if the source is empty or null.
cmn:FileReceiverNumber Data Error: FileReceiverNumber occurs fewer times than its minimum number of occurrences The error occurs if the source is empty or null.
cmn:FileSenderNumber Data Error: FileSenderNumber occurs fewer times than its minimum number of occurrences. The error occurs if the source is empty or null.
cmn:FileTime Data Error: FileTime occurs fewer times than its minimum number of occurrences The error occurs if the source is empty or null.
cmn:Name Contact name is required if source contactInfo is populated !!! The error occurs if the source is empty or null.
cmn:PackagingItemCode | @type Product type attribute is required when source PackagingItemCode is populated !!! The error occurs if cmn:PackagingItemCode is populated, but the source is empty or null.
Valid Item Code Type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:PostalCode PostalCode is required if FromBusinessPartyInfo is populated !!! The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
PostalCode is required if ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
PostalCode is required if CarrierBusinessPartyInfo is populated !!! The error occurs if cmn:CarrierBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
PostalCode is required if ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
PostalCode is required if ToBusinessPartyInfo is populated !!! The error occurs if cmn:ToBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
cmn:Quantity Source Quantity is required !!! The error occurs if the source is empty or null.
cmn:ReceiverInfo | cmn:ShipToLocationLookupId Only one of ShipToLocationLookupId OR ShipToLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are populated.
cmn:ReceiverInfo | cmn:ShipToLocationInfo Only one of ShipToLocationLookupId OR ShipToLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are populated.
cmn:ReceiverInfo | cmn:ToBusinessPartyInfo Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId or cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
cmn:ReceiverInfo | cmn:ToBusinessPartyLookupId Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId or cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
cmn:SenderInfo | cmn:FromBusinessPartyLookupId Only one of ShipFromLocationLookupId OR ShipFromLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are populated.
cmn:SenderInfo | cmn:FromBusinessPartyInfo Only one of ShipFromLocationLookupId OR ShipFromLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are populated.
cmn:ShipFromCountryCode Valid ShipFrom Country Code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:ShipFromLocation | @type Party type attribute is required when source ShipFromLocationLookupId is populated !!! The error occurs if cmn:ShipFromLocationLookupId is populated, but the source is empty or null.
cmn:ShipFromLocationInfo Only one of ShipFromLocationLookupId OR ShipFromLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are populated.
cmn:ShipFromLocationLookupId Only one of ShipFromLocationLookupId OR ShipFromLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are populated.
cmn:ShipToLocationLookupId | @type Party type attribute is required when source ShipToLocationLookupId is populated !!! The error occurs if cmn:ShipToLocationLookupId is populated, but the source is empty or null.
cmn:ShipToCountryCode Valid ShipTo Country Code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:StateOrRegion StateOrRegion is required if ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
State or region code is required if ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
State or region code is required if ToBusinessPartyInfo is populated !!! The error occurs if cmn:ToBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
StateOrRegion is required if FromBusinessPartyInfo is populated !!! The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
State or region code is required if CarrierBusinessPartyInfo is populated !!! The error occurs if cmn:CarrierBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
cmn:Street1 Street1 is required if CarrierBusinessPartyInfo is populated !!! The error occurs if cmn:CarrierBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
Street1 is required if ShipFromLocationInfo is populated !!! The error occurs if cmn:ShipFromLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
Street1 is required if ToBusinessPartyInfo is populated !!! The error occurs if cmn:ToBusinessPartyInfo | cmn:BusinessInfois populated, but the source is empty or null.
Street1 is required if ShipToLocationInfo is populated !!! The error occurs if cmn:ShipToLocationInfo | cmn:LocationInfois populated, but the source is empty or null.
Street1 is required if FromBusinessPartyInfo is populated !!! The error occurs if cmn:FromBusinessPartyInfo | cmn:BusinessInfo is populated, but the source is empty or null.
cmn:SupplyType Valid Supply Type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:Telephone Data Error: Telephone occurs fewer times than its minimum number of occurrences. The error occurs if the source is empty or null.
cmn:ToBusinessPartyLookupId | @type Party type attribute is required when source ToBusinessPartyLookupId is populated !!! The error occurs if cmn:ToBusinessPartyLookupId is populated, but the source is empty or null.
cmn:ToBusinessPartyLookupId | cmn:ToBusinessPartyInfo | CarrierInfo Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId nor cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!!" The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are popluated.
cmn:UnitPrice | @currencyCode Currency code is required if unit price exists !!! The error occurs if the source is empty or null.
Valid ISO currency code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
ShipToLocationLookupId/ShipToLocationInfo (cmn:ReceiverInfo) Only one of ShipToLocationLookupId OR ShipToLocationInfo group is required !!! The error occurs if both cmn:ShipToLocationLookupId and cmn:ShipToLocationInfo are populated.
snx:ControlFileHeader Data Error: ControlFileHeader occurs fewer times than its minimum number of occurrences. The error occurs if the source is empty or null.
snx:SOMReceiptMessage Unable to read input data for business object SOMReceiptMessage due to a XML Error.
som:OrderDetails OrderDetails group is required when AddReceivedItems group is populated !!! The error occurs if AddReceivedItems is populated, but source is empty or null.
cmn:ReceiverInfo | cmn:ToBusinessPartyInfo Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId nor cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.

cmn:ReceiverInfo | cmn:ToBusinessPartyLookupId

 Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither cmn:ToBusinessPartyLookupId nor cmn:ToBusinessPartyInfo are populated.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both cmn:ToBusinessPartyLookupId and cmn:ToBusinessPartyInfo are populated.
Class 2
addressee, receiving, deliveryNumber <addressee> district field for <receiving> event for delivery <deliveryNumber> must contain exactly 3 numeric digits. (addressee, "receiving", deliveryNumber) The error occurs if country = IN, but addressee is not a 3-digit numeric code.
<addressee> district field for <receiving> event for delivery <deliveryNumber> not found. (addressee, "receiving", deliveryNumber) The error occurs if country = IN, but addressee is empty or null.
CarrierBusinessPartyInfo CarrierBusinessPartyInfo lookup failed The error occurs if source lookup failed.
CarrierBusinessPartyInfo, CarrierBusinessPartyLookupId CarrierBusinessPartyInfo and CarrierBusinessPartyLookupId are both empty The error occurs if both cmn:CarrierBusinessPartyInfo and cmn:CarrierBusinessPartyLookupId are empty or null.
CarrierBusinessPartyLookupId Could not perform Company Master Data lookup to populate transportation carrier business address identifier. None of the permitted regulatory identifier types were configured in your Company Master Data. Please configure a COMPANYID, DUNS, GLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, GCP, IN_COMPANY_ID, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <ToBusinessPartyLookupId / type> <ToBusinessPartyLookupId> as appropriate for the requirement of your ship from market, and reprocess the file." The error occurs if none of the valid regulatory identifier types exist in Master Data.
ContractType ContractType for receiving event for delivery <n> contains invalid value. format(receipt.deliveryNumber) The error occurs if the source is invalid.
ContractType for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
CurrencyCode CurrencyCode for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
deliveryNumber, senderInfo, receiverInfo, shipToCountryCode, ReceiptDistributionType, SenderInfo, ReceiverInfo, TransactionDate, TransactionIdentifier Required field <x> is null (deliveryNumber, senderInfo, receiverInfo, shipToCountryCode, ReceiptDistributionType, SenderInfo, ReceiverInfo, TransactionDate, TransactionIdentifier) The error occurs if a required field is empty or null.
District District for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
District for receiving event for delivery <n> must contain exactly 3 numeric digits. format(receipt.deliveryNumber) The error occurs if source is not a 3-digit numeric code.
FromBusinessPartyInfo FromBusinessPartyInfo lookup failed The error occurs if source lookup failed.
FromBusinessPartyInfo, FromBusinessPartyLookupId FromBusinessPartyInfo and FromBusinessPartyLookupId are both empty The error occurs if both cmn:FromBusinessPartyInfo and cmn:FromBusinessPartyLookupId empty or null.
FromBusinessPartyLookupId Could not perform Master Data lookup to populate sender business address identifier. None of the permitted regulatory identifier types were configured in your Company or Partner Company Master Data. Please configure a COMPANYID, DUNS, GLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, GCP, IN_COMPANY_ID, IN_LOCATION_ID, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <FromBusinessPartyLookupId / type> <FromBusinessPartyLookupId> as appropriate for the requirement of your ship to market, and reprocess the file. The error occurs if none of the valid regulatory identifier types exist in Master Data.
idTyp Ship From Location LookupId type is empty The error occurs if the source is empty or null.
Ship To Location LookupId type is empty
From Business Party LookupId type is empty
To Business Party LookupId type is empty
idVal To Business Party LookupId value is empty The error occurs if the source is empty or null.
From Business Party LookupId value is empty
Ship From Location LookupId value is empty
Ship To Location LookupId value is empty
inFilename, origFilename, origFilename, origFileDate, cntrlID File <inFilename> is a potential duplicate match with file <origFilename> sent from <origFilename> received on <origFileDate>, based on both files having the same File Control Number <cntrlID>. The error occurs if file is a duplicate.
InternalMaterialCode or PackagingItemCode Either InternalMaterialCode or PackagingItemCode must be provided. The error occurs if both cmn:InternalMaterialCode and cmn:PackagingItemCode are empty or null.
lookupTyp, lookupVal Could not perform Master Data lookup to populate sender business address fields. <lookupTyp> <lookupVal> is not configured in your Company or Partner Master Data. Please configure <lookupTyp> <lookupVal> in Company or Partner Master Data, and reprocess the file. (lookupType, lookupVal, lookupType, lookupVal) The error occurs if the lookupTyp and lookupVal for Company or Partner Master Data has not been configured.
Could not perform Master Data lookup to populate the sender shipping address identifier. None of the permitted regulatory identifier types were configured in your Company or Partner Location Master Data. Please configure a COMPANYSITEID, DEA, DUNS4, GLN, HIN, SGLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, CUIT, HIN, GCP, IN_LOCATION_ID, IN_IEC, IN_PAN, IN_TIN, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <lookupTyp> <lookupVal> as appropriate for the requirement of your ship from market, and reprocess the file. (lookupType, lookupVal) The error occurs if no valid lookupTyp and lookupVal were configured to populate the sender shipping address identifier.
Could not perform Location Master Data lookup to populate the receiving address identifier. None of the permitted regulatory identifier types were configured in your Company nor Partner Location Master Data. Please configure a COMPANYSITEID, DEA, DUNS4, GLN, HIN, SGLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, CUIT, HIN, GCP, IN_LOCATION_ID, IN_IEC, IN_PAN, IN_TIN, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <lookupTyp> <lookupVal> as appropriate for the requirement of your ship to market, and reprocess the file. (lookupType, lookupVal) The error occurs if no valid lookupTyp and lookupVal were configured to populate the receiving address identifier.
Could not perform Master Data lookup to populate transportation carrier business address identifier. None of the permitted regulatory identifier types were configured in your Company or Partner Company Master Data. Please configure a COMPANYID, CUIT, DUNS, GLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REGGCP, IN_COMPANY_ID, IN_IEC, IN_PAN, IN_TIN, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <lookupTyp> <lookupVal> as appropriate for the requirement of your ship from market, and reprocess the file. (lookupType, lookupVal) The error occurs if no valid lookupTyp and lookupVal were configured to populate the transportation carrier business address identifier.
Could not perform Company Master Data lookup to populate receiver business address identifier. None of the permitted regulatory identifier types were configured in your Company Master Data. Please configure a COMPANYID, CUIT, DUNS, GLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REGGCP, IN_COMPANY_ID, IN_IEC, IN_PAN, IN_TIN, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <lookupTyp> <lookupVal> as appropriate for the requirement of your ship to market, and reprocess the file. (lookupType, lookupVal) The error occurs if no valid lookupTyp and lookupVal were configured to populate the receiver business address identifier.
Could not perform Master Data lookup to populate sender business address identifier. None of the permitted regulatory identifier types were configured in your Company or Partner Company Master Data. Please configure a COMPANYID, CUIT, DUNS, GLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, GCP, IN_COMPANY_ID, IN_IEC, IN_PAN, IN_TIN, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <lookupTyp> <lookupVal> as appropriate for the requirement of your ship to market, and reprocess the file. (lookupType, lookupVal) The error occurs if no valid lookupTyp and lookupVal were configured to populate the sender business address identifier.
Could not perform Company Master Data lookup to populate receiver business address fields. <lookupTyp> <lookupVal> is not configured in your Company Master Data. Please configure <lookupTyp> <lookupVal> in Company Master Data, and reprocess the file. (lookupType, lookupVal, lookupType, lookupVal) The error occurs if lookupTyp and lookupVal for Company Master Data have not been configured.
Could not perform Master Data lookup to populate sender shipping address fields. <lookupTyp> <lookupVal> is not configured in your Company or Partner Location Master Data. Please configure <lookupTyp> <lookupVal> in Company or Partner Location Master Data, and reprocess the file. (lookupType, lookupVal, lookupType, lookupVal) The error occurs if lookupTyp and lookupVal for Company or Partner Master Data have not been configured.
Could not perform Location Master Data lookup to populate receiver shipping address fields. <lookupTyp> <lookupVal> is not configured in your Company Location Master Data nor in your Partner Location Master Data. Please configure <lookupTyp> <lookupVal> in Company Location Master Data or in Partner Location Master Data (if the ship to location is a partner location) and reprocess the file. (lookupType, lookupVal, lookupType, lookupVal) The error occurs if lookupTyp and lookupVal for Company or Partner Location Master Data have not been configured.
Could not perform Master Data lookup to populate transportation carrier business address fields. <lookupTyp> <lookupVal> is not configured in your Company or Partner Company Master Data. Please configure <lookupTyp> <lookupVal> in Company or Partner Company Master Data, and reprocess the file. (lookupType, lookupVal,lookupType, lookupVal) The error occurs if lookupTyp and lookupVal for Company or Partner Master Data have not been configured.
message message body is null The error occurs if the source is empty or null.
OrderItemList OrderItemList for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
OrderItems OrderItems for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
Quantity Quantity is required if IsSerialized = false The error occurs if IsSerialized = false, but source is empty or null.
ReceiptDistributionType For Receipt <DeliveryNumber>, receipt serials was not found. The error occurs if the source was not previously submitted
ReceiverInfo Serialized Operations Manager Receipt inbound processing could not be completed. The ReceiverInfo with either ToBusinessPartyLookupId or ToBusinessPartyInfo for the ShipFromCountryCode of <ShipFromCountryCode> and ShipToCountryCode of <ShipToCountryCode> must be specified.

The error occurs if

  • Transfer or Sale occurs in non-EU FMD markets where the ShipToCountryCode is not an EU FMD country and the ShipFromCountryCode is not an EU FMD country.
  • Transfer or Sale Export occurs from the EU FMD markets where the ShipToCountryCode is China, US, South Korea, or Russia and the ShipFromCountryCode is an EU FMD country.
ReceiverInfo Serialized Operations Manager Receipt inbound processing could not be completed. Both the ShipToCountryCode and ShipFromCountryCode must be specified when the Sender Info and ReceiverInfo are not specified. The error occurs if ReceiverInfo and the source are both empty or null, and both the ShipToCountryCode and ShipFromCountryCode are empty or null.
SenderInfo
SenderInfo Serialized Operations Manager Receipt inbound processing could not be completed. The SenderInfo with either FromBusinessPartyLookupId or FromBusinessPartyInfo for the ShipFromCountryCode of <ShipFromCountryCode> and ShipToCountryCode of <ShipToCountryCode>.

The error occurs if

  • Transfer or Sale occurs in non-EU FMD markets where the ShipToCountryCode is not an EU FMD country and the ShipFromCountryCode is not an EU FMD country.
  • Transfer or Sale Export occurs from the EU FMD markets where the ShipToCountryCode is China, US, South Korea, or Russia and the ShipFromCountryCode is an EU FMD country.
serialNumber Serial Number <n> does not exist. (serial number) The error occurs if the source provided does not exist.
Cannot perform operation on serial number <n> with item state PendingReceipt. This operation can only be performed when the serial number is Available. (serial number) The error occurs if source is still in a pending state.
ShipFromLocationLookupId Could not perform Master Data lookup to populate the sender shipping address identifier. None of the permitted regulatory identifier types were configured in your Company or Partner Location Master Data. Please configure a COMPANYSITEID, DEA, DUNS4, GLN, HIN, SGLN, BR_CPF, BR_CNES, BR_CNPJ or BR_PROF_REG, HIN, GCP, IN_LOCATION_ID, KR_BUS_REG_NUMBER, KR_PROVIDER_CODE for <ShipFromLocationLookupId / type> <ShipFromLocationLookupId> as appropriate for the requirement of your ship from market, and reprocess the file. The error occurs if none of the valid regulatory identifier types exist in Master Data.
ShipToLocationInfo ShipToLocationInfo lookup failed The error occurs if source lookup failed.
ShipToLocationInfo, ShipToLocationLookupId ShipToLocationInfo and ShipToLocationLookupId are both empty The error occurs if both cmn:ShipToLocationInfo and cmn:ShipToLocationLookupId are empty or null.
ShipToLocationLookupId Could not perform Location Master Data lookup to populate the receiving address identifier. None of the permitted regulatory identifier types were configured in your Company nor Partner Location Master Data. Please configure a COMPANYSITEID, DEA, DUNS4, GLN, HIN , SGLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, HIN, GCP, IN_LOCATION_ID, KR_BUS_REG_NUMBER, or KR_PROVIDER_CODE for <ShipToLocationLookupId / type> <ShipToLocationLookupId> as appropriate for the requirement of your ship to market, and reprocess the file. The error occurs if none of the valid regulatory identifier types exist in Master Data.
SupplyType SupplyType for receiving event for delivery <n> contains invalid value. format(receipt.deliveryNumber) The error occurs if the source is invalid.
SupplyType for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
ToBusinessPartyInfo ToBusinessPartyInfo lookup failed The error occurs if source lookup failed.
ToBusinessPartyInfo, ToBusinessPartyLookupId ToBusinessPartyInfo and ToBusinessPartyLookupId are both empty The error occurs if both cmn:ToBusinessPartyInfo and cmn:ToBusinessPartyLookupId are empty or null.
ToBusinessPartyLookupId Could not perform Company Master Data lookup to populate receiver business address identifier. None of the permitted regulatory identifier types were configured in your Company Master Data. Please configure a COMPANYID, DUNS, GLN, BR_CPF, BR_CNES, BR_CNPJ, BR_PROF_REG, GCP, KR_BUS_REG_NUMBER for <ToBusinessPartyLookupId / type> <ToBusinessPartyLookupId> as appropriate for the requirement of your ship to market, and reprocess the file. The error occurs if none of the valid regulatory identifier types exist in Master Data.
UnitPrice UnitPrice for receiving event for delivery <n> not found. format(receipt.deliveryNumber) The error occurs if the required source is missing or null.
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.

Receipt (EPCIS v1.2)

To receive both shipment information and serial numbers in this message, all shipment data must originate from the same system. If shipment information and serial numbers must be received separately (e.g. because shipment information is managed in a separate ERP system), use a combination of this message and the Receipt (XML) message (i.e. submit the Receipt (XML) message containing the shipment information and set the DeliveryComplete flag to "false", and then submit the Receipt (EPCIS v1.2) message containing the Delivery Number and list of EPCs.

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

Message Type: SOM_RECEIPT

Info Exchange Display Name: Shipment Receipt

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.

Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *61
  @creationDate [1…1]
[1/*]		 DateTime Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *62
  EPCISHeader [0…1]
[-]		 - Required. The XML file control header. Only receiving event is supported: no aggregation.
    sbdh:StandardBusinessDocumentHeader [1…1]
[-]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1…1]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *63
      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]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *64

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.
          @Authority [1…1]
[1/*]		 String 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. *65

See the BusinessAndLocationId 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]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *66

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.
          @Authority [1…1]
[1/*]		 String 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.  *67

See the BusinessAndLocationId enumeration list for valid values.
      sbdh:DocumentIdentification [1…1]
[-]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *68
        sbdh:TypeVersion [1…1]
[0/*]		 String 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. *69
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String 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. *70
        sbdh:Type [1…1]
[0/*]		 String Required. This element identifies the document type. The Type value is set to "Events".  *71
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime 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. *72
    extension [0…1]
[-]		 - Header extension area with master data attributes.
      EPCISMasterData [0…1]
[-]		 - Master data extension header. May contain business and ship party address information.

If there is no partner address data in the header extensions, the identifiers in the Source and Destination lists is used for partner master data lookup by TraceLink.

Full GS1 conformance requires that all party master data be stored in the EPCIS header extension EPCISMasterData / VocabularyList / Vocabulary / VocabularyElementList / VocabularyElement. It is strongly urged that all party address info for receiving events be sent in the VocabularyElement within the EPCISMasterData header extension.
        VocabularyList [1…1]
[-]		 - Required. Vocabulary list group master data elements.
          Vocabulary [0…*]
[-]		 - Looping vocabulary element with discrete partner master data element groups. Vocabulary occurs once each for sold from, ship from, sold to, ship to parties present. Group is optional. If it does not appear in master data header extension, no error will be thrown.
            @type [1…1]
[0/*]		 String Required. Vocabulary type identifying location master data elements for receiving events. Master data type defined by VocabularyElement | @id.  *73

Valid value: urn:epcglobal:epcis:vtype:Location = location master data.

Track the sold from, ship from, sold to, and ship to for receiving event in header master data. Party data in receiving event is mapped from header master in Vocabulary.
            VocabularyElementList [0…1]
[-]		 - List of vocabulary elements that includes all partner master information. Party identifiers and address info are stored in instances of the looping group VocabularyElement.
              VocabularyElement [1…*]
[-]		 - Required. Looping group header for data elements identifying all business party and location master data, including identifiers, identifier types, and address info. VocabularyElement repeats once for each party type:
  • Sold/Transfer from business party (mandatory).
  • Ship-from location (optional).
  • Sold/Transfer to business party (mandatory) .
  • Ship-to location (optional).
  • Carrier (Brazil) (optional).
  • Master data lookup is supported. If partner master data is available in TraceLink, indicate master data lookup by sending partner identifiers in the sourceList and destinationList of the receiving event and do not include any address data in any VocabularyElement group.
  • If master data lookup is not intended, send complete address information for at least the sold-from and sold-to partners in the header master data extension. Ship-from and ship-to addresses can also be included.
                @id [1…1]
[0/*]		 String Required. SGLN or other partner identifier and type for party master data in VocabularyElement. Must match sourceList or destinationList owning or location party in receiving event from either:
  • ObjectEvent | extension | sourceList | source (transfer from, carrier)
  • ObjectEvent | extension | destinationList | destination (transfer to)

The identifier value is required for regulatory reporting.  *74

See the MDPartyTypeAttributes enumeration list for valid values.
                attribute [1…1]
[0/*]		 String Conditionally required if the above Vocabulary | @id attribute is populated. Looping Name/Value pairs identifying partner address master data elements. This is the value element in the Name/Value pair attribute | @id. Stores master data item value defined by @id.  *75

Partner master data items currently supported for receiving event:

  • Business name
  • Additional identifier
  • Additional identifier type
  • Business classification
  • Street address 1 & 2
  • City
  • District
  • Village
  • House Number
  • Township
  • Corporate Fax
  • State/Province/Region
  • Postal code
  • Country code
  • Premises code
  • Tax registration code
Create one instance of the Name/Value pair attribute and @id for each master data element returned.
                  @id [1…1]
[0/*]		 String Conditionally required if the above attribute element is populated. Provides the name in the Name/Value pair attribute | @id). Identifies the master data value stored in the attribute value element, using urn or http prefix.  *76

Valid values:

  • http://epcis.tracelink.com/mda/additionalPartyIdentificationValue

  • http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode

  • http://epcis.tracelink.com/mda/AddressObjectGUID
  • http://epcis.tracelink.com/mda/district
  • http://epcis.tracelink.com/mda/village
  • http://epcis.tracelink.com/mda/houseNumber
  • http://epcis.tracelink.com/mda/township
  • http://epcis.tracelink.com/mda/corporateFax
  • http://epcis.tracelink.com/mda/HouseGUID
  • http://epcis.tracelink.com/mda/partyRoleCode
  • http://epcis.tracelink.com/mda/premisesCode
  • http://epcis.tracelink.com/mda/taxRegistrationCode
  • urn:epcglobal:cbv:mda#name
  • urn:epcglobal:cbv:mda#streetAddressOne
  • urn:epcglobal:cbv:mda#streetAddressTwo
  • urn:epcglobal:cbv:mda#streetAddressThree
  • urn:epcglobal:cbv:mda#city
  • urn:epcglobal:cbv:mda#state
  • urn:epcglobal:cbv:mda#postalCode
  • urn:epcglobal:cbv:mda#countryCode
  EPCISBody [1…1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1…1]
[-]		 - Required. The EventList only contains the ObjectEvent (required).
      ObjectEvent [1…*]
[-]		 - Required. EventList. Data = "ObjectEvent" for receiving events when all of the following is true:
  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:receiving
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of the date/time when the event occurred. Include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1].  *77
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1].  *78
        epcList [1…1]
[-]		 - Required. List of the EPCs of top most containers (e.g. pallets, cases) in the shipment.
          epc [1…*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format.  *79
        action [1…1]
[0/*]		 String Required. This field indicates the action taken in the message. The action value is set to OBSERVE for a receiving event.  *80

See the ActionType enumeration list for valid values.
        bizStep [0…1]
[0/*]		 AnyURI Required. This value indicates the business step taken in the event. The bizStep value is set to urn:epcglobal:cbv:bizstep:receiving for a receiving event.  *81
        disposition [0…1]
[0/*]		 AnyURI Required. The bizStep, disposition, and action elements define the message event and are grouped together under the GS1 EPCIS guidelines. The disposition indicates the status of the transaction. The disposition value is set to urn:epcglobal:cbv:disp:in_progress for a receiving event.  *82
        readPoint [0…1]
[-]		 - Not used.
          id [1…1]
[0/*]		 AnyURI Not used.
        bizLocation [0…1]
[-]		 - Not used.
          id [1…1]
[1/*]		 AnyURI Not used.
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizStep = urn:epcglobal:cbv:bizstep:receiving.
          bizTransaction [1…*]
[0/*]		 AnyURI Required. The business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or the Return and/or Purchase Order governing this shipment, subject to Section 8.4.2 of [CBV1.0].  *83

Delivery document is mandatory in the receiving transaction. All other document types are optional.
            @type [1…1]
[1/*]		 String Required. The transaction identifier type (e.g. PO, ASN, RETURN, etc).  *84

See the TransactionId enumeration list for valid values.
            @date [0...1]
[0/*]		 Date Conditionally required if tl:shipFromCountryCode = RU. The transaction identifier date. *85
        tl:locationId [0...1]
[-]		 String Serialized Operations Manager external subscriber location identifier.

When an external Serialized Operations Manager subscriber submits messages, TraceLink uses the subscriber company integration user to perform the action and log this message in the audit trail, so that all messages executed by that subscriber are attributed to that company.
        extension [0…1]
[-]		 - GS1 ObjectEvent extension.
          sourceList [0…1]
[-]		 - Conditionally required if partner master data for transfer from party/location is populated in header extension VocabularyElement. Source list identifying sending and carrier parties identified in header extensions level.

If Master Data exists in the Tracelink system, then master data lookup is supported. To use master data lookup, do not send any partner address info in the EPCIS header master data extension. Only send the partner identifiers in sourceList and destinationList.

TraceLink reads the party identifiers from sourceList and destinationList to run the master data lookup. Do not send partner identifiers and address info in the master data header.

  • If partner master data is present in the header, the system will map from the header. Partner identifiers must match the partner identifiers in the sourceList and destinationList.
  • If the partner master data header, sourceList, and destinationList are not populated, an error occurs.
            source [1…*]
[0/*]		 String Required. Source party identifier for sold-from, ship-from, or carrier parties. Must match same partner identifiers in header extension VocabularyElement.  *86

Used for master data lookup if partner identifier and address info is not present in header master data.

If ship-from party is the same as sold-from party, ship-from does not need to be included.
              @type [1…1]
[0/*]		 String Required. Identifies type of source party identifier, ie, owning (sold-from) or location (ship-from) party. Valid values:  *87
  • Sold-from party = urn:epcglobal:cbv:sdt:owning_party (mandatory).
  • Ship-from party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
          destinationList [0…1]
[-]		 - Conditionally required if partner master data for transfer from party/location is populated in header extension VocabularyElement. Destination list identifying receiving parties identified in header extensions level.

If Master Data exists in the Tracelink system, master data lookup is supported. To use master data lookup, do not send any partner address info in the EPCIS header master data extension. Only send the partner identifiers in destinationList and sourceList.

TraceLink reads the party identifiers from destinationList and sourceList to run master data lookup. Do not send partner identifiers and address info in the master data header.

  • If partner master data is present in the header, the system will map from the header. Partner identifiers must match the partner identifiers in the sourceList and destinationList.
  • If the partner master data header, sourceList, and destinationList are not populated, an error occurs.
            destination [1…*]
[0/*]		 String Required. Destination party identifier for sold-to and ship-to parties. Must match same partner identifiers in header extension VocabularlyElement.  *88

Used for master data lookup if partner identifier and address info is not present in header master data.

If ship-to party the same as sold-to party, ship-from does not need to be included.
              @type [1…1]
[0/*]		 String Required. Identifies type of destination party identifier, i.e. owning (sold-to) or location (ship-to) party. Valid values:  *89
  • Sold-to party = urn:epcglobal:cbv:sdt:owning_party (mandatory).
  • Ship-to party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
        tl:receivingEventExtensions [0…1]
[-]		 - Receiving event with the list of serial numbers being received from supplier's shipment.
          tl:transactionDate [1…1]
[-]		 Date Required. Date associated with the business transaction document in bizTransactionList in YYYY-MM-DD format. This date may or may not be the same as the eventTime.  *90
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. 2-letter ISO country code for ship-to country. This value is referenced to advise regulatory reporting if it is required for the specified country market.  *91
Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.

See the ISOCountryCode enumeration list for valid values.
          tl:shipFromCountryCode [0…1]
[2/2]		 String 2-letter ISO country code for ship-from country. This value is referenced to advise regulatory reporting if it is required for the specified country market.  *92
Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.

See the ISOCountryCode enumeration list for valid values.
          tl:receiptDistributionType [1…1]
[1/*]		 String Required. Informs what types of regulatory reporting may be triggered based on the nature of the transaction:  *93
  • Purchase, transfer, or return within the same country.
  • Purchase, transfer, or return from another country.

See the ReceiptDistributionType enumeration list for valid values.
          tl:supplyType [0…1]
[0/*]		 String Conditionally required if ShipToCountryCode = KR and SalesDistributionType = EXPORTSALE or EXPORTRETURN; all values except for Collection apply. Identifies the type of supply that is being performed.  *94

See the SupplyType enumeration list for valid values.
          tl:contractType [0…1]
[0/*]		 String Identifies if a private or competitive bid contract is used for the sale of goods.

See the ContractType enumeration list for valid values.
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with the delivery.
          tl:contractNumber [0...1]
[0/*]		 String Identification number of the contract. *95
          tl:fundingSource [0...1]
[0/*]		 String Required. Source of the funding. *96

See the FundingSource enumeration list for valid values.
          tl:registerUnknownSNs [0…1]
[0/*]		 Boolean Determines whether the serial numbers that are unknown to SOM (in tl:epcOrderItemList) should be registered. Valid values: *97
  • true – register all serial numbers that do not currently exist in Serialized Operations Manager in an available state.
  • false – (default) all serial numbers that do not currently exist in Serialized Operations Manager are rejected.
          tl:transferWithoutShipment [0…1]
[0/*]		 Boolean

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state.
  • false (default) – Serial numbers are in the Pending Receipt state.

Only use when tl:receiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
          tl:entryPort [0...1]
[0/*]		 String

Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
          tl:exitPort [0...1]
[0/*]		 String

Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
          tl:deliveryInspection [0...1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.
          tl:deliveryInspectionDate [0...1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *98
          tl:deliveryInspectionNote [0...1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
          tl:removalFromCirculation [0...1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
          tl:aggregationInspection [0...1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
          tl:epcOrderItemDetails [0…1]
[-]		 - Group header with specific link between tl:orderItemNumber in the ObjectEvent for Shipping Events and the epc serial number.
            tl:epcOrderItemList [1…*]
[-]		 - Group header.
              @orderItemNumber [0…1]
[0/*]		 String List of serial numbers associated with the pricing and tax information in the current instance of the orderItem.
              tl:epcOrderItem [1…*]
[0/*]		 String Order item number attribute associating specific serial numbers to the price, VAT, and cost taxes reported in a specific instance of OrderItem, in EPC Pure Identity URI format.
          tl:orderItemList [0…1]
[-]		 - Populate the order item list group to communicate the return quantities for each item code at the EACH (unit) level.
            tl:allowShortVerificationCount [0…1]
[0/*]		 Boolean Instructs TraceLink whether or not to generate an error if the picked or received counts are less than expected when comparing picked or received serial number counts in tl:epcOrderItemList. Valid values: *99
  • true – instructs TraceLink to generate an error if the picked or received counts are less than expected.
  • false – (default) TraceLink does not generate an error if the picked or received counts are less than expected.
            tl:orderItem [1…*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number, and quantity for each item in the order. Communicate each unique item code and lot number in a separate order item group.
              tl:orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers to the price, VAT, and cost taxes reported in a specific instance of tl:orderItem.
              choice%1 [1…1]
[-]		 Choice

Required. Populate only one of tl:InternalMaterialCode, tl:PackagingItemCode, or tl:countryDrugCode. One of the three options must be present.

              tl:internalMaterialCode [0…1]
[1/*]		 String Conditionally required if neither tl:packagingItemCode nor tl:countryDrugCode is present. Option 1 for choice%1 in tl:orderItem. Use to identify the product using the internal material number configured in Product Master Data.  *100
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:countryDrugCode is present. Option 2 for choice%1 in tl:orderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data.  *101
                @type [0…1]
[0/*]		 String Required. The product code type for the packaging item code.

See the ItemCode enumeration list for valid values.
              tl:countryDrugCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:packagingItemCode is present. Option 3 for choice%1 in OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *102
                @type [0…1]
[0/*]		 String Required. The national drug code type using the supported enumeration values. *103
              cbvmda:lotNumber [0…1]
[0/*]		 String The lot or batch code for the picked items (if available) in an alphanumeric string.  *104
              cbvmda:itemExpirationDate [0…1]
[1/*]		 Date The expiration date for the serialized item, formatted in YYYY-MM-DD format.  *105
              tl:quantity [1…1]
[0/*]		 String Required. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked.  *106
              tl:unitPrice [0…1]
[0/*]		 Decimal Required.Conditionally required if:

Unit price of item.  *107
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format.  *108

See the ISOCurrency enumeration list for valid values.
              tl:vat [0...1]
[-]		 Decimal Value Added Tax per unit. *109
                @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *110

See the ISOCurrency enumeration list for valid values.
              tl:grossPrice [0...1]
[0/*]		 Decimal Price including unit price and all taxes and fees.  * *111
                @currencyCode [1...1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *112

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is not serialized.  *113
If omitted, defaults value to "true".
              tl:transactionIdentifier [0...*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present.
                @type [1...1]
[1/*]		 String Required. The transaction identifier type. Valid values:
  • DESTRUCTION
  • INVOICE
  • NOTAFISCALELETRONICA
  • OTHER
  • PO
  • RETURN
                @date [0...1]
[0/*]		 Date Conditionally required if tl:shipToCountryCode = RU. The transaction identifier date.
          tl:warehouseOperatorName [0…1]
[0/*]		 String Name of the person responsible for warehouse operations.  *114
          tl:correctiveReceipt [0…1]
[0/*]		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • true – The receipt is a corrective receipt.
  • false – (default) The receipt is not a corrective receipt.
          tl:originalDeliveryNumber [0…1]
[0/*]		 String Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt. 

<?xml version="1.0" encoding="UTF-8"?>
<epcis:EPCISDocument xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:gs1ushc="http://epcis.gs1us.org/hc/ns" 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="2018-06-12T06:31:32Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8779891013658</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8811891013778</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>201806121745200001</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2018-06-12T06:31:32Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    <extension>
        <EPCISMasterData>
            <VocabularyList>
                <Vocabulary type="urn:epcglobal:epcis:vtype:Location">
                    <VocabularyElementList>
                    <!-- SourceList owning_party (sold from business party) -->
                        <VocabularyElement id="urn:epc:id:sgln:9997777.01994.0">
                            <attribute id="urn:epcglobal:cbv:mda#name">Clara Manufacturing</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationValue">712333444</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode">DEA</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/partyRoleCode">MANUFACTURER</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#streetAddressOne">10 Welsh St</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#city">Malden</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/district"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/village"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/houseNumber"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/township"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/corporateFax"></attribute>
                            <attribute id="urn:epcglobal:cbv:mda#state">MA</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#postalCode">02148</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#countryCode">US</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/premisesCode"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/taxRegistrationCode"></attribute>
                        </VocabularyElement>
                    <!-- DestinationList owning_party (sold to business party) -->
                        <VocabularyElement id="urn:epc:id:gln:8811891013778">
                            <attribute id="urn:epcglobal:cbv:mda#name">Wilbur Pharmaceutical</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationValue">412333444</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode">DEA</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/partyRoleCode">DISTRIBUTOR</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#streetAddressOne">154 Broadway</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#city">Somerville</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/district"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/village"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/houseNumber"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/township"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/corporateFax"></attribute>
                            <attribute id="urn:epcglobal:cbv:mda#state">MA</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#postalCode">02145</attribute>
                            <attribute id="urn:epcglobal:cbv:mda#countryCode">US</attribute>
                            <attribute id="http://epcis.tracelink.com/mda/premisesCode"></attribute>
                            <attribute id="http://epcis.tracelink.com/mda/taxRegistrationCode"></attribute>
                        </VocabularyElement>
                    </VocabularyElementList>
                </Vocabulary>
            </VocabularyList>
        </EPCISMasterData>
    </extension>
</EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2018-06-12T06:31:32Z</eventTime>
                <eventTimeZoneOffset/>
                <epcList>
                    <epc>urn:epc:id:sscc:425093.05100564312</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564329</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564336</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564343</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564350</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564367</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564374</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564381</epc>			
                    <epc>urn:epc:id:sscc:425093.05100564398</epc>	
                </epcList>
                <action>OBSERVE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:receiving</bizStep>
                <disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
                <bizTransactionList>
                    <bizTransaction type="http://epcis.tracelink.com/hc/btt/transfer" date="2018-06-12">urn:epcglobal:cbv:bt:8779891013658:987654321</bizTransaction>
                    <bizTransaction type="urn:epcglobal:cbv:btt:desadv" date="2018-06-12">urn:epcglobal:cbv:bt:8811891013778:ASN654321</bizTransaction>
                </bizTransactionList>
                <tl:locationId>urn:epc:id:sgln:9997777.01994.0</tl:locationId>
                <extension>
                    <sourceList>
                    <!-- owning_party = from business party -->
                        <source type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:9997777.01994.0</source>
                    </sourceList>
                    <destinationList>
                    <!-- owning_paty = to business party -->
                        <destination type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:881189.101377.8</destination>
                    </destinationList>
                </extension>
                <tl:receivingEventExtensions>
                    <tl:transactionDate>2018-06-12</tl:transactionDate>
                    <tl:shipToCountryCode>US</tl:shipToCountryCode>
                    <tl:receiptDistributionType>INCOUNTRYPURCHASE</tl:receiptDistributionType>
                    <tl:supplyType>PatientDistribution</tl:supplyType>
                    <tl:contractType>PrivateContract</tl:contractType>
                    <tl:comments>Wilbur Processing</tl:comments>
                    <tl:contractNumber>C102</tl:contractNumber>
                    <tl:fundingSource>OwnFunds</tl:fundingSource>
                    <tl:transferWithoutShipment>false</tl:transferWithoutShipment>
                    <tl:entryPort></tl:entryPort>
                    <tl:exitPort></tl:exitPort>
                    <tl:epcOrderItemDetails>
                        <tl:epcOrderItemList orderItemNumber="205">
                            <tl:epcOrderItem>urn:epc:id:sscc:425093.05100564312</tl:epcOrderItem>
                            <tl:epcOrderItem>urn:epc:id:sscc:425093.05100564329</tl:epcOrderItem>
                        </tl:epcOrderItemList>
                    </tl:epcOrderItemDetails>
                    <tl:orderItemList>
                        <tl:orderItem>
                            <tl:orderItemNumber>205</tl:orderItemNumber>
                            <tl:packagingItemCode type="GTIN-14">00992326050107</tl:packagingItemCode>
                            <cbvmda:lotNumber>PPP555</cbvmda:lotNumber>
                            <cbvmda:itemExpirationDate>2020-06-12</cbvmda:itemExpirationDate>
                            <tl:quantity>500</tl:quantity>
                            <tl:unitPrice currencyCode="USD">50.43</tl:unitPrice>
                            <tl:vat currencyCode="USD">10.45</tl:vat>
                            <tl:grossPrice currencyCode="USD">100.00</tl:grossPrice>
                            <tl:isSerialized>true</tl:isSerialized>
                            <tl:transactionIdentifier type="PO" date="2018-06-12">TI008</tl:transactionIdentifier>
                        </tl:orderItem>
                    </tl:orderItemList>
                    <tl:warehouseOperatorName>Patrick Murphy</tl:warehouseOperatorName>
		     <tl:correctiveReceipt>true</tl:correctiveReceipt>
		     <tl:originalDeliveryNumber>6</tl:originalDeliveryNumber>				
                    </tl:receivingEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>

Data Element Error Message Description
Class 1
attribute Carrier business party city is required !!! The error occurs if the source is empty or null.
attribute Carrier business party state or region is required !!!
attribute Carrier business party country is required !!!
attribute Carrier business party street address is required !!!
attribute Ship from location state or region is required !!!
attribute Ship from location street address is required !!!
attribute Ship from location city is required !!! The error occurs if the source is empty or null.
attribute Ship from location country is required !!!
attribute Ship to location country is required !!!
attribute Ship to location city is required !!!
attribute Ship to location street address is required !!!
attribute Ship to location state or region is required !!!
attribute Sold from business party state or region is required !!!
attribute Sold from business party street address is required !!!
attribute Sold from business party city is required !!!
attribute Sold from business party country is required !!!
attribute Sold from business party name is required !!!
attribute Sold to business party city is required !!!
attribute Sold to business party country is required !!!
attribute Sold to business party state or region is required !!!
attribute Sold to business party street address is required !!!
attribute Valid business classification code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
attribute Valid business classification code is required !!!
attribute Valid Carrier business party country is required !!!
attribute Valid carrier business party identifier type is required !!!
attribute Valid Ship to location country is required !!!
attribute Valid ship to location identifier type is required !!!
attribute Valid ship from location identifier type is required !!!
attribute Valid Ship from location country is required !!!
attribute Valid sold from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
attribute Valid Sold to business party country is required !!!
attribute Valid sold to business party identifier type is required !!!
attribute Valid Sold from business party country is required !!!
attribute Carrier business party name is required !!! The error occurs if VocabularyElement/attribute fields are populated, but the source is empty or null.
attribute Ship to business party name is required !!!
attribute Ship from business party name is required !!!
attribute Sold to business party name is required !!!
attribute Party type is required if additional business party identifier is populated !!! The error occurs if @id (attribute) = "http://epcis.tracelink.com/mda/additionalIdentifier", but the source is empty or null.
attribute Party type is required if additional facility identifier is populated !!!
@currencyCode Valid ISO currency code is required !!! The error occurs if tl:unitPrice is populated, but the source is not a valid value from the enumeration list.
bizStep bizStep urn:epcglobal:cbv:bizstep:receiving is required for ObjectEvent receiving !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:receiving".
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if bizTransaction is populated, but the source is empty or null.
bizTransactionList Biz transaction list is required in receiving event !!! The error occurs if the source is empty or null.
choice1 Only one of either InternalMaterialCode or PackagingItemCode or CountryDrugCode is required !!!

The error occurs if tl:internalMaterialCode, tl:packagingItemCode, and tl:countryDrugCode are empty or null.
destination Valid sold-to business lookup identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid ship-to business lookup identifier type is required !!!
disposition Dispositio​n urn:epcglobal:cbv:disp:in_progress is required for ObjectEvent receiving !!! The error occurs if the source does not equal "urn:epcglobal:cbv:disp:in_progress".
epc Invalid EPC format !!! The error occurs if the source is invalid.
ObjectEvent Receiving event is required !!! The error occurs if the source is empty or null.
source Valid carrier business lookup identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid sold-from business lookup identifier type is required !!!
Valid ship-from business lookup identifier type is required !!!
tl:packagingItemCode | @type Packaging item code type is required !!! The error occurs if tl:packagingItemCode is populated, but the source is empty or null or there is not a valid value from the enumeration list.
tl:quantity Quantity is required !!! The error occurs if the source is empty or null or is equal to "0".
tl:receiptDistributionType Valid receipt distributionType is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
tl:receivingEventExtensions receivingEventExtensions required if receiving event populated !!! The error occurs if ObjectEvent is populated, but the source is empty or null.
tl:shipFromCountryCode Valid ISO country code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Ship from country for import products is required !!! The error occurs if ReceiptDistributionType equals "IMPORTSALE", "IMPORTTRANSFER", or "IMPORTRETURN" but the source is empty or null.
tl:shipToCountryCode Valid ISO country code for ship-to country is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
tl:supplyType Valid supply type code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:transactionDate Transaction date is required !!! The error occurs if the source is empty or null.
VocabularyElement Ship to party info required in VocabularyElement if present in destinationList !!! The error occurs if ship-to is present in destinationList but not in the source.
Sold to party identifier is required !!! The error occurs if sold-to party does not exist as an @id (VocabularyElement).
Ship from party info required in VocabularyElement if present in sourceList !!! The error occurs if ship-from is present in sourceList but not in the source.
Carrier party info required in VocabularyElement if present in sourceList !!! The error occurs if carrier party is present in sourceList but not in the source.
Sold from party identifier is required !!! The error occurs if Vocabulary | @type = "urn:epcglobal:epcis:vtype:location", but there is no sold-from party in the source.
VocabularyElement | @id Valid carrier business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid ship from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid ship to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid ship to location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid sold from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid sold to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Party type is required if additional facility identifier is populated !!! The error occurs if @id (attribute) = "http://epcis.tracelink.com/mda/additionalIdentifier", but the source is empty or null.
Class 2
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.

Receipt Event (EPCIS v1.2)

Serialized Operations Manager Owners and Partners use this message to create receipts for deliveries sent from trade partners. This message supports the required Object Event Receiving event and the optional Aggregation Event.

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

`Message Types:

  • SOM_RECEIPT_EVENT
  • SOM_RECEIPT_EVENT_IB

Info Exchange Display Name: Receipt Event

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.

Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *115
  @creationDate [1…1]
[1/*]		 DateTime 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. *116
  EPCISHeader [0…1]
[-]		 - Required. XML file control header record. The following use cases are supported in this message:
  • Aggregation + Receiving events
  • Receiving event only: no aggregation
Receiving event is mandatory, all other events are optional.
    sbdh:StandardBusinessDocumentHeader [1…1]
[-]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1…]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *117
      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]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *118

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String 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. *119

See the BusinessAndLocationId 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]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *120

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.
          @Authority [1…1]
[1/*]		 String 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. *121

See the BusinessAndLocationId enumeration list for valid values.
      sbdh:DocumentIdentification [1…1]
[-]		 -

Required.

Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *122
        sbdh:TypeVersion [1…1]
[0/*]		 String 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. *123
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String 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. *124
        sbdh:Type [1…1]
[0/*]		 String Required. Identifies the document type. The sbdh:Type value is set to Events for a shipment event. *125
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime 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. *126
      extension [0…1]
[-]		 - Header extension area with master data attributes.
        EPCISMasterData [0…1]
[-]		 - Master data extension header. Will contain business and ship party address information.
          VocabularyList [1…1]
[-]		 - Required. Vocabulary list group master data elements.
            Vocabulary [0…*]
[-]		   Looping vocabulary with discrete master data element groups. Vocabulary will occur once each for sold from, ship from, sold to, and ship to parties.
              @type [1…1]
[0/*]		 String Required. Vocabulary type identifying location master data elements. Master data type defined by VocabularyElement | @id.

Valid value: urn:epcglobal:epcis:vtype:Location = party master data. *127

Sold from, ship from, sold to, and ship to for shipping event are all tracked in header master data. Party data in shipping event is mapped from header master in Vocabulary.
              VocabularyElementList [0…1]
[-]		 - List of vocabulary elements that includes all partner master information. Party identifiers and address info are stored in instances of the looping group VocabularyElement.
                VocabularyElement [1…*]
[-]		 - Required. Looping group header for data elements that identify all business party and location master data, including identifiers, identifier types, and address info.

VocabularyElement repeats once for each party type:

  • Sold/Transfer from business party (Mandatory)
  • Ship from location (Optional)
  • Sold/Transfer to business party (Mandatory)
  • Ship to location (Optional)
                  @id [1…1]
[0/*]		 String Required. SGLN or other partner identifier and type for party master data in VocabularyElement. Must match sourceList or destinationList owning or location party in shipping event from: *128
  • ObjectEvent | extension | sourceList | source (transfer from, carrier) OR
  • ObjectEvent | extension | destinationList | destination (transfer to)

The identifier value is mandatory for regulatory reporting. The identifier type must include a valid urn or http string prefix. Valid prefix formats include by namespace:

  • GS1: urn:epc:id:sgln:[CompanyPrefix].[LocationReference].[Extension]
  • GS1 USHC: http://epcis.gs1us.org/hc/[identifierType]/loc/[identificationValue]
  • TraceLink: http://epcis.tracelink.com/hc/[identifierType]/loc/[identificationValue]
                  attribute(1) [0…*]
[0/*]		 String Required. Looping Name/Value pairs identifying partner address master data elements. This is the value element in the Name/Value pair attribute | @id. Stores master data item value defined by @id. *129

Partner master data items currently supported:

  • Business name – Mandatory if address populated in VocabularyElement.
  • Business classification – Optional.
  • Street address 1 – Mandatory if address populated.
  • Street address 2 – Optional.
  • City – Mandatory if address populated.
  • District – Optional
  • Village – Optional.
  • House number – Optional.
  • Township – Optional.
  • Corporate fax – Optional.
  • State/Province/Region – Mandatory if address populated.
  • Postal code – Optional.
  • Country code – Mandatory if address populated.
  • Premises code – Optional.
  • Tax registration code – Optional.

Create one instance of the Name/Value pair attribute and attribute | @id for each master data element returned.
                    @id [1…1]
[0/*]		 String Conditionally required if attribute is present. Provides the name in the Name/Value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix. Valid values: *130
  • urn:epcglobal:cbv:mda#name
  • urn:epcglobal:cbv:mda#streetAddressOne
  • urn:epcglobal:cbv:mda#streetAddressTwo
  • urn:epcglobal:cbv:mda#streetAddressThree
  • urn:epcglobal:cbv:mda#city
  • http://epcis.tracelink.com/mda/district
  • http://epcis.tracelink.com/mda/village
  • http://epcis.tracelink.com/mda/houseNumber
  • http://epcis.tracelink.com/mda/township
  • http://epcis.tracelink.com/mda/corporateFax
  • urn:epcglobal:cbv:mda#state
  • urn:epcglobal:cbv:mda#postalCode
  • urn:epcglobal:cbv:mda#countryCode
  • http://epcis.tracelink.com/mda/AddressObjectGUID
  • http://epcis.tracelink.com/mda/HouseGUID
  • http://epcis.tracelink.com/mda/partyRoleCode
  • http://epcis.tracelink.com/mda/premisesCode
  • http://epcis.tracelink.com/mda/taxRegistrationCode
                  attribute(2) [0…*]
[0/*]		 String Required. Looping Name/Value pairs identifying additional party identifier elements. This is the value element in the Name/Value pair attribute | @id. Stores additional party identifiers and identifier types defined by @id. *131

Partner master data items currently supported:

  • Additional party identifier - optional (1 or more supported).
  • Additional party identifier type - optional (1 or more supported).

Create one instance of the Name/Value pair attribute and @id for each master data element returned.

Additional party identifiers must be sent in a double attribute combination. The sequence must be:

  • Attribute 1 identifies and provides the party identifier value.
  • Attribute 2 identifies the party identifier type.

For example:

  • <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationValue">10023141</attribute><attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode">DUNS_PLUS_FOUR</attribute>
  • <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">10023141</attribute><attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DUNS4</attribute>
If this sequence of double attributes is not followed for additional party identifiers, the additional party identifier will not be mapped to the TraceLink system and no error will be thrown.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
                    @id [1…1]
[0/*]		 String Conditionally required if attribute is populated. Provides the name in the Name/Value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix. Valid values: *132
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationValue
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode
  EPCISBody [1…1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1…1]
[-]		 - Required. The EventList has the following structure:
  • AggregationEvent: Optional, looping, zero or more instances.
  • ObjectEvent Receipt: One instance for receiving event.

Order of events in message if all events are present:

  1. Aggregation (optional)
  2. Receipt (mandatory)
      choice%1 [1…*]
[-]		 - Required. Only one of the following choice options may be selected in any one loop on EPCISBody | EventList:
  • AggregationEvent
  • ObjectEvent (with receiving extensions)
      AggregationEvent [0…*]
[-]		 - AggregationEvent is option 1 for the EventList choice for the Aggregation events.

EventList = AggregationEvent when all of the following is true:

  • action = ADD
  • bizStep = urn:epcglobal:cbv:bizstep:packing
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *133
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *134
        parentID [1…1]
[1/*]		 AnyURI Required. An Identifier of the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPC is of the case; for a case-to-pallet aggregation, the EPC is of the pallet). See EPC Pure Identifier Format Examples. *135
        childEPCs [1…1]
[-]		 - Required. A list of identifiers, including the child items, in the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPCs is of the items; for a case-to-pallet aggregation, the EPCs is of the cases).
          epc [1…*]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *136
        action [1…1]
[1/*]		 String Required. The action value must equal ADD for the aggregation event. *137
        bizStep [0…1]
[0/*]		 AnyURI The bizStep value must equal urn:epcglobal:cbv:bizstep:packing. *138
        disposition [0…1]
[0/*]		 AnyURI The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *139
        readPoint [0…1]
[-]		 - Optional for AggregationEvent.
          id [1…1]
[0/*]		 AnyURI Required. The SGLN EPC of the location of where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. *140
        bizLocation [0…1]
[-]		 - Required. Mandatory for AggregationEvent.
          id [1…1]
[0/*]		 AnyURI 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. *141
        tl:aggregationEventExtensions [0…1]
[-]		 - Extensions used for Aggregation Event.
          tl:packedStatus [0…1]
[0/*]		 String The packout of the item or container using the supported enumeration values. *142
          tl:quantity [0…1]
[-]		 Int The quantity of child serial numbers aggregated to the parent container in this aggregation. *143
          tl:resetContainerAggregation [0…1]
[-]		 Boolean Reset container aggregation flag. *144
          tl:extensionField [0…*]
[-]		 - Customer extension point to pass in one or more name/value pairs containing additional data attributes not already supported in this message.

These extensions are not stored by TraceLink and are used only for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this message, such as when a CMO is required to provide additional data fields to the Pharmaceutical Manufacturer. In this case, TraceLink would have a custom map for that trade partner to map these fields outbound. Different trade partners may have different field requirements and may therefore require that tl:extensionField be populated differently per trade partner.

If this element group is populated, both the tl:fieldName and tl:fieldValue elements must be populated.

            tl:fieldName [1…1]
[1/*]		 String Conditionally required if tl:ExtensionField is present. Populate with the field name provided by the trade partner receiving the mapped outbound message. The field name must match the field name provided by the trade partner exactly, including case, so that it can be properly detected in the outbound mapping.
            tl:fieldValue [1…1]
[1/*]		 String Conditionally required if tl:ExtensionField is present. Populate with the field value content that corresponds to tl:fieldName.
      ObjectEvent [1…1]
[-]		 - Required. EventList. Data = ObjectEvent for Receipt Event.

Define ReceivingEvent with:

  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:receiving
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *145
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *146
        epcList [1…1]
[-]		 - Required. List of the EPCs of top-most containers (e.g. pallets, cases) in the shipment.
          epc [1…*]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *147
        action [1…1]
[0/*]		 String Required. The action value must equal OBSERVE. *148
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:receiving. *149
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *150
        readPoint [0…1]
[-]		 - Required. The location where the event occurred, i.e. the warehouse GLN location ID and storage location (shelf, bin, etc.) in URN format, that recorded the Object event.
          id [1…1]
[0/*]		 AnyURI 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. *151
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizStep = urn:epcglobal:cbv:bizstep:shipping.
          bizTransaction [1…*]
[0/*]		 AnyURI Required. This field is the business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or invoice and/or purchase order governing this shipment, which are subject to Section 8.4.2 of (CBV1.0). The GLN that occurs after urn:epcglobal:cbv:bt: is the GLN of the party that issued the number (e.g. if customer issues PO Number, customer GLN is entered. If supplier issues ASN/delivery number supplier GLN is entered). *152
A delivery number or ASN is mandatory. All other transaction types are optional.

The transaction number requirements vary by region. It is recommended that the following are always provided, when available, to fulfill compliance needs:

  • Purchase Order Number
  • Invoice Number
  • ASN
            @type [1…1]
[1/*]		 String Required. The transaction identifier type using the supported enumeration values (e.g. PO, ASN, RETURN). *153

Mandatory if cmn:TransactionIdentifier is populated. A delivery number or ASN is mandatory. All other transaction types are optional.

See the TransactionId enumeration list for valid values.
              @date [0…1]
[0/*]		 Date Required. The transaction identifier date. *154
        extension [0…1]
[-]		 - Main extension body for receipt event.
Source and Destination lists are optional even if party address master data is stored in the VocabularyElement in the EPCISMasterData extension in the message header.
          sourceList [0…1]
[-]		 - Required.

Source list identifies sending business, location, and carrier parties. sourceList supports one of two functions:

  1. VocabularyElement is populated with party address master data: sourceList identifies sold-from, ship-from, or carrier party. Party master data is mapped from VocabularyElement.
  2. VocabularyElement is not populated with party address master data: sourceList party identifiers used for master data lookup in the backend.
            source [1…*]
[0/*]		 String Required. Source party identifier for sold-from, ship-from, or carrier parties. Party identifier in source either: *155
  1. Identifies sold-from, ship-from, or carrier party in populated VocabularyElement. Party address info is mapped from VocabularyElement. Nothing is mapped from VocabularyElement if there is no match between party identifier in sourceList | source and VocabularyElement | @id.
  2. sourceList/source supports master data lookup in TraceLink system. VocabularyElement is not populated or there is no match between party identifiers in source and VocabularyElement | @id. If ship-from party the same as sold-from party, ship-from identifier does not need to be sent.
If the ship-from party is the same as the sold-from party, the ship-from identifier does not need to be sent.

 
              @type [1…*]
[0/*]		 String Required. Type of source party identifier, i.e. owning (sold-from), location (ship-from), or carrier party. Valid values: *156
  • Sold-from party = urn:epcglobal:cbv:sdt:owning_party Mandatory.
  • Ship-from party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
          destinationList [0…1]
[-]		 - Required.

Destination list identifies receiving business or location parties identified in header extensions level.

destinationList supports one of two functions:

  1. VocabularyElement populated with party address master data: destinationList identifies sold-to, ship-to parties. Party master data mapped from VocabularyElement.
  2. VocabularyElement NOT populated with party address master data: destinationList party identifiers used for master data lookup in backend.
            destination [1…*]
[0/*]		 String Required. Destination party identifier for sold-to or ship-to parties. Party identifier in destination either: *157
  1. Identifies sold-to or ship-to parties in populated VocabularyElement. Party address info mapped from VocabularyElement. Nothing is mapped from VocabularyElement if there is no match between party identifier in destinationList | destination and VocabularyElement | @id.
  2. destinationList | destination supports master data lookup in the TraceLink system. VocabularyElement is NOT populated or there is NO match between party identifiers in destination and VocabularyElement | @id.
If ship-to party the same as sold-to party, ship-to identifier does not need to be included.

See the MDPartyTypeAttributes enumeration list for valid values.
              @type [1…1]
[0/*]		 String Required. Identifies type of destination party identifier, i.e. owning (sold-to) or location (ship-to) party. Valid values: *158
  • Sold-to party = urn:epcglobal:cbv:sdt:owning_party (mandatory).
  • Ship-to party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
        tl:receivingEventExtensions [0…1]
[-]		 - Receiving event with list of serial numbers being received from supplier's shipment.
          tl:transactionDate [1…1]
[-]		 Date Required. Date associated with the business transaction document in bizTransactionList in YYYY-MM-DD format. This date may or may not be the same as the eventTime. *159
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. 2 letter ISO country code for ship to country. This value is referenced to advise regulatory reporting if it is mandatory for the specified country market. *160

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink system.
          tl:shipFromCountryCode [0…1]
[2/2]		 String 2 letter ISO country code for ship from country. This value is referenced to advise regulatory reporting if it is mandatory for the specified country market. *161

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink system.
          tl:receiptDistributionType [1…1]
[1/*]		 String Required. Informs what types of regulatory reporting may be triggered based on the nature of the transaction: a purchase, transfer, or return within the same country or a purchase, transfer, or return from another country. *162

See the SalesDistType enumeration list for valid values.
          tl:supplyType [0…1] String Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or EXPORTRETURN. All values except for Collection apply. Identifies the type of supply that is being performed using one of the permitted values. *163

See the SupplyType enumeration list for valid values.
          tl:contractType [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or EXPORTRETURN. Identifies the type of contract for the sale of goods using one of the permitted values. *164

See the ContractType enumeration list for valid values.
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with delivery.
          tl:contractNumber [0…1]
[0/*]		 String Identification number of the contract. *165
          tl:fundingSource [0…1]
[0/*]		 String Required. Source of the funding. *166

See the FundingSource enumeration list for valid values.
          tl:transferWithoutShipment [0…1]
[0/*]		 String

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state
  • false – (default) Serial numbers are in the Pending Receipt state.

Only use this element when tl:receiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
          tl:entryPort [0…1]
[0/*]		 String Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
          tl:exitPort [0…1]
[0/*]		 String Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
          tl:deliveryInspection [0…1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.
          tl:deliveryInspectionDate [0…1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *167
          tl:deliveryInspectionNote [0…1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
          tl:removalFromCirculation [0…1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
          tl:aggregationInspection [0…1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
          tl:orderItemList [0…1]
[-]		 - Order item list group is populated to communicate the pick quantities for each item code at the EACH (unit) level.
            tl:orderItem [1…*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number and quantity for each item in the order. Each unique item code and lot number are communicated in a separate order item group.
              tl:orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of tl:orderItem.
              choice%1 [-]
[-]		 -

Conditionally required if tl:shipFromCountryCode = KR. Populate only one of cmn:InternalMaterialCode or cmn:PackagingItemCode. One of the two options must be present.

Populate only one of tl:InternalMaterialCode, tl:PackagingItemCode, or tl:countryDrugCode. One of the three options must be present.

              tl:internalMaterialCode [0…1]
[1/*]		 String Conditionally required if neither tl:packagingItemCode nor tl:countryDrugCode is present. Option 1 for choice%1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *168
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:countryDrugCode is present. Option 2 for choice%1 in OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *169
                @type [0…1]
[0/*]		 String

Required. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14).

See the ItemCode enumeration list for valid values.
              tl:countryDrugCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:packagingItemCode is present. Option 3 for choice%1 in OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *170
                @type [0…1]
[0/*]		 String

Required. The national drug code type using the supported enumeration values (e.g. US_NDC442).

See the CountryDrugCode enumeration list for valid values.
              cbvmda:lotNumber [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:isSerialized = false. The lot or batch code for the items to be picked (if available) in an alphanumeric string. *171
              cbvmda:itemExpirationDate [0…1]
[1/*]		 Date The expiration date for the serialized item in YYYY-MM-DD format. *172
              tl:quantity [1…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:isSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. *173
              tl:unitPrice [0…1]
[0/*]		 Decimal

Required. Unit price of item. *174
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *175
              tl:vat [0…1]
[-]		 Decimal Value Added Tax per unit. *176
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *177

See the ISOCurrency enumeration list for valid values.
              tl:grossPrice [0…1]
[-]		 Decimal Gross price including unit price and all taxes and fees. *178
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *179

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is not serialized. If omitted, defaults to true. *180
              tl:transactionIdentifier [0…*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *181
                @type [1…1]
[1/*]		 String Required. The transaction identifier type. Valid values:
  • DESTRUCTION
  • INVOICE
  • NOTAFISCAL
  • OTHER
  • PO
  • RETURN
                @date [0…1]
[0/*]		 Date Conditionally required if tl:shipToCountryCode = RU. The transaction identifier date. *182
          tl:warehouseOperatorName [0…1]
[0/*]		 String Name of the person responsible for warehouse operations.
          tl:correctiveReceipt [0…1]
[0/*]		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • false – (default) The receipt is not a corrective receipt.
  • true – The receipt is a corrective receipt.
          tl:originalDeliveryNumber [0…1]
[0/*]		 String Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt. 

<?xml version="1.0" encoding="UTF-8"?>
<epcis:EPCISDocument xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:gs1ushc="http://epcis.gs1us.org/hc/ns" 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="2017-08-31T17:45:20.0Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8779891013658</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8887771013655</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>2019082106310032</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-07-25T15:39:53Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
        <extension>
            <EPCISMasterData>
                <VocabularyList>
                    <Vocabulary type="urn:epcglobal:epcis:vtype:Location">
                        <VocabularyElementList>
                            <VocabularyElement id="urn:epc:id:sgln:9997777.01994.0">
                                <attribute id="urn:epcglobal:cbv:mda#name">Clara Manufacturing</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">712333444</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DEA</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/partyRoleCode">MANUFACTURER</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#streetAddressOne">10 Welsh St</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#city">Malden</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/district"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/village"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/houseNumber"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/township"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/corporateFax"></attribute>
                                <attribute id="urn:epcglobal:cbv:mda#state">MA</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#postalCode">02148</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#countryCode">US</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/AddressObjectGUID"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/HouseGUID"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/partyRoleCode"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/premisesCode"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/taxRegistrationCode"></attribute>
                            </VocabularyElement>
                            <VocabularyElement id="urn:epc:id:sgln:9297187.01994.0">
                                <attribute id="urn:epcglobal:cbv:mda#name">Watson Wholesaler</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">512333444</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DEA</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/businessClassification">WHOLESALER</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#streetAddressOne">555 Neelan Road</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#city">Sacramento</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/district"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/village"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/houseNumber"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/township"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/corporateFax"></attribute>
                                <attribute id="urn:epcglobal:cbv:mda#state">CA</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#postalCode">95833</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#countryCode">US</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/AddressObjectGUID"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/HouseGUID"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/partyRoleCode"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/premisesCode"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/taxRegistrationCode"></attribute>
                            </VocabularyElement>
                        </VocabularyElementList>
                    </Vocabulary>
                </VocabularyList>
            </EPCISMasterData>
        </extension>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <AggregationEvent>
                <eventTime>2019-09-25T00:12:23.8Z</eventTime>
                <eventTimeZoneOffset>-04:00</eventTimeZoneOffset>
                <parentID>urn:epc:id:sscc:005434.40000000021</parentID>
                <childEPCs>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024596</epc>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024597</epc>
                </childEPCs>
                <action>ADD</action>
                <bizStep>urn:epcglobal:cbv:bizstep:packing</bizStep>
                <disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </bizLocation>
            </AggregationEvent>
            <!-- Receiving -->
            <ObjectEvent>
                <eventTime>2019-09-25T00:12:23.8Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sscc:005434.40000000020</epc>
                </epcList>
                <action>OBSERVE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:receiving</bizStep>
                <disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </bizLocation>
                <bizTransactionList>
                    <bizTransaction type="urn:epcglobal:cbv:btt:desadv" date="2019-09-25">urn:epcglobal:cbv:bt:8779891013658:987654321</bizTransaction>
                    <bizTransaction type="urn:epcglobal:cbv:btt:po" date="2019-09-25">urn:epcglobal:cbv:bt:9297187019944:4747880013</bizTransaction>
                    <bizTransaction type="urn:epcglobal:cbv:btt:inv" date="2019-09-25">urn:epcglobal:cbv:bt:9997777019940:987654321</bizTransaction>
                </bizTransactionList>
                <extension>
                    <sourceList>
                        <source type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:9997777.01994.0</source>
                    </sourceList>
                    <destinationList>
                        <destination type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:9297187.01994.0</destination>
                    </destinationList>
                </extension>
                <tl:receivingEventExtensions>
                    <tl:transactionDate>2019-07-25</tl:transactionDate>
                    <tl:shipToCountryCode>US</tl:shipToCountryCode>
                    <tl:shipFromCountryCode>US</tl:shipFromCountryCode>
                    <tl:receiptDistributionType>INCOUNTRYTRANSFER</tl:receiptDistributionType>
                    <tl:supplyType>MedicalCareDistribution</tl:supplyType>
                    <tl:contractType>PrivateContract</tl:contractType>
                    <tl:contractNumber>C102</tl:contractNumber>
                    <tl:fundingSource>OwnFunds</tl:fundingSource>
                    <tl:transferWithoutShipment>false</tl:transferWithoutShipment>
                    <tl:entryPort></tl:entryPort>
                    <tl:exitPort></tl:exitPort>
                    <tl:epcOrderItemDetails>
                        <tl:epcOrderItemList orderItemNumber="15">
                            <tl:epcOrderItem>urn:epc:id:sscc:005434.40000000021</tl:epcOrderItem>
                        </tl:epcOrderItemList>
                    </tl:epcOrderItemDetails>
                    <tl:orderItemList>
                        <tl:orderItem>
                            <tl:orderItemNumber>15</tl:orderItemNumber>
                            <tl:packagingItemCode type="GTIN-14">00992326050107</tl:packagingItemCode>
                            <cbvmda:lotNumber>L120012</cbvmda:lotNumber>
                            <cbvmda:itemExpirationDate>2029-07-25</cbvmda:itemExpirationDate>
                            <tl:quantity>5</tl:quantity>
                            <tl:unitPrice currencyCode="USD">89.55</tl:unitPrice>
                            <tl:vat currencyCode="USD">10.45</tl:vat>
                            <tl:grossPrice currencyCode="USD">100.00</tl:grossPrice>
                            <tl:isSerialized>true</tl:isSerialized>
                            <tl:transactionIdentifier type="PO" date="2019-03-30">TI007</tl:transactionIdentifier>
                        </tl:orderItem>
                    </tl:orderItemList>
                    <tl:warehouseOperatorName>Patrick Murphy</tl:warehouseOperatorName>
                    <tl:correctiveReceipt>false</tl:correctiveReceipt>
                    <tl:originalDeliveryNumber>False9022413</tl:originalDeliveryNumber>				
                </tl:receivingEventExtensions>
            </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.
VocabularyElement Sold from party identifier is required !!! The error occurs if sold from party does not exist as a VocabularyElement | @id.
VocabularyElement | @id Valid sold from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | attribute Sold from business party name is required !!! The error occurs if the source is empty or null.
Party type is required if additional business party identifier is populated !!! The error occurs if additionalIdentifier is populated, but the source is empty or null.
Valid sold from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid business classification code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Sold from business party street address is required !!! The error occurs if the source is empty or null.
Sold from business party city is required !!! The error occurs if the source is empty or null.
3-digit numeric District code required for country India !!! The error occurs if country= IN, but district is not a 3-digit numeric code.
Sold from business party state or region is required !!! The error occurs if the source is empty or null.
Sold from business party country is required !!! The error occurs if the source is empty or null.
Valid Sold from business party country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement Ship from party info required in VocabularyElement if present in sourceList !!! The error occurs if ship from is present in sourceList, but not in VocabularyElement.
VocabularyElement | @id Valid ship from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | attribute Ship from business party name is required !!! The error occurs if the source is empty or null.
Party type is required if additional facility identifier is populated !!! The error occurs if additionalIdentifier is populated, but the source is empty or null.
Valid ship from location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Ship from location street address is required !!! The error occurs if the source is empty or null.
Ship from location city is required !!! The error occurs if the source is empty or null.
Ship from location state or region is required !!! The error occurs if the source is empty or null.
Ship from location country is required !!! The error occurs if the source is empty or null.
Valid Ship from location country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement Sold to party identifier is required !!! The error occurs if ship to is present in destinationList, but not in the source.
VocabularyElement | @id Valid sold to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | attribute Sold to business party name is required !!! The error occurs if the source is empty or null.
Valid sold to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Sold to business party street address is required !!! The error occurs if the source is empty or null.
Sold to business party city is required !!! The error occurs if the source is empty or null.
Sold to business party state or region is required !!! The error occurs if the source is empty or null.
Sold to business party country is required !!! The error occurs if the source is empty or null.
Valid Sold to business party country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement Ship to party info required in VocabularyElement if present in destinationList !!! The error occurs if ship to is present in destinationList, but not in the source.
VocabularyElement | @id Valid ship to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | attribute Ship to business party name is required !!! The error occurs if the source is empty or null.
Valid ship to location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Ship to location street address is required !!! The error occurs if the source is empty or null.
Ship to location city is required !!! The error occurs if the source is empty or null.
Ship to location state or region is required !!! The error occurs if the source is empty or null.
Ship to location country is required !!! The error occurs if the source is empty or null.
Valid Ship to location country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement Carrier party info required in VocabularyElement if present in sourceList !!! The error occurs if carrier party is present in sourceList, but not in VocabularyElement.
VocabularyElement | @id Valid carrier business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | attribute Carrier business party name is required !!! The error occurs if the source is empty or null.
Valid carrier business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Carrier business party street address is required !!! The error occurs if the source is empty or null.
Carrier business party city is required !!! The error occurs if the source is empty or null.
Carrier business party state or region is required !!! The error occurs if the source is empty or null.
Carrier business party country is required !!! The error occurs if the source is empty or null.
Valid Carrier business party country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
choice At least one object event for receiving is required !!! The error occurs if the source is empty or null.
AggregationEvent | parentID Invalid EPC format !!! The error occurs if the value cannot be translated.
Serial number in source epc is required !!! The error occurs if the source is empty or null.
Invalid EPC format !!! The error occurs if the source is invalid.
childEPCs | epc Invalid EPC format !!! The error occurs if the source is invalid or cannot be translated.
AggregationEvent | bizStep bizStep urn:epcglobal:cbv:bi​zstep:packing is required for the AggregationEvent !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bi​zstep:packing" for a aggregation event.
AggregationEvent | disposition Dispositio​n urn:epcglobal:cbv:di​sp:in_progress is required for the AggregationEvent !!! The error occurs if the source does not equal "urn:epcglobal:cbv:di​sp:in_progress".
bizLocation | id Event location in the aggregation event is required !!! The error occurs if the source is empty or null.
tl:extensionField | tl:fieldName Field name is required if ExtensionField group present in source !!! The error occurs if tl:extensionField group is populated, but the source is empty or null.
tl:extensionField | tl:fieldValue Field value is required if ExtensionField group present in source !!! The error occurs if tl:extensionField group is populated, but the source is empty or null.
ObjectEvent (Receiving Events) Receiving event data is required !!! The error occurs if the required source is missing or null.
Only one receiving event is required !!! The error occurs if more than one receiving event is present.
epcList | epc Invalid EPC format !!! The error occurs if the source is invalid or cannot be translated.
ObjectEvent (Receiving Events) | bizStep bizStep urn:epcglobal:cbv:bizstep:receiving is required for ObjectEvent receiving !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bi​zstep:receiving" for a receiving event.
ObjectEvent (Receiving Events) | disposition Dispositio​n urn:epcglobal:cbv:disp:in_progress is required for ObjectEvent receiving !!! The error occurs if the source does not equal "urn:epcglobal:cbv:di​sp:in_progress".
ObjectEvent (Receiving Events) | readPoint | id Event location in the receiving event is required !!! The error occurs if the source is empty or null.
bizTransactionList Biz transaction list is required in receiving event !!! The error occurs if the source is empty or null.
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
source Valid sold-from business lookup identifier type is required !!! The error occurs if the source is invalid.
Valid ship-from business lookup identifier type is required !!! The error occurs if the source is invalid.
Valid carrier business lookup identifier type is required !!! The error occurs if the source is invalid.
destination Valid sold-to business lookup identifier type is required !!! The error occurs if the source is invalid.
Valid ship-to business lookup identifier type is required !!! The error occurs if the source is invalid.
tl:receivingEventExtensions receivingEventExtensions required if receiving event populated !!! The error occurs if the source is empty or null.
tl:shipToCountryCode Valid ISO country code for ship-to country is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
tl:shipFromCountryCode Valid ISO country code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Ship from country for import products is required !!! The error occurs if ReceiptDistributionType = "IMPORTSALE", "IMPORTTRANSFER", or "IMPORTRETURN", but the source is empty or null.
tl:receiptDistributionType Valid receipt distributionType is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
choice1

One of internalMaterialCode or packagingItemCode is required !!!

The error occurs if both tl:internalMaterialCode and tl:packagingItemCode are empty or null.
tl:packagingItemCode | @type Packaging item code type is required !!! The error occurs if tl:packagingItemCode is populated, but the source is empty or null.
tl:unitPrice | @currencyCode Valid ISO currency code is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
tl:warehouseOperatorName Warehouse operator name for China product is required !!! The error occurs if epcList | epc = "http://epcis.tracelink.com/obj/cn-edmc/", but source is empty or null.
Class 2
bizTransaction | @date Transaction Identifier Date is required if Ship To Country Code = RU.

The error occurs if tl:shipToCountryCode = "RU" but the source is empty or null.
tl:shipToCountryCode Serialized Operations Manager Receipt inbound processing could not be completed. Both the ShipToCountryCode and ShipFromCountryCode must be specified when the Sender Info and ReceiverInfo are not specified.  The error occurs if the sourceList and destinationList are both omitted, and tl:shipToCountryCode and tl:ShipFromCountrycode are empty or null.
tl:shipFromCountryCode
tl:fundingSource Funding Source is required if Ship To Country Code is RU and Ship From Country Code is RU. The error occurs if both tl:shipToCountryCode and tl:shipFromCountryCode = "RU", but the source is empty or null.
tl:unitPrice Unit Price is required if Ship To Country Code is RU and Ship From Country Code is any of RU, AM, BY, KZ, KG. The error occurs if tl:shipToCountryCode = "RU" and tl:shipFromCountryCode = "AM", "BY", "KG", "KZ", or "RU", but the source is empty or null.
tl:transactionIdentifier | @date Order Item Transaction Identifier Date is required if Ship To Country Code = RU.

The error occurs if tl:shipToCountryCode = "RU" but the source is empty or null.
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 Receipt (XML)

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

Message Type: SOM_ESM_RECEIPT

Info Exchange Display Name: ESM Receipt

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.

Data Element Occurs
Length		 Type Description
som:SOMReceiptMessage [1…1]
[-]		 - Required. Root element of message.
  som:ControlFileHeader [1…1]
[-]		 - Required. The message document's header information.
    cmn:FileSenderNumber [1…1]
[1/20]		 String Required. The company identifier of the file’s sender. *183
    cmn:FileReceiverNumber [1…1]
[1/20]		 String Required. The company identifier of the file’s recipient. *184
    cmn:FileControlNumber [1…1]
[1/20]		 String Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages. *185
    cmn:FileDate [1…1]
[10/10]		 Date Required. The date that the message is sent in YYYY-MM-DD format. Date and times must be in GMT. *186
    cmn:FileTime [1…1]
[9/9]		 Time 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. *187
  som:MessageBody [1…1]
[-]		 - Required. Main body of the message.
    cmn:LocationId [1…1]
[0/34]		 String Specifies the facility or warehouse identifier to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number. *188

If the location is omitted, the Sales Shipment status update is applied globally to all matching serial numbers in the system.
    cmn:DeliveryNumber [1…1]
[1/*]		 String Required. Links the order information to the serialized receive information for this customer delivery. *189
    cmn:DeliveryCompleteFlag [1…1]
[1/*]		 Boolean Required. Instructs TraceLink to process the outbound delivery, update the status of all serial numbers and child aggregations to be shipped, and trigger generation of regulatory reporting messages based on customer configuration. *190

If all of the information (order detail and received serial numbers) is in a single message, the delivery complete flag is set to true.

If only partial information is in the message (e.g. order detail only, received items sent incrementally, etc.) the delivery complete flag is set to false for all intermediate messages, and then set to true when the delivery is complete and all information has been communicated to TraceLink.

Values must be lower case only. True or TRUE will throw an error.
    cmn:RegisterUknownSNs [0…1]
[0/*]		 Boolean

Determines if serial numbers that are not known to SOM should be registered or not. Valid values:

  • true – All serial numbers that do not currently exist in SOM are registered in the Available state.
  • false – All serial numbers that do not currently exist in SOM are rejected.
    som:OrderDetails [1…1]
[-]		 - Required. Includes business transaction identifier and date, order item receive list, and sender and recipient information. This element is mandatory before the delivery complete flag can be set, though it can be communicated at any time (e.g. with, before, or after the received serial numbers have been communicated).
      cmn:CorrectiveReceipt [0…1]
[0/*]		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • false – (default) The receipt is not a corrective receipt.
  • true – The receipt is a corrective receipt.
      cmn:OriginalDeliveryNumber [0…1]
[0/*]		 String

Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt.
      cmn:EntryPort [0…1]
[0/*]		 String

Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
      cmn:ExitPort [0…1]
[0/*]		 String

Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
      cmn:TransactionIdentifier [1…*]
[1/*]		 String Required. Identifier associated with the received serial numbers, for regulatory reporting purposes. *191

At least one transaction id is mandatory.

        @type [1…1]
[1/*]		 String Required. The transaction identifier type using supported enumeration values (e.g. ASN, PO, RETURN). *192

See the TransactionId enumeration list for valid values.
        @date [0…1]
[0/*]		 Date Required. The transaction identifier date. *193
      cmn:TransactionDate [1…1]
[1/*]		 Date Required. The date of the message in YYYY-MM-DD format. *194
      cmn:TransactionTime [0…1]
[0/*]		 Time The time of the message in HH:MM:SS format. *195
      cmn:ShipToCountryCode [1…1]
[2/2]		 String Required. ISO country code for ship to country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events. *196

See the ISOCountryCode enumeration list for valid values.
      cmn:ShipFromCountryCode [0…1]
[2/2]		 String Conditionally required if the product is being exported from country (e.g. when ReceiptDistributionType = EXPORTSALE, EXPORTTRANSFER, or EXPORTRETURN). ISO country code for ship from country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events. *197

See the ISOCountryCode enumeration list for valid values.
      cmn:ReceiptDistributionType [1…1]
[1/*]		 String Required. Advises the application of sale (change of ownership of the product) and transfer (no change of ownership of product, but physical movement of product) for application and regulatory reporting purposes. The actual triggering of regulatory reporting is governed by the configuration in TraceLink. *198

INCOUNTRYTRANSFER and EXPORTTRANSFER include:

  • Intra-company warehouse transfer of goods.
  • Transfers between Manufacturer (Brand Owner) and 3PL.
  • Transfers between Manufacturer (Brand Owner) and CMO/CPO.
  • Transfers between CMO/CPO and 3PL of Manufacturer (Brand Owner).
Setting this value alone does not trigger regulatory reporting.

See the ReceiptDistributionType enumeration list for valid values.
      cmn:TransferWithoutShipment [0…1]
[0/*]		 Boolean

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state.
  • false – (default) Serial numbers are in the Pending Receipt state.

Only use when tl:receiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
      cmn:SupplyType [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN; All values except for Collection apply.:

Identifies the type of supply that is being performed using a valid value from the enumerations list.

See the SupplyType enumeration list for valid values.
      cmn:ContractType [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN. Identifies the type of contract for the sale of goods using a valid value from the enumerations list.

See the ContractType enumeration list for valid values.
      cmn:Comments [0…1]
[0/*]		 String Optional remarks or comments regarding with delivery.
      cmn:ContractNumber [0…1]
[0/*]		 String Identification number of the contract. *199
      cmn:FundingSource [0…1]
[0/*]		 String Required. Source of the funding. *200

See the FundingSource enumeration list for valid values.
      cmn:DeliveryInspection [0…1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.
      cmn:DeliveryInspectionDate [0…1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *201
      cmn:DeliveryInspectionNote [0…1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
      cmn:RemovalFromCirculation [0…1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
      cmn:AggregationInspection [0…1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
      cmn:OrderItemList [1…1]
[-]		 - Conditionally required. Order item list group is populated to communicate the expected receive quantities for each item code at the EACH (unit) level. This information verifies the actual serial number received, the correct product, the correct lot number (if provided), and the correct each quantity.
        cmn:AllowShortVerificationCount [0…1]
[0/*]		 Boolean When set to true, allows the count to come up short without an error. If set to false, an error is thrown if the count does not match what is expected. *202
        cmn:OrderItem [1…*]
[-]		 - Required. A repeating element that captures the item code, lot number, and quantity for each item that will be received for the order. Each unique item code and lot number are communicated in a separate order item group.
          cmn:OrderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
          choice1% [1…1]
[-]		 Choice

Required. Populate only one of cmnl:InternalMaterialCode, cmn:PackagingItemCode, or cmn:CountryDrugCode. One of the three options must be present.

          cmn:InternalMaterialCode [0…1]
[1/*]		 String Conditionally requiredif neither cmn:PackagingItemCode nor cmn:CountryDrugCode is present. Option 1 for OrderItem | choice1%. Use to identify the product using the internal material number configured in Product Master Data. *203
          cmn:PackagingItemCode [0…1]
[1/*]		 String Conditionally requiredif neither cmn:InternalMaterialCode nor cmn:CountryDrugCode is present. Option 2 for OrderItem | choice1%. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *204
            @type [1…1]
[1/*]		 String Required. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14). *205

See the ItemCode enumeration list for valid values.
          cmn:CountryDrugCode [0…1]
[1/*]		 String Conditionally required if neither cmn:InternalMaterialCode nor cmn:PackagingItemCode is present. Option 3 for choice%1 in OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *206
            @type [0…1]
[0/*]		 String The national drug code type using the supported enumeration values. * 207

See the CountryDrugCode enumeration list for valid values.
          cmn:LotNumber [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:IsSerialized = false. The lot or batch code for the items to be received (if available) in an alphanumeric String. *208
          cmn:ExpirationDate [0…1]
[0/*]		 Date Expiration date for product in YYYY-MM-DD format. *209
          cmn:Quantity [1…1]
[1/*]		 Integer Conditionally required if cmn:ShipFromCountryCode = KR and cmn:IsSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot if specified to be received. *210
          cmn:UnitPrice [0…1]
[1/*]		 Decimal Required. The unit price of an item. *211
            @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *212
          cmn:VAT [0…1]
[-]		 Decimal Value Added Tax per unit. *213
            @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *214

See the ISOCurrency enumeration list for valid values.
          cmn:GrossPrice [0…1]
[-]		 Decimal Gross price including unit price and all taxes and fees. *215
            @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *216

See the ISOCurrency enumeration list for valid values.
          cmn:IsSerialized [0…1]
[0/*]		 Boolean Conditionally required. Indicates if the item is not serialized. *217
If omitted, and cmn:OrderItem exists, defaults value to true.
          cmn:TransactionIdentifier [0…*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *218
            @type [1…1]
[1/*]		 String

Required.

The transaction identifier type. Valid values:
  • DESTRUCTION
  • INVOICE
  • NOTAFISCAL
  • OTHER
  • PO
  • RETURN
            @date [0…1]
[0/*]		 Date Required. The transaction identifier date. *219
      cmn:SenderInfo [1…1]
[-]		 - Required. Information about the supply chain partner that is sending the shipment. Contains XML choice elements of FromBusinessParty and ShipFromLocation that govern whether to use master data lookup to populate the address, license, and contact elements.

Only one option in choice1% may be populated.
        choice1% [1…1]
[-]		 Choice Required. One of the following options:
  • Option 1: Contains only cmn:FromBusinessPartyLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:FromBusinessPartyInfo business address the customer populates directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:FromBusinessPartyLookupId [0…1]
[1/*]		 String Conditionally required if full business address is provided in cmn:FromBusinessPartyInfo option. Option 1 for senderInfo | choice1% group. *220

A lookup identifier associated with the sold-from business entity. This value is used as the lookup key in master data to populate the details in cmn:FromBusinessPartyInfo.

          @type [1…1]
[1/*]		 String Conditionally required if full business address is not provided in cmn:FromBusinessPartyInfo option. The type of the sold from business entity identifier from the provided enumeration list. *221

See the BusinessLookupId enumeration list for valid values.
        cmn:FromBusinessPartyInfo [0…1]
[-]		 - Conditionally required if cmn:FromBusinessPartyLookupId to leverage master data lookup is not populated. Option 2 for senderInfochoice1% group.

The full business information associated with the sold from business entity is provided.

          cmn:BusinessId [1…*]
[1/*]		 String Required. The identifier associated with the sold from business entity. Mandatory for regulatory reporting. *222
            @type [1…1]
[1/*]		 String Required. The type of the BusinessId identifier. *223
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:BusinessClassification [0…1]
[0/*]		 String Business classification. *224

See the BusinessClassification enumeration list for valid values.
          cmn:BusinessInfo [0…1]
[-]		 - The business name and address of the sold from business entity.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *225
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *226
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address. *227
            cmn:City [1…1]
[1/*]		 String Required. The city. *228
            cmn:Village [0…1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0…1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0…1]
[0/*]		 String District Code. *229
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *230
            cmn:PostalCode [1…1]
[0/*]		 String Required. The ZIP or other postal code. *231
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *232
            cmn:CorporateFax [0…1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0…1]
[0/*]		 String The global identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0…1]
[0/*]		 String The global house identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0…1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0…1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
        choice2% [0…1]
[-]		 Choice Optional choice element (no error if neither are present):
  • Option 1: Contains only the cmn:ShipFromLocationLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:ShipFromLocationInfo business address fielded data that will be populated by the customer directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:ShipFromLocationLookupId [0…1]
[1/*]		 String Required. Option 1 for senderInfo | choice2% group. *233

A lookup identifier associated with the ship from location. Use this value as the lookup key in master data to populate the details in cmn:ShipFromLocationInfo.
          @type [1…1]
[1/*]		 String Conditionally required if full business address is not provided in cmn:ShipFromLocationInfo option. The type of the ship from location identifier using the enumeration list. *234

See the LocationLookupId enumeration list for valid values.
        cmn:ShipFromLocationInfo [0…1]
[-]		 - Required. Option 2 for senderInfo | choice2% group.

The full business information associated with the ship from location is provided directly.

          cmn:FacilityId [0…*]
[0/*]		 String Required. The ship from location identifier. *235
            @type [1…1]
[1/*]		 String Required. The type of the cmn:FacilityId identifier. *236
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:LocationInfo [0…1]
[-]		 - Conditionally required for US. The business name and address of the ship from location.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *237
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *238
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *239
            cmn:Village [0…1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0…1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0…1]
[0/*]		 String Conditionally required for India. District Code. *240
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *241
            cmn:PostalCode [1…1]
[0/*]		 String Required. The ZIP or other postal code. *242
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *243
            cmn:CorporateFax [0…1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0…1]
[0/*]		 String The global identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0…1]
[0/*]		 String The global house identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0…1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0…1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
          cmn:LicenseNumber [0…*]
[0/*]		 String The license number of the facility. This element may be repeated to include as many license numbers as mandatory (e.g. state and federal license). *244
            @state [0…1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. Used to give additional context to the license number. *245
            @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). Used to give additional context to the license number. *246
          cmn:ContactInfo [0…1]
[-]		 - Contact information for use by downstream trading partners to authenticate (e.g. verify) the message information recorded on the pedigree with the sender party.
            cmn:Name [0…1]
[0/*]		 String Required. The name of the contact department or individual at the company. *247
            cmn:Title [0…1]
[0/*]		 String The title of the individual if a person was provided in cmn:Name. *248
            cmn:Telephone [1…1]
[1/*]		 String Required. The phone number of the contact department or individual at the company. Must begin with the + character followed by the Country Calling Code. *249
            cmn:Email [0…1]
[0/*]		 String The email address of the contact department or individual at the company. Should be included if available. *250
            cmn:Url [0…1]
[0/*]		 String The Web address to facilitate authentication. *251
      cmn:ReceiverInfo [1…1]
[-]		 - Required. Information about the supply chain partner that is receiving the shipment. cmn:ReceiverInfo contains XML choice elements for ToBusinessParty and ShipToLocation that govern whether to use master data lookup to populate the address, license, and contact elements.

Only one option in choice1% may be populated.
        choice1% [1…1]
[-]		 Choice Required. Required choice element. One option must be selected, but not both.
  • Option 1: Contains only the cmn:ToBusinessPartyLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:ToBusinessPartyInfo business address fielded data populated by the customer directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:ToBusinessPartyLookupId [0…1]
[0/*]		 String Required. Option 1 for ReceiverInfo | choice1% group. *252

A lookup identifier associated with the sold to business entity. Use this value as the lookup key in master data to populate the details in cmn: ToBusinessPartyInfo.
          @type [1…1]
[1/*]		 String Conditionally required if full business address not provided in cmn:ToBusinessPartyInfo option. The type of the sold to business entity identifier from the provided enumeration list. *253

See the BusinessLookupId enumeration list for valid values.
        cmn:ToBusinessPartyInfo [0…1]
[-]		 - Required. Option 2 for ReceiverInfo | choice1% group.

The full business information associated with the sold to business entity is provided.
          cmn:BusinessId [1…*]
[1/*]		 String Required. The return to business entity identifier. Mandatory for regulatory reporting. *254
            @type [1…1]
[1/*]		 String Required. The type of the cmn:BusinessId identifier. *255
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:BusinessClassification [0…1]
[0/*]		 String Business classification. *256

See the BusinessClassification enumeration list for valid values.
          cmn:BusinessInfo [0…1]
[-]		 - The sold to business entity business name and address.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *257
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *258
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *259
            cmn:Village [0…1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0…1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0…1]
[0/*]		 String District Code. *260
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *261
            cmn:PostalCode [1…1]
[0/*]		 String Required. The ZIP or other postal code. *262
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *263
            cmn:CorporateFax [0…1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0…1]
[0/*]		 String The global identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0…1]
[0/*]		 String The global house identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0…1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0…1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
        choice2% [0…1]
[-]		 Choice Optional choice element:
  • Option 1: Contains only the cmn:ShipToLocationLookupId.
    • Populate this element only if master data lookup is desired.
  • Option 2: Contains full cmn:ShipToLocationInfo business address fielded data populated by the customer directly in the interface.
    • Populate this element fully only if master data lookup is not desired.
        cmn:ShipToLocationLookupId [0…1]
[1/*]		 String Required. Option 1 for ReceiverInfo | choice2% group. *264

A lookup identifier associated with the ship to location using the enumeration list. Use this value as the lookup key in master data to populate the details in cmn:ShipToLocationInfo.
          @type [1…1]
[1/*]		 String Required. The type of the ship to location identifier. *265

See the LocationLookupId enumeration list for valid values.
        cmn:ShipToLocationInfo [0…1]
[-]		 - Conditionally required for US. Option 2 for ReceiverInfo | choice2% group.

The full business information associated with the ship to location is provided directly.

          cmn:FacilityId [0…*]
[0/*]		 String Required. Populated with the ship from location identifier. *266
            @type [1…1]
[1/*]		 String Required. The type of the cmn:FacilityId identifier. *267
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:LocationInfo [0…1]
[-]		 - Populated with the business name and address of the ship to location.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *268
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *269
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *270
            cmn:Village [0…1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0…1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0…1]
[0/*]		 String District Code. *271
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *272
            cmn:PostalCode [1…1]
[0/*]		 String Required. The ZIP or other postal code. *273
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *274
            cmn:CorporateFax [0…1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0…1]
[0/*]		 String The global identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0…1]
[0/*]		 String The global house identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0…1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0…1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
          cmn:LicenseNumber [0…*]
[0/*]		 String Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *275
            @state [0…1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. Used to give additional context to the license number. *276
            @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). Used to give additional context to the license number. *277
      cmn:CarrierInfo [0...*]
[-]		 - Conditionally required if ShipToCountryCode = BR. Information about the transportation partner that is transporting the shipment. cmn:CarrierInfo contains XML choice elements that govern whether master data lookup will be used to populate the address elements. Only one option in choice1% may be populated.
        choice1% [1…1]
[-]		 Choice Optional choice element: No error if neither are present.
  • Option 1: Contains only the cmn:CarrierBusinessPartyLookupId.
    • Populate this element ONLY if master data lookup is desired.
  • Option 2: Contains full cmn:CarrierBusinessPartyInfo business address fielded data that will be populated by the customer directly in the interface.
    • Populate this element fully ONLY if master data lookup is not desired.
        cmn:CarrierBusinessPartyLookupId [0…1]
[1/*]		 String Conditionally required if full business address not provided in cmn:CarrierBusinessPartyInfo option. Option 1 for CarrierInfo | choice1% group. *278

A lookup identifier associated with the Carrier entity from the enumeration list. This value is used as the lookup key in master data to populate the details in CarrierBusinessPartyInfo.

          @type [1…1]
[1/*]		 String Conditionally required if full business address not provided in cmn:CarrierBusinessPartyInfo option. The type of the carrier business entity identifier from the provided enumeration list. *279

See the BusinessLookupId enumeration list for valid values.
        cmn:CarrierBusinessPartyInfo [0…1]
[-]		 - Conditionally required if cmn:CarrierBusinessPartyLookupId to leverage master data lookup is not populated. Option 2 for CarrierInfo | choice1% group.

The full business information associated with the transportation carrier business entity is provided.

          cmn:BusinessId [1…*]
[1/*]		 String Required. The identifier associated with the transport carrier business entity. This value is mandatory for regulatory reporting. *280
            @type [1…1]
[1/*]		 String Required. The type of the cmn:BusinessId identifier. *281
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
          cmn:BusinessClassification [0…1]
[0/*]		 String N/A. *282
          cmn:BusinessInfo [0…1]
[-]		 - Populated with the business name and address of the transportation carrier business entity.
            cmn:BusinessName [1…1]
[0/*]		 String Required. The business name of the trading partner. *283
            cmn:Street1 [1…1]
[0/*]		 String Required. The first line of the street address. *284
            cmn:Street2 [0…1]
[0/*]		 String The second line of the street address.
            cmn:City [1…1]
[0/*]		 String Required. The city. *285
            cmn:Village [0…1]
[0/*]		 String Name of the village in which the company is located.
            cmn:HouseNumber [0…1]
[0/*]		 String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
            cmn:Township [0…1]
[0/*]		 String Name of the township in which the company is located.
            cmn:District [0…1]
[0/*]		 String District Code. *286
Must be a 3-digit numeric code.
            cmn:StateOrRegion [1…1]
[0/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *287
            cmn:PostalCode [1…1]
[0/*]		 String Required. The ZIP or other postal code. *288
            cmn:Country [0…1]
[0/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *289
            cmn:CorporateFax [0…1]
[0/*]		 String Company fax number.
            cmn:AddressObjectGUID [0…1]
[0/*]		 String The global identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:HouseGUID [0…1]
[0/*]		 String The global house identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum of 36 characters, using the digits 0-9 and letters A-F.
            cmn:TaxRegistrationCode [0…1]
[0/*]		 String The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
            cmn:PremisesCode [0…1]
[0/*]		 String Identifier representing a physical area within the company location (e.g. a location's second floor).
    cmn:WarehouseOperatorName [0…1]
[0/*]		 String Name of the person responsible for warehouse operations. This element can be communicated at any time (e.g. with, before, or after the order details or received items have been communicated). *290
    som:AddReceivedItems [0…1]
[-]		 - Required. List of serial numbers for the outermost handling units received for this delivery. TraceLink looks up the child aggregations of the serial numbers provided in the list and updates the container and all child items with the received and subsequent shipped status.

This element is mandatory before the delivery complete flag can be set, though it can be communicated at any time (e.g. with, before, or after the order details have been communicated).
      cmn:Serial [1…*]
[1/*]		 String Required. Serial number of an outermost handling unit received for this delivery. One serial number is included per received container (or item if shipping loose items). This is typically a pallet or case serial number. *291
        @format [0…1]
[0/*]		 C Required. Attribute that identifies format of serial numbers. *292

See the Format enumeration list for valid values.
        @orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem.
    som:Aggregation [0…1]
[-]		 - Communicates new aggregations created by the warehouse that are included in the shipment.

The PickedItems includes the top-level container serial numbers and loose items. If the warehouse creates a new aggregation (e.g. a new pallet or mixed case), the new aggregation hierarchies are communicated in the cmn:Aggregation element group.

If an existing case ships, the case must be scanned and the case hierarchy is not provided. If a new mixed case is created, the hierarchy for that new case is communicated.

This enables the distribution warehouse to locally manage changes to aggregation hierarchies. The warehouse communicates the new aggregation hierarchies of the shipped goods at the time of shipment without having to send disaggregation and aggregation events. TraceLink implicitly disaggregates and aggregates operations to achieve the end state hierarchy prior to processing the shipment. TraceLink also auto-commissions the SSCC numbers for new cases and pallets when these SSCC numbers are not yet commissioned.
      cmn:EventDateTime [1…1]
[0/*]		 Datetime Required. The date and time of aggregation event with the UTC time zone indicator in YYYY-MM-DDTHH:MM:SS.ssZ format. If not provided, the current GMT date time is used.
      cmn:EventLocation [1…1]
[1/*]		 String Required. Site-level SGLN of the location where the event occurs. SGLN format is the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).
      cmn:ParentSerial [1…1]
[1/*]		 String Required. Serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. Non-GS1 serial numbers (e.g. China) are expressed in native format.
        @companyPrefix [0…1]
[0/*]		 String The GS1 Company Prefix present in GTIN-14 and SSCC serial numbers.
        @filterValue [0…1]
[0/*]		 String The filter value present in GTIN-14 and SSCC serial numbers.
        @format [0…1]
[0/*]		 String The format of the serial numbers.

See the Format enumeration list for valid values.
        @packedStatus [0…1]
[0/*]		 String The packaging status of the container.

See the PackedStatus enumeration list for valid values.
      cmn:PackagingLevel [0…1]
[0/*]		 String The packaging level of the commissioned items in cmn:NumberList.

See the PackagingLevel enumeration list for valid values.
      cmn:NumberList [1…1]
[-]		 - Required. List of serial numbers for the items packed into the container serial number.
        cmn:Serial [1…*]
[1/*]		 String Required. Serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. AI(01)(21) formatted serial number for GTINs or AI(00) formatted serial number for SSCCs. Non-GS1 serial numbers (e.g. China) are expressed in native format.
          @companyPrefix [0…1]
[0/*]		 String The GS1 Company Prefix present in GTIN-14 and SSCC serial numbers.
          @filterValue [0…1]
[0/*]		 String The filter value present in GTIN-14 and SSCC serial numbers.
          @format [0…1]
[0/*]		 String The format of the serial numbers.

See the Format enumeration list for valid values.
          @packedStatus [0…1]
[0/*]		 String The packaging status of the container.

See the PackedStatus enumeration list for valid values.
          @orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem. 

<?xml version="1.0" encoding="UTF-8"?>
<som:SOMReceiptMessage xmlns:som="urn:tracelink:mapper:sl:serialized_operations_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <som:ControlFileHeader>
        <cmn:FileSenderNumber>712333444</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>512333444</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>201907250</cmn:FileControlNumber>
        <cmn:FileDate>2019-07-25</cmn:FileDate>
        <cmn:FileTime>18:09:45Z</cmn:FileTime>
    </som:ControlFileHeader>
    <som:MessageBody>
        <!--<cmn:LocationId type="DUNS4">1454852202864</cmn:LocationId>-->
        <cmn:LocationId>312333</cmn:LocationId>
        <cmn:DeliveryNumber>8425257855</cmn:DeliveryNumber>
        <cmn:DeliveryCompleteFlag>false</cmn:DeliveryCompleteFlag>
        <som:OrderDetails>
            <cmn:CorrectiveReceipt>true</cmn:CorrectiveReceipt>
            <cmn:OriginalDeliveryNumber>1234567</cmn:OriginalDeliveryNumber>						
            <cmn:EntryPort></cmn:EntryPort>
            <cmn:ExitPort></cmn:ExitPort>
            <cmn:TransactionIdentifier type="PO" date="2019-07-25">PO98</cmn:TransactionIdentifier>
            <cmn:TransactionDate>2019-07-25</cmn:TransactionDate>
            <cmn:ShipToCountryCode>RU</cmn:ShipToCountryCode>
            <cmn:ReceiptDistributionType>IMPORTPURCHASE</cmn:ReceiptDistributionType>
            <cmn:TransferWithoutShipment>false</cmn:TransferWithoutShipment>
            <cmn:SupplyType>MedicalCareDistribution</cmn:SupplyType>
            <cmn:ContractType>PrivateContract</cmn:ContractType>
            <cmn:Comments>Comments</cmn:Comments>
            <cmn:ContractNumber>C107</cmn:ContractNumber>
            <cmn:FundingSource>OwnFunds</cmn:FundingSource>
            <cmn:OrderItemList>
                <cmn:AllowShortVerificationCount>false</cmn:AllowShortVerificationCount>
                <cmn:OrderItem>
                    <cmn:OrderItemNumber>908</cmn:OrderItemNumber>
                    <cmn:InternalMaterialCode>133661</cmn:InternalMaterialCode>
                    <!--<cmn:PackagingItemCode type="NTIN">s17</cmn:PackagingItemCode>-->
                    <cmn:LotNumber>L807</cmn:LotNumber>
                    <cmn:ExpirationDate>2029-07-25</cmn:ExpirationDate>
                    <cmn:Quantity>10</cmn:Quantity>
                    <cmn:UnitPrice currencyCode="RUB">100.00</cmn:UnitPrice>
                    <cmn:VAT currencyCode="RUB">50.00</cmn:VAT>
                    <cmn:GrossPrice currencyCode="RUB">150.00</cmn:GrossPrice>
                    <cmn:IsSerialized>false</cmn:IsSerialized>
                    <cmn:TransactionIdentifier type="PO" date="2019-07-25">PO1078</cmn:TransactionIdentifier>
                </cmn:OrderItem>
            </cmn:OrderItemList>
            <cmn:SenderInfo>
                <!--<cmn:FromBusinessPartyLookupId type="KR_PROVIDER_CODE">s23</cmn:FromBusinessPartyLookupId>-->
                <cmn:FromBusinessPartyInfo>
                    <cmn:BusinessId type="DUNS">710040977</cmn:BusinessId>
                    <cmn:BusinessId type="GLN">8779891013658</cmn:BusinessId>
                    <cmn:BusinessClassification>MANUFACTURER</cmn:BusinessClassification>
                    <cmn:BusTransactionRole>ShipTo</cmn:BusTransactionRole>
                    <cmn:BusinessInfo>
                        <cmn:BusinessName>Clara Manufacturing</cmn:BusinessName>
                        <cmn:Street1>10 Welsh St</cmn:Street1>
                        <cmn:City>Malden</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>MA</cmn:StateOrRegion>
                        <cmn:PostalCode>02148</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000152</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:BusinessInfo>
                </cmn:FromBusinessPartyInfo>
                <!--<cmn:ShipFromLocationLookupId type="IN_LOCATION_ID">s38</cmn:ShipFromLocationLookupId>-->
                <cmn:ShipFromLocationInfo>
                    <cmn:FacilityId type="DEA">710040977</cmn:FacilityId>
                    <cmn:FacilityId type="SGLN">9997777.01994.0</cmn:FacilityId>
                    <cmn:LocationInfo>
                        <cmn:BusinessName>Clara Manufacturing</cmn:BusinessName>
                        <cmn:Street1>10 Welsh St</cmn:Street1>
                        <cmn:City>Malden</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>MA</cmn:StateOrRegion>
                        <cmn:PostalCode>02148</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000152</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbc</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:LocationInfo>
                    <cmn:LicenseNumber state="MA" agency="BORP">773BT8</cmn:LicenseNumber>
                    <cmn:ContactInfo>
                        <cmn:Name>Customer Service</cmn:Name>
                        <cmn:Telephone>+1-781-555-5622</cmn:Telephone>
                        <cmn:Email>support@claramanufacturing.com</cmn:Email>
                    </cmn:ContactInfo>
                </cmn:ShipFromLocationInfo>
            </cmn:SenderInfo>
            <cmn:ReceiverInfo>
                <cmn:ToBusinessPartyLookupId type="COMPANYSITEID">312333</cmn:ToBusinessPartyLookupId>
                <!--<cmn:ShipToLocationLookupId type="COMPANYSITEID">12346579963</cmn:ShipToLocationLookupId>-->
                <cmn:ShipToLocationInfo>
                    <cmn:FacilityId type="GLN">8887771013655</cmn:FacilityId>
                    <cmn:FacilityId type="COMPANYSITEID">312333</cmn:FacilityId>
                    <cmn:LocationInfo>
                        <cmn:BusinessName>Watson Rx Wholesaler Sacramento</cmn:BusinessName>
                        <cmn:Street1>555 Neelan Road</cmn:Street1>
                        <cmn:City>Sacramento</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>CA</cmn:StateOrRegion>
                        <cmn:PostalCode>95833</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000156</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbf</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:LocationInfo>
                    <cmn:LicenseNumber state="CA" agency="BOP">3333300008701</cmn:LicenseNumber>
                    <cmn:ContactInfo>
                        <cmn:Name>Watson Customer Service</cmn:Name>
                        <cmn:Telephone>+1-916-555-3301</cmn:Telephone>
                        <cmn:Email>support@watsonrxwholesaler.com</cmn:Email>
                    </cmn:ContactInfo>
                </cmn:ShipToLocationInfo>
            </cmn:ReceiverInfo>
            <cmn:CarrierInfo>
                <!--<cmn:CarrierBusinessPartyLookupId type="IN_COMPANY_ID">s95</cmn:CarrierBusinessPartyLookupId>-->
                <cmn:CarrierBusinessPartyInfo>
                    <cmn:BusinessId type="SGLN">8887777.01384.0</cmn:BusinessId>
                    <cmn:BusinessId type="GLN">8887771013655</cmn:BusinessId>
                    <cmn:BusinessClassification>WHOLESALER</cmn:BusinessClassification>
                    <cmn:BusTransactionRole>BillShipTo</cmn:BusTransactionRole>
                    <cmn:BusinessInfo>
                        <cmn:BusinessName>Watson Rx Wholesaler Sacramento</cmn:BusinessName>
                        <cmn:Street1>555 Neelan Road</cmn:Street1>
                        <cmn:City>Sacramento</cmn:City>
                        <cmn:Village></cmn:Village>
                        <cmn:HouseNumber></cmn:HouseNumber>
                        <cmn:Township></cmn:Township>
                        <cmn:StateOrRegion>CA</cmn:StateOrRegion>
                        <cmn:PostalCode>95833</cmn:PostalCode>
                        <cmn:Country>US</cmn:Country>
                        <cmn:CorporateFax></cmn:CorporateFax>
                        <cmn:AddressObjectGUID>19406454-0022-000C-00B0-000000000156</cmn:AddressObjectGUID>
                        <cmn:HouseGUID>986f2934-be05-438f-A30E-c15b90e15dbf</cmn:HouseGUID>
                        <cmn:TaxRegsitrationCode></cmn:TaxRegsitrationCode>
                        <cmn:PremisesCode></cmn:PremisesCode>
                    </cmn:BusinessInfo>
                </cmn:CarrierBusinessPartyInfo>
            </cmn:CarrierInfo>
        </som:OrderDetails>
        <cmn:WarehouseOperatorName>Operator</cmn:WarehouseOperatorName>
        <som:AddReceivedItems>
            <cmn:Serial format="AI(01)+AI(21)">015088202501033321100000060001</cmn:Serial>
            <cmn:Serial format="AI(01)+AI(21)">015088202501033321100000060002</cmn:Serial>
        </som:AddReceivedItems>
        <som:RemoveReceivedItems>
            <cmn:Serial format="AI(01)+AI(21)">015088202501033321100000060012</cmn:Serial>
        </som:RemoveReceivedItems>
    </som:MessageBody>
</som:SOMReceiptMessage>

Data Element Error Message Description
Class 1
cmn:BusinessId | @type Valid from business party BusinessId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Party type attribute is required if carrier party BusinessId is present !!! The error occurs if BusinessId is populated, but the source is empty or null.
Valid carrier party BusinessId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Party type attribute is required if source from business party cmn:BusinessId is present !!! The error occurs if BusinessId is populated, but the source is empty or null.
cmn:BusinessName Carrier name in source cmn:BusinessName is required if cmn:BusinessInfo is present !!! The error occurs if BusinessInfo is populated, but the source is empty or null.
cmn:CarrierBusinessPartyLookupId | @type Valid CarrierBusinessPartyLookupId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Party type attribute is required if source CarrierBusinessPartyLookupId is present !!! The error occurs if CarrierBusinessPartyLookupId is populated, but the source is empty or null.
cmn:City Carrier city in source cmn:BusinessName is required if cmn:BusinessInfo is present !!! The error occurs if BusinessInfo is populated, but the source is empty or null.
cmn:ContractType Valid Contract Type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:Country Carrier country in source cmn:BusinessName is required if cmn:BusinessInfo is present !!! The error occurs if BusinessInfo is populated, but the source is empty or null.
cmn:FacilityId Receiver facility location identifier is required if LocationInfo group is present !!! The error occurs if LocationInfo is present, but ShipToLocationLookupId is empty or null.
Ship from facility location identifier is required if LocationInfo group is present !!! The error occurs if LocationInfo is present, but ShipFromLocationLookupId is empty or null.
cmn:FacilityId | @type Valid ship to FacilityId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid party type attribute is required when ship to FacilityId is present !!! The error occurs if FacilityId is populated, but the source is empty or null.
Valid party type attribute is required when source ship from FacilityId is present !!! The error occurs if FacilityId is populated, but the source is empty or null.
Valid ship from FacilityId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:FromBusinessPartyLookupId | @type Party type attribute is required if source FromBusinessPartyLookupId is present !!! The error occurs if FromBusinessPartyLookupId is populated, but the source is empty or null.
Valid FromBusinessPartyLookupId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:LocationId Location ID is required !!! The error occurs if the source is empty or null.
cmn:OrderItem | choice%1

One of InternalMaterialCode OR PackagingItemCode OR CountryDrugCode is required !!!

The error occurs if cmn:InternalMaterialCode, cmn:PackagingItemCode, and cmn:CountryDrugCode are empty or null.

Only one of InternalMaterialCode OR PackagingItemCode OR CountryDrugCode is required !!!

The error occurs if more than one value is provided for cmn:InternalMaterialCode, cmn:PackagingItemCode, and cmn:CountryDrugCode.
cmn:PackagingItemCode | @type Valid Item Code Type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Product type attribute is required when source PackagingItemCode is present !!! The error occurs if PackagingItemCode is populated, but the source is empty or null.
cmn:PostalCode Carrier postal code in source cmn:BusinessName is required if cmn:BusinessInfo is present !!! The error occurs if BusinessInfo is populated, but the source is empty or null.
cmn:Quantity Quantity greater than 0 is required !!! The error occurs if the source is empty or null.
cmn:ReceiptDistributionType Valid receipt distribution type is required !!! The error occurs if the source is populated, but the source is empty or null.
cmn:ReceiverInfo | choice%1 Missing mandatory choice. One of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if neither ToBusinessPartyLookupId or ToBusinessPartyInfo are present.
Only one of ToBusinessPartyLookupId OR ToBusinessPartyInfo group is required !!! The error occurs if both ToBusinessPartyLookupId and ToBusinessPartyInfo are present.
cmn:ReceiverInfo | choice%2 Only one of ShipToLocationLookupId OR ShipToLocationInfo group is required !!! The error occurs if both ShipToLocationLookupId and ShipToLocationInfo are present.
cmn:SenderInfo | choice%1 Only one of FromBusinessPartyLookupId OR FromBusinessPartyInfo group is required !!! The error occurs if both FromBusinessPartyLookupId and FromBusinessPartyInfo are present.
Missing mandatory choice. One of FromBusinessPartyLookupId OR FromBusinessPartyInfo group is required !!! The error occurs if neither FromBusinessPartnerLookupId or FromBusinessPartyInfo are present.
cmn:SenderInfo | choice%2 Only one of ShipFromLocationLookupId OR ShipFromLocationInfo group is required !!! The error occurs if both cmn:ShipFromLocationLookupId and cmn:ShipFromLocationInfo are present.
cmn:ShipFromCountryCode Valid ShipTo Country Code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:ShipFromLocationLookupId | @type Valid ShipFromLocationLookupId is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid party type attribute is required when source ShipFromLocationLookupId is present !!! The error occurs if ShipFromLocationLookupId is populated, but the source is empty or null.
cmn:ShipToLocationLookupId | @type Valid party type attribute is required when source ShipToLocationLookupId is present !!! The error occurs if ShipToLocationLookupId is populated, but the source is empty or null.
Valid ShipToLocationLookupId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:StateOrRegion Carrier StateOrRegion in source cmn:BusinessName is required if cmn:BusinessInfo is present !!! The error occurs if BusinessInfo is populated, but the source is empty or null.
cmn:Street1 Carrier Street1 in source cmn:BusinessName is required if cmn:BusinessInfo is present !!! The error occurs if BusinessInfo is populated, but the source is empty or null.
cmn:SupplyType Valid Supply Type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:ToBusinessPartyLookupId | @type Party type attribute is required if source ToBusinessPartyLookupId is present !!! The error occurs if ToBusinessPartyLookupId is populated, but the source is empty or null.
Valid ToBusinessPartyLookupId type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:TransactionIdentifier Transaction identifier is required !!! The error occurs if the source is empty or null.
cmn:TransactionIdentifier | @type Valid Transaction Identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
cmn:UnitPrice | @currencyCode Currency Code is required if Unit Price exists !!! The error occurs if UnitPrice is populated, but the source is empty or null.
Class 2
@currencyCode CurrencyCode for shipping event for delivery <DeliveryNumber> not found. The error occurs if UnitPrice is populated, but the source is empty or null.
cmn:CarrierBusinessPartyLookupId Could not perform Master Data lookup to populate transportation carrier business address fields. <CarrierBusinessPartyLookupId / type> <CarrierBusinessPartyLookupId > is not configured in your Company or Partner Company Master Data. Please configure <CarrierBusinessPartyLookupId / type> <CarrierBusinessPartyLookupId > in Company or Partner Company Master Data, and reprocess the file. The error occurs if cmn:CarrierBusinessPartyLookupId | @type or the source is empty or null in Company or Partner Company Master Data.
cmn:ContractType Contract Type is required if Ship To Country Code = RU. The error occurs if cmn:ShipToCountryCode = "RU" but the source is empty or null.
cmn:FromBusinessPartyLookupId Could not perform Master Data lookup to populate sender business address fields. <FromBusinessPartyLookupId / type> <FromBusinessPartyLookupId> is not configured in your Company or Partner Master Data. Please configure <FromBusinessPartyLookupId / type> <FromBusinessPartyLookupId> in Company or Partner Master Data, and reprocess the file. The error occurs if cmn:FromBusinessPartyLookupId | @type or the source is empty or null in Company or Partner Company Master Data.
cmn:FundingSource Funding Source is required if Ship To Country Code is RU and Ship From Country Code is RU. The error occurs if both cmn:ShipToCountryCode and cmn:ShipFromCountryCode = "RU", but the source is empty or null.
cmn:Serial Serial Number <ParentSerial> reference in aggregation but not present in ReceivingEvent / NumberList The error occurs if the source is not present in ReceivingEvent | NumberList.
cmn:ShipFromLocationLookupId Could not perform Master Data lookup to populate sender shipping address fields. <ShipFromLocationLookupId / type> <ShipFromLocationLookupId> is not configured in your Company or Partner Location Master Data. Please configure <ShipFromLocationLookupId / type> <ShipFromLocationLookupId> in Company or Partner Location Master Data, and reprocess the file. The error occurs if cmn:ShipFromLocationLookupId | @type or the source is empty or null in Company or Partner Location Master Data.
cmn:ShipToLocationLookupId Could not perform Location Master Data lookup to populate receiver shipping address fields. <ShipToLocationLookupId / type> <ShipToLocationLookupId> is not configured in your Company Location Master Data nor in your Partner Location Master Data. Please configure <ShipToLocationLookupId / type> <ShipToLocationLookupId> in Company Location Master Data or in Partner Location Master Data (if the ship to location is a partner location) and reprocess the file. The error occurs if cmn:ShipToLocationLookupId | @type or the source is empty or null in Company or Partner Location Master Data.
cmn:ToBusinessPartyLookupId Could not perform Company Master Data lookup to populate receiver business address fields. <ToBusinessPartyLookupId / type> <ToBusinessPartyLookupId> is not configured in your Company Master Data. Please configure <ToBusinessPartyLookupId / type> <ToBusinessPartyLookupId> in Company Master Data, and reprocess the file. The error occurs if cmn:ToBusinessPartyLookupId | @type or the source is empty or null in Company or Partner Company Master Data.
cmn:transactionIdentifier | @date Order Item Transaction Identifier Date is required if Ship To Country Code = RU. The error occurs if cmn:ShipToCountryCode = "RU" but the source is empty or null.
cmn:UnitPrice Unit Price is required if Ship To Country Code is RU and Ship From Country Code is any of RU, AM, BY, KZ, KG. The error occurs if cmn:ShipToCountryCode = "RU" and cmn:ShipFromCountryCode = "AM", "BY", "KG", "KZ", or "RU", but the source is empty or null.
N/A Could not commission parent serial number <ParentSerial> because it is not an SSCC Number The error occurs if ParentSerial is not an SSCC Number.
Cannot perform operation on serial number <serial number> with serial number item state <item state>. This operation can only be performed when the serial number is Pending Receipt or Shipped. The error occurs if Serial Number was not shipped.
Serial Number <ParentSerial> reference in aggregation but not present in ReceivingEvent / NumberList The error occurs if validation fails regarding all top most parent serial numbers being present in ReceingEvent | NumberList elements.
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 Receipt (EPCIS v1.2)

This message uses the Park and Retry functionality. If a prerequisite condition for this message has not been met, TraceLink stops processing the task, returns the task to the queue, and then tries to process the task again every 15 minutes for up to 2 hours.

Message Type: SOM_ESM_RECEIPT

Info Exchange Display Name: ESM Receipt

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.

Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *293
  @creationDate [1…1]
[1/*]		 DateTime Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *294
  EPCISHeader [0…1]
[-]		 - 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 [1…1]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *295
      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]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *296

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String 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. *297

See the BusinessAndLocationId 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]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *298

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String 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. *299

See the BusinessAndLocationId enumeration list for valid values.
      sbdh:DocumentIdentification [1…1]
[-]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *300
        sbdh:TypeVersion [1…1]
[0/*]		 String 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. *301
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String 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. *302
        sbdh:Type [1…1]
[0/*]		 String Required. Identifies the document type. The sbdh:Type value is set to Events for a shipment event. *303
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime 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.
      extension [0…1]
[-]		 - Header extension area with master data attributes.
        EPCISMasterData [0…1]
[-]		 - Master data extension header. May contain business and location address information for receiving event.
Full GS1 conformance requires that all party master data be stored in the EPCIS header extension EPCISMasterData | VocabularyList | Vocabulary | VocabularyElementList | VocabularyElement. It is strongly urged that all business and location address information for the receiving event is sent in the VocabularyElement within the EPCISMasterData header extension.
          VocabularyList [1…1]
[-]		 - Required. Vocabulary list group master data elements.
            Vocabulary(1) [0…*]
[-]		 - Instance 1 of looping vocabulary group with discrete master data element groups for product code. Instance 1 of Vocabulary will occur once for all instances of item master data.
              @type [1…1]
[0/*]		 String Identifies product master data elements. Product master data is defined by VocabularyElement | @id.

Valid value: urn:epcglobal:epcis:vtype:EPCClass = product master data. *304
              VocabularyElementList [0…1]
[-]		 - List of vocabulary elements containing master data attributes for each unique product code.
                VocabularyElement [0…*]
[-]		 - Looping vocabulary element which identifies each unique China product code, NTIN, or SGTIN for product master data from epc serial number in ObjectEvent Commissioning: epcList/epc.

SSCC codes not included in VocabularyElement product master data.

To conform with GS1 standards, master data attributes should be sent in the VocabularyElement. Each unique SGTIN, NTIN, or China Product Code embedded in Commissioning event epcList/epc serial numbers should be sent in one instance of VocabularyElement.
                  @id [1…1]
[0/*]		 String Identifies the product code for which master data is being sent in the VocabularyElement loop. *305

VocabularyElement | @id = SGTIN, NTIN, or China Product Code with GS1-conformant urn or http prefix. These are the only values supported in this element. All other product identifier types will be sent as additional trade item types. SSCC codes are not identified in any part of the VocabularyElement group.

Product code, if provided, must match the product code embedded within the serial number in the epc code in one or more commissioning events.

China

  • Prefix: http://epcis.tracelink.com/hc/cn-edmc/obj/
  • Example: http://epcis.tracelink.com/hc/cn-edmc/obj/10230.*

NTIN

  • Prefix: urn:epc:id:sgtin:
  • Example: urn:epc:id:sgtin:415001647778.0.100000000022

SGTIN (strongly recommended for GS1 conformance)

  • Prefix: urn:epc:idpat:sgtin:
  • Example: urn:epc:idpat:sgtin:0030001.0012345.*
                  attribute [1…1]
[1/*]		 String Conditionally required if item master data attributes sent in VocabularyElement. Instance 1 of attribute for packaging level value identified by @id. *306

See the PackagingLevel enumeration list for valid values.
                    @id [1…1]
[0/*]		 String Required. Attribute identifying packaging level.

Valid value: http://epcis.tracelink.com/mda/packageTypeCode *307
                  attribute [0…1]
[0/*]		 String Instance 2 of attribute for internal material number in Pharmaceutical Manufacturer's internal system identified by @id. Identified by the value in attribute element (instance 3) in the current loop = MANUFACTURER_PART_NUMBER. *308
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying internal material code.

Valid value: urn:epcglobal:cbv:mda#additionalTradeItemIdentification *309
                  attribute [0…1]
[0/*]		 String Conditionally required if the previous name/value pair attribute | @id (instance 2) is populated. Instance 3 of attribute for internal material number identifier type for the product.

Valid value: MANUFACTURER_PART_NUMBER *310

Sequence of fields for internal material number is:

  1. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">100335</attribute>
  2. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode">MANUFACTURER_PART_NUMBER</attribute>
If this sequence is not followed as documented above in the input file, the internal material number will not be mapped into the TraceLink system and no error will be thrown.
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying internal material code.

Valid value: urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode *311
                  attribute [0…1]
[0/*]		 String Instance 4 of attribute for country drug code for all national drug code types, identified by the enum value in the next attribute element (instance 5) in the current loop and by the attribute | @id value as an additional trade item. *312

Country drug code type defined by value in next attribute element (instance 5) where @id = urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode OR http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode
                    @id [1…1]
[0/*]		 String Id attribute identifying internal material code.

Valid value: urn:epcglobal:cbv:mda#additionalTradeItemIdentification *313
                  attribute [0…1]
[0/*]		 String Conditionally required if the previous name/value pair attribute | @id (instance 4) is populated. Instance 5 of attribute for country drug code identifier type. Must follow attribute with country drug value. *314

Sequence of fields for country drug code is:

GS1:

  1. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">82025030221</attribute>
  2. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode">FDA_NDC_11</attribute>

TraceLink:

  1. <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">82025030221</attribute>
  2. <attribute id="http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode">US_NDC442</attribute>
If this sequence is not followed as documented above in the input file, the internal material number will not be mapped into the TraceLink system and no error will be thrown.

The following qualifiers have been defined by GS1 as additional trade item types:

  • MANUFACTURER_PART_NUMBER = Internal material number
  • FDA_NDC_11 = US NDC542
  • DIN = Canada Drug ID number
  • PHARMACODE_CH = Swiss Pharma Code
  • NAN = Nordic article number

To identify these material number types, use attribute| @id string: urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode.

For all other country drug code types, use attribute | @id string: http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode.

See the CountryDrugCode enumeration list for valid values.
                    @id [1…1]
[0/*]		 String Required. Id attribute identifying country drug code type. Valid values: *315
  • GS1: urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode
  • TraceLink: http://epcis.tracelink.com/mda/additionalTradeItemIdentificationTypeCode
            Vocabulary(2) [0…*]
[-]		 - Instance 2 of vocabulary element with party master data element groups.
Group is optional. If it does not appear in master data header extension, no error will be thrown.

If the group is populated, Vocabulary occurs once for all instances of party address master data present in the message.

              @type [1…1]
[0/*]		 String Required. Vocabulary type identifying location master data elements. Master data type defined by VocabularyElement | @id.

Valid value: urn:epcglobal:epcis:vtype:Location = party master data. *316

From business party, ship-from, to business party, and ship-to for receiving event all tracked in header master data. Party data in receiving event to be mapped from header master in Vocabulary.
              VocabularyElementList [0…1]
[-]		 - List of vocabulary elements that includes all partner master information. Party identifiers and address info are stored in instances of the looping group VocabularyElement.
                VocabularyElement [0…1]
[-]		 - Looping group header for data elements that identify all business party and location master data, including identifiers, identifier types, and address info.

VocabularyElement repeats once for each party type:

  • Sold/Transfer from business party (Mandatory if group is populated)
  • Ship from location (Optional)
  • Sold/Transfer to business party (Mandatory if group is populated)
  • Ship to location (Optional)
  • Carrier (Optional)
Note:
  • If party address info is added to Vocabulary element in message header, create one instance of VocabularyElement for each party type created.
  • Master Data lookup is supported. If Partner Master Data is available in TraceLink, indicate master data lookup by sending partner identifiers in the sourceList and destinationList of the receiving event and do not include any address data in any VocabularyElement group.
  • If Master Data lookup is not intended, send complete address information for at least the sold-from and sold-to partners in the header Master Data extension. Ship-from and ship-to addresses can also be included.
                  @id [1…1]
[0/*]		 String Required. SGLN or other partner identifier and type for party master data in VocabularyElement. *317

Must match sourceList or destinationList owning, or location party in receiving event from ObjectEvent | extension | sourceList | source (transfer from, carrier) OR ObjectEvent | extension | destinationList | destination (transfer to).

The identifier value is mandatory for regulatory reporting. The identifier type must include a valid urn or http string prefix. Valid prefix formats include by namespace:

  • GS1: urn:epc:id:sgln:[CompanyPrefix].[LocationReference].[Extension]
  • GS1 USHC: http://epcis.gs1us.org/hc/[identifierType]/loc/[identificationValue]
  • GS1 Brazil: http://epcis.gs1br.org/hc/[identifierType]/loc/[identificationValue]
  • TraceLink: http://epcis.tracelink.com/hc/[identifierType]/loc/[identificationValue]

GLN is not supported, only SGLN.

See the MDPartyTypeAttributes enumeration list for valid values.
                  attribute(1) [1…1]
[0/*]		 String Conditionally required. Looping name/value pairs which identify partner address master data elements. This is the value element in the name/value pair attribute | @id. Stores master data item value defined by @id. *318

Partner master data items currently supported:

Create one instance of the name/value pair attribute and attribute | @id for each master data element returned.
                    @id [1…1]
[0/*]		 String Required. The name in the name/value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix. Valid values: *319
  • urn:epcglobal:cbv:mda#name
  • urn:epcglobal:cbv:mda#streetAddressOne
  • urn:epcglobal:cbv:mda#streetAddressTwo
  • urn:epcglobal:cbv:mda#streetAddressThree
  • urn:epcglobal:cbv:mda#city
  • http://epcis.tracelink.com/mda/district
  • http://epcis.tracelink.com/mda/village
  • http://epcis.tracelink.com/mda/houseNumber
  • http://epcis.tracelink.com/mda/township
  • http://epcis.tracelink.com/mda/corporateFax
  • urn:epcglobal:cbv:mda#state
  • urn:epcglobal:cbv:mda#postalCode
  • urn:epcglobal:cbv:mda#countryCode
  • http://epcis.tracelink.com/mda/AddressObjectGUID
  • http://epcis.tracelink.com/mda/HouseGUID
  • http://epcis.tracelink.com/mda/partyRoleCode
  • http://epcis.tracelink.com/mda/premisesCode
  • http://epcis.tracelink.com/mda/taxRegistrationCode
                  attribute(2) [0…*]
[0/*]		 String Required. Looping name/value pairs identifying additional party identifier elements. This is the value element in the name/value pair attribute | @id. Stores additional party identifiers and identifier types defined by @id. *320

Partner master data items currently supported:

  • Additional party identifier - Optional (1 or more supported).
  • Additional party identifier type - Optional (1 or more supported).

Create one instance of the name/value pair attribute and @id for each master data element returned. Must send the additional party identifiers in a double attribute combination using the following sequence:

  1. Attribute 1 identifies and provides the party identifier value.
  2. Attribute 2 identifies the party identifier type.

For example:

  1. <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationValue">10023141</attribute>
  2. <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode">DUNS_PLUS_FOUR</attribute>

OR

  1. <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">10023141</attribute>
  2. <attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DUNS4</attribute>
If this sequence of double attributes is not followed for additional party identifiers, the additional party identifier will not be mapped to the TraceLink system and no error will be thrown.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.
                    @id [1…1]
[0/*]		 String Required. Provides the name in the name/value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix. Valid values: *321
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationValue
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode
  EPCISBody [1…1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1…1]
[-]		 - Required. The EventList has the following structure:
  • ObjectEvent (0 or more for commissioning).
  • AggregationEvent (One or more for aggregation).
  • ObjectEvent (One for shipping).
Order of events is not enforced by the schema.
      choice [1…1]
[-]		 - Required. Only one of the following choice options may be selected in any one loop on EPCISBody | EventList: ObjectEvent OR AggregationEvent.
      ObjectEvent [0…*]
[-]		 - Choice 1 for EventList. Data = ObjectEvent for the Commissioning Events.

EventList = ObjectEvent Commissioning when all of the following is true:

  • action = ADD
  • bizStep = urn:epcglobal:cbv:bizstep:commissioning
  • disposition = urn:epcglobal:cbv:disp:active
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Includes a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *322
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect time and place where the event occurred, consistent with what choice is made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *323
        epcList [1…1]
[-]		 - Required. The EPCs of each item, case, and/or pallet commissioned.
          epc [1…*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *324
        action [1…1]
[0/*]		 String Required. The action value must equal ADD. *325
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:commissioning. *326
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:active. *327
        readPoint [0…1]
[-]		 - The readPoint element is optional in commissioning event.
          id [1…1]
[0/*]		 AnyURI 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. *328
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizLocation [0…1]
[-]		 - Required. Business location is mandatory in commissioning event.
          id [1…1]
[1/*]		 AnyURI 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. *329
        extension [0…1]
[-]		 - Main extension body for commission event.
          ilmd [0…1]
[-]		 - Instance lot master data specific to product being commissioned.
            cbvmda:lotNumber [0…1]
[0/*]		 String The lot or batch code for the serialized item in an alphanumeric string of up to 20 characters. *330
            cbvmda:itemExpirationDate [0…1]
[0/*]		 Date The expiration date for the serialized item, in YYYY-MM-DD format. *331
            tl:commissionEventExtensions [0…1]
[-]		 - Extensions used for Commission ObjectEvent.

The following items can be sent in the master data header extensions:

  • tl:packagingLevel
  • tl:internalMaterialCode
  • tl:packagingItemCode
  • tl:packagingItemCode | @type
  • tl:countryDrugCode
  • tl:countryDrugCode | @type
Full GS1 conformance requires all master data be stored in the header extension EPCISMasterData | VocabularyList. While master data can be sent from the commissioning event extensions, it is strongly urged that all product master data items for the commissioning event be sent in the header extensions elements.
              tl:filterValue [0…1]
[-]		 Int tl:filterValue is used only if it is required by a trade partner to convert SSCC to GS1 HEX or Tag URI format.

See the FilterValue enumeration list for valid values.
              tl:packagingLevel [0…1]
[0/*]		 String The packaging level of the commissioned item using the supported enumeration values. *332
To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data (i.e. a homogenous pallet).

See the PackagingLevel enumeration list for valid values.
              tl:epcAttributes [0…*]
[-]		 - Supports optional inclusion of human readable barcode content associated with each epc number in a commission event. Included only if provided in original commission event.
                @epc [1…1]
[1/*]		 String Conditionally required. The EPC serial number to which the barcodeContent is associated. The epc must be an EPC Pure Identity URI as specified in Section 6 of [TDS1.5]. *333
  • Case: SGTIN or SSCC
  • Item: SGTIN
  • Pallet: SSCC
                tl:barcodeContent [1…1]
[1/*]		 String Required. The human readable barcode contents encoded in the 2D barcode with parentheses for the AI keys. *334
              tl:plantLocationId [0…1]
[0/*]		 String Identifier of plant where products were commissioned. *335
              tl:productionLineId [0…1]
[1/*]		 String Identifier of production line where products were commissioned. *336
              tl:lineManagerName [0…1]
[0/*]		 String Name of the person responsible as the production line manager for the commissioned products .
              tl:companyPrefix [0…1]
[0/*]		 String Not used.
              tl:internalMaterialCode [0…1]
[0/*]		 String Internal material number for the product in the Pharmaceutical Manufacturer's internal systems (e.g. ERP). *337
To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data.
              tl:packagingItemCode [0…1]
[0/*]		 String The product code for the commissioned item (e.g. GTIN-14). *338
                @type [1…1]
[1/*]		 String Required. The product code type using the supported enumeration values. *339

See the ItemCode enumeration list for valid values.
              tl:countryDrugCode [0…1]
[0/*]		 String The national drug code for the commissioned item (e.g. NDC number for US products). *340
To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data.
                @type [0…1]
[0/*]		 String The national drug code type using the supported enumeration values and any formatting instructions provided. *341
To be GS1 EPCIS-conformant, send this value in the VocabularyElement master data, unless current item has an SSCC code with associated product master data.

See the CountryDrugCode enumeration list for valid values.
              tl:manufacturingDate [0…1]
[0/10]		 Date The date of manufacture for the serialized item, in YYYY-MM-DD format. *342
              tl:countryMarket [0…1]
[0/3]		 Date ISO Country code for target country market for which the product was manufactured. Used for triggering production notifications associated with a produced batch. If batch is multi-market, then production notification will be triggered at time of shipment and this field would not be populated. *343

See the ISOCountryCode enumeration list for valid values.
              tl:referenceDocuments [0…1]
[-]		 - Reference document identifier associated with the commissioning activity.
                tl:poNumber [0…1]
[0/*]		 String PO Number associated with serial number use. *344
                tl:poLine [0…1]
[0/*]		 String PO Line number. *345
                tl:workOrderNumber [0…1]
[0/*]		 String Work Order number associated with serial number use. *346
                tl:referenceIdentifier [0…1]
[0/*]		 String Reference identifier (e.g. any type of identifier) associated with serial number use. *347
              tl:extensionField [0…*]
[-]		 - One or more name/value pairs which contains additional data attributes not already supported in this message.

When this attribute is populated, both the tl:fieldName and tl:fieldValue elements must be populated.

These extensions are not stored by TraceLink and are only used for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this message (e.g. when a CMO is required to provide additional data fields to the brand owner). Different trade partners may have different field requirements and may require that the ExtensionField be populated differently per trade partner.
                tl:fieldName [1…1]
[1/*]		 String Field name provided by the trade partner that will receive the outbound message. *348
The field name must match the field name provided by the trade partner exactly, including case so that it can be properly detected in the outbound mapping.
                tl:fieldValue [1…1]
[1/*]		 String Field value that corresponds to tl:fieldName. *349
      AggregationEvent [0…*]
[-]		 - AggregationEvent is option 2 for the EventList choice for the Aggregation events.

EventList = AggregationEvent when all of the following is true:

  • action = ADD
  • bizStep = urn:epcglobal:cbv:bizstep:packing
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *350
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *351
        parentID [1…1]
[1/*]		 AnyURI Required. An identifier of the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPC is of the case; for a case-to-pallet aggregation, the EPC is of the pallet). See EPC Pure Identifier Format Examples. *352
        childEPCs [1…1]
[-]		 - Required. This element contains a list of identifiers, including the child items, in the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPCs is of the items; for a case-to-pallet aggregation, the EPCs is of the cases).
          epc [1…*]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *353
        action [1…1]
[1/*]		 String Required. The action value must equal ADD for aggregation event.
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:packing. *354
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *355
        readPoint [0…1]
[-]		 - Optional for Aggregation Event.
          id [1…1]
[0/*]		 AnyURI 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. *356
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizLocation [0…1]
[-]		 - Required. The bizLocation is mandatory for Aggregation Event.
          id [1…1]
[0/*]		 AnyURI 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.
        tl:aggregationEventExtensions [0…1]
[-]		 - Extensions used for Aggregation Event.
          tl:packedStatus [0…1]
[0/*]		 String The packout of the item or container using the supported enumeration values. *357

See the PackedStatus enumeration list for valid values.
          tl:quantity [0…1]
[-]		 Int The quantity of child serial numbers aggregated to the parent container in this aggregation. *358
          tl:resetContainerAggregation [0…1]
[-]		 Boolean Reset container aggregation flag. *359
          tl:epcOrderItemDetails [0…1]
[-]		 - Group header for epcOrderItemDetails with a specific link between tl:orderItem | tl:orderItemNumber in the receiving event and the epc serial number.
            tl:epcOrderItemList [1…*]
[-]		 - Subgroup header.
              @orderItemNumber [0…1]
[-]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of tl:orderItem, in EPC Pure Identity URI format.
              tl:epcOrderItem [1…*]
[-]		 String Serial numbers associated with the pricing and tax information in the current instance of the ItemOrder.
          tl:extensionField [0…*]
[-]		 - One or more name/value pairs which contains additional data attributes not already supported in this message.

When this attribute is populated, both the tl:fieldName and tl:fieldValue elements must be populated.

These extensions are not stored by TraceLink and are only used for outbound mapping purposes when there is a requirement to provide additional data to a trade partner for this message (e.g. when a CMO is required to provide additional data fields to the brand owner). Different trade partners may have different field requirements and may require that the ExtensionField be populated differently per trade partner.
            tl:fieldName [1…1]
[1/*]		 String Field name provided by the trade partner that will receive the outbound message. *360
The field name must match the field name provided by the trade partner exactly, including case so that it can be properly detected in the outbound mapping.
            tl:fieldValue [1…1]
[1/*]		 String Field value that corresponds to the tl:fieldName. *361
      ObjectEvent [1…1]
[-]		 - Required. EventList. Data = ObjectEvent for Receiving events.

EventList = ObjectEvent Receiving when all of the following is true:

  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:receiving
  • disposition = urn:epcglobal:cbv:disp:in_progress
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *362
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *363
        epcList [1…1]
[-]		 - Required. List of the EPCs of top most containers (e.g. pallets, cases) in the shipment.
          epc [1…*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *364
        action [1…1]
[0/*]		 String Required. The action value must equal OBSERVE. *365
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must equal urn:epcglobal:cbv:bizstep:receiving. *366
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must equal urn:epcglobal:cbv:disp:in_progress. *367
        readPoint [0…1]
[-]		 - Required. The location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin) in URN format, that recorded the Object event.
          id [1…1]
[0/*]		 AnyURI 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. *368
        bizLocation [0…1]
[-]		 - Not used.
          id [1…1]
[1/*]		 AnyURI Required. Not used. *369
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizStep = urn:epcglobal:cbv:bizstep:shipping. This element contains a list of the business transaction identifiers.
          bizTransaction [1…*]
[0/*]		 AnyURI Required. The business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or Invoice and/or Purchase Order governing this shipment, which are subject to Section 8.4.2 of (CBV1.0). The GLN that occurs after urn:epcglobal:cbv:bt: is the GLN of the party that issued the number (e.g. if customer issues PO Number, customer GLN is entered. If supplier issues ASN/delivery number supplier GLN is entered). *370
A delivery number or ASN is mandatory, all other transaction types are optional.

The transaction number requirements vary by region. It is recommended that the following are always provided, when available, to fulfill compliance needs:

  • Purchase Order Number
  • Invoice Number
  • ASN
            @type [1…1]
[1/*]		 String Required. The transaction identifier type using the supported enumeration values (e.g. PO, ASN, RETURN).  *371
A delivery number or ASN is mandatory, all other transaction types are optional.

See the TransactionId enumeration list for valid values.
            @date [0…1]
[0/*]		 Date The transaction identifier date. *372
        extension [0…1]
[-]		 - Main extension body for receiving event.
Source and Destination lists are optional even if party address master data is not stored in the VocabularyElement in the EPCISMasterData extension in the message header.
          sourceList [0…1]
[-]		 -

Source list identifying sending business, location, and carrier parties.

sourceList supports one of two functions:

  • VocabularyElement populated with party address master data: sourceList identifies sold-from, ship-from, or carrier party. Party master data mapped from VocabularyElement.
  • VocabularyElement NOT populated with party address master data: sourceList party identifiers used for master data lookup in backend.
            source [1…*]
[0/*]		 String Required. Source party identifier for sold-from, ship-from, or carrier parties. Party identifier in source either: *373
  1. Identifies sold-from, ship-from, or carrier party in populated VocabularyElement. Party address info mapped from VocabularyElement. Nothing is mapped from VocabularyElement if there is no match between party identifier in sourceList | source and VocabularyElement | @id.
  2. sourceList | source supports master data lookup in TraceLink system. VocabularyElement is NOT populated or there is NO match between party identifiers in source and VocabularyElement | @id.
If ship-from party the same as sold-from party, ship-from identifier does not need to be included.

See the MDPartyTypeAttributes enumeration list for valid values.
              @type [1…*]
[0/*]		 String Required. Type of source party identifier [i.e. owning (sold-from), location (ship-from), or carrier party.] Valid values: *374
  • Ship-from party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
          destinationList [0…1]
[-]		 - Required.

Identifies receiving business or location parties.

destinationList supports one of two functions:

  1. VocabularyElement populated with party address master data: destinationList identifies sold-to, ship-to parties. Party master data mapped from VocabularyElement.
  2. VocabularyElement NOT populated with party address master data: destinationList party identifiers used for master data lookup in backend.
            destination [1…*]
[0/*]		 String Required. Destination party identifier for sold-to or ship-to parties. Party identifier in destination either: *375
  1. Identifies sold-to or ship-to parties in populated VocabularyElement. Party address info mapped from VocabularyElement. Nothing is mapped from VocabularyElement if there is no match between party identifier in destinationList | destination and VocabularyElement | @id.
  2. destinationList | destination supports master data lookup in TraceLink system. VocabularyElement is NOT populated or there is NO match between party identifiers in destination and VocabularyElement | @id
If ship-to party the same as sold-to party, ship-to identifier does not need to be included.

See the MDPartyTypeAttributes enumeration list for valid values.
              @type [1…*]
[0/*]		 String Conditionally required. Identifies type of destination party identifier, i.e. owning (sold-to) or location (ship-to) party. Valid values: *376
  • Sold-to party = urn:epcglobal:cbv:sdt:owning_party.
  • Ship-to party = urn:epcglobal:cbv:sdt:location (only include if identifier different from owning_party).
        tl:locationId [0…1]
[0/*]		 String Location. *377
          @type [0…1]
[0/*]		 String Attribute identifies the location types. See the LocationIdType enumeration list for valid values: *378
        tl:receivingEventExtensions [0…1]
[-]		 - Extensions used for Receiving Event.
          tl:transactionDate [1…1]
[-]		 Date Required. Date associated with the business transaction document in bizTransactionList in YYYY-MM-DD format. This date may or may not be the same as the eventTime. *379
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. 2 or 3 letter ISO country code for ship to country. This value will be referenced to advise regulatory reporting if it is mandatory for the specified country market. *380

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in TraceLink.
          tl:shipFromCountryCode [0…1]
[2/2]		 String 2 or 3 letter ISO country code for ship from country. This value will be referenced to advise regulatory reporting if it is mandatory for the specified country market. *381

Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in TraceLink.
          tl:receiptDistributionType [1…1]
[1/*]		 String Required. Informs what types of regulatory reporting may be triggered based on the nature of the transaction: a purchase, transfer, or return within the same country or from another country. Valid values: *382
  • INCOUNTRYPURCHASE: Purchase made within the same country.
  • IMPORTPURCHASE: Purchase made into one country from another.
  • INCOUNTRYTRANSFER: Transfer made within the same country.
  • IMPORTTRANSFER: Transfer made into one country from another.
  • INCOUNTRYRETURN: Return made within the same country.
  • IMPORTRETURN: Return made into one country from another.
          tl:supplyType [0…1]
[0/*]		 String Conditionally required depending on the country. Identifies the type of supply that is being performed using a valid value from the enumerations list.
Country Requirements:

Mandatory if cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN; All values except for Collection apply.

See the SupplyType enumeration list for valid values.
          tl:contractType [0…1]
[0/*]		 String Conditionally required if cmn:ShipFromCountryCode = KR and cmn:ReceiptDistributionType = EXPORTSALE or EXPORTRETURN. Identifies the type of contract for the sale of goods using a valid value from the enumerations list.

See the ContractType enumeration list for valid values.
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with delivery.
          tl:contractNumber [0…1]
[0/*]		 String Identification number of the contract. *383
          tl:fundingSource [0…1]
[0/*]		 String Required. Source of the funding. *384

See the FundingSource enumeration list for valid values.
          tl:transferWithoutShipment [0…1]
[0/*]		 String

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state.
  • false – (default) Serial numbers are in the Pending Receipt state.

Only use when tl:receiptDistributionType = INCOUNTRYTRANSFER or IMPORTTRANSFER.
          tl:entryPort [0…1]
[0/*]		 String

Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint).
          tl:exitPort [0…1]
[0/*]		 String

Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint).
          tl:deliveryInspection [0…1]
[0/*]		 String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.
          tl:deliveryInspectionDate [0…1]
[10/10]		 Date The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format. *385
          tl:deliveryInspectionNote [0…1]
[0/*]		 String Comments about the physical delivery inspection against the delivery documentation.
          tl:removalFromCirculation [0…1]
[0/*]		 String

Reason the product in the delivery is taken out of the supply chain.

See the RemovalFromCirculation enumeration list for valid values.
          tl:aggregationInspection [0…1]
[0/*]		 String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.
          tl:epcOrderItemDetails [0…1]
[-]		 - Group header with specific link between the aggregation event epc and @orderItemNumber.
            tl:epcOrderItemList [1…*]
[-]		 - Required. Subgroup header.
              @orderItemNumber [0…1]
[0/*]		 String Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of tl:orderItem.
              tl:epcOrderItem [1…*]
[1/*]		 String Required. Serial numbers associated with the pricing and tax information in the current instance of tl:orderItem.
          tl:orderItemList [0…1]
[-]		 - Order item list group is populated to communicate the pick quantities for each item code at the EACH (unit) level.
            tl:orderItem [1…*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number and quantity for each item in the order. Each unique item code and lot number are communicated in a separate order item group.
              tl:orderItemNumber [0…1]
[0/*]		 String Associates the specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of tl:orderItem, in EPC Pure Identity URI format.
              choice%1 [-]
[-]		 -

Conditionally required if tl:shipFromCountryCode = KR. Populate only one of tl:InternalMaterialCode, tl:PackagingItemCode, or tl:countryDrugCode. One of the three options must be present.

              tl:internalMaterialCode [0…1]
[1/*]		 String Conditionally required if neither tl:packagingItemCode nor tl:countryDrugCode is populated. Option 1 for choice%1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *386
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:countryDrugCode is populated. Option 2 for choice%1 in OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *387
                @type [0…1]
[0/*]		 String Required. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14).

See the ItemCode enumeration list for valid values.
              tl:countryDrugCode [0…1]
[0/*]		 String Conditionally required if neither tl:internalMaterialCode nor tl:packagingItemCode is populated. Option 3 for choice%1 in OrderItem. Use to identify the product using the country drug code configured in Product Master Data. *388
                @type [0…1]
[0/*]		 String Required. The national drug code type using the supported enumeration values (e.g. US_NDC442).

See the CountryDrugCode enumeration list for valid values.
              cbvmda:lotNumber [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and IsSerialized = false. The lot or batch code for the items to be picked (if available) in an alphanumeric string. *389
              cbvmda:itemExpirationDate [0…1]
[1/*]		 Date The expiration date for the serialized item, in YYYY-MM-DD format. *390
              tl:quantity [1…1]
[-]		 Int Conditionally required if tl:shipFromCountryCode = KR and IsSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. *391
              tl:unitPrice [0…1]
[0/*]		 Decimal Required. Unit price of item. *392
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *393

See the ISOCurrency enumeration list for valid values.
              tl:vat [0…1]
[-]		 Decimal Value Added Tax per unit. *394
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *395

See the ISOCurrency enumeration list for valid values.
              tl:grossPrice [0…1]
[-]		 Decimal Gross price including unit price and all taxes and fees. *396
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *397

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is not serialized. If omitted, defaults value to true. *398
              tl:transactionIdentifier [0…*]
[0/*]		 String Transaction identifier at the line-item level of shipment. More than one transaction identifier may be present. *399
                @type [1…1]
[1/*]		 String

Required.

The transaction identifier type. Valid values:
  • DESTRUCTION
  • INVOICE
  • NOTAFISCAL
  • OTHER
  • PO
  • RETURN
                @date [0…1]
[0/*]		 Date Required. The transaction identifier date. *400
          tl:warehouseOperatorName [0…1]
[0/*]		 String Name of the person responsible for warehouse operations. *401
          tl:correctiveReceipt (missing or bad snippet)0…1(missing or bad snippet)
(missing or bad snippet)0/*(missing or bad snippet)		 Boolean

Indicates that a new Serialized Operations Manager receipt is correcting a previously voided Serialized Operations Manager receipt. Valid values:

  • false – (default) The receipt is not a corrective receipt.
  • true – The receipt is a corrective receipt.
          tl:originalDeliveryNumber (missing or bad snippet)0…1(missing or bad snippet)
(missing or bad snippet)0/*(missing or bad snippet)		 String Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt. 

<?xml version="1.0" encoding="UTF-8"?><epcis:EPCISDocument xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:gs1ushc="http://epcis.gs1us.org/hc/ns" 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="2017-08-31T17:45:20.0Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8779891013658</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8887771013655</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>2019082106310032</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-07-25T15:39:53Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
        <extension>
            <EPCISMasterData>
                <VocabularyList>
                    <Vocabulary type="urn:epcglobal:epcis:vtype:EPCClass">
                        <VocabularyElementList>
                            <VocabularyElement id="urn:epc:idpat:sgtin:068202.0401034.11220207024596">
                                <attribute id="http://epcis.tracelink.com/mda/packageTypeCode">CS</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentification">133661</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#additionalTradeItemIdentificationTypeCode">MANUFACTURER_PART_NUMBER</attribute>
                            </VocabularyElement>
                        </VocabularyElementList>
                    </Vocabulary>
                    <Vocabulary type="urn:epcglobal:epcis:vtype:Location">
                        <VocabularyElementList>
                            <VocabularyElement id="urn:epc:id:sgln:9997777.01994.0">
                                <attribute id="urn:epcglobal:cbv:mda#name">Clara Manufacturing</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">712333444</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DEA</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/partyRoleCode">MANUFACTURER</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#streetAddressOne">10 Welsh St</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#city">Malden</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/district"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/village"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/houseNumber"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/township"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/corporateFax"></attribute>
                                <attribute id="urn:epcglobal:cbv:mda#state">MA</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#postalCode">02148</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#countryCode">US</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/premisesCode"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/taxRegistrationCode"></attribute>
                            </VocabularyElement>
                            <VocabularyElement id="urn:epc:id:sgln:8887777.01384.0">
                                <attribute id="urn:epcglobal:cbv:mda#name">Watson Wholesaler</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifier">512333444</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/additionalIdentifierType">DEA</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/businessClassification">WHOLESALER</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#streetAddressOne">555 Neelan Road</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#city">Sacramento</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/district"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/village"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/houseNumber"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/township"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/corporateFax"></attribute>
                                <attribute id="urn:epcglobal:cbv:mda#state">CA</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#postalCode">95833</attribute>
                                <attribute id="urn:epcglobal:cbv:mda#countryCode">US</attribute>
                                <attribute id="http://epcis.tracelink.com/mda/premisesCode"></attribute>
                                <attribute id="http://epcis.tracelink.com/mda/taxRegistrationCode"></attribute>
                             </VocabularyElement>
                        </VocabularyElementList>
                    </Vocabulary>
                </VocabularyList>
            </EPCISMasterData>
        </extension>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2019-09-25T00:12:23.8307Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sscc:005434.40000000020</epc>
                </epcList>
                <action>ADD</action>
                <bizStep>urn:epcglobal:cbv:bizstep:commissioning</bizStep>
                <disposition>urn:epcglobal:cbv:disp:active</disposition>
                <bizLocation>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </bizLocation>
                <extension>
                    <ilmd>
                        <cbvmda:lotNumber>5998</cbvmda:lotNumber>
                        <cbvmda:itemExpirationDate>2029-07-25</cbvmda:itemExpirationDate>
                        <tl:commissionEventExtensions>
                            <tl:packagingItemCode type="GTIN-14">00992326050107</tl:packagingItemCode>
                            <tl:manufacturingDate>2019-07-25</tl:manufacturingDate>
                        </tl:commissionEventExtensions>
                    </ilmd>
                </extension>
            </ObjectEvent>
            <AggregationEvent>
                <eventTime>2019-09-25T00:12:23.8Z</eventTime>
                <eventTimeZoneOffset>-04:00</eventTimeZoneOffset>
                <parentID>urn:epc:id:sscc:005434.40000000021</parentID>
                <childEPCs>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024596</epc>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024597</epc>
                </childEPCs>
                <action>ADD</action>
                <bizStep>urn:epcglobal:cbv:bizstep:packing</bizStep>
                <disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
                <bizLocation>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </bizLocation>
            </AggregationEvent>
            <!-- Receiving -->
            <ObjectEvent>
                <eventTime>2019-09-25T00:12:23.8Z</eventTime>
                <eventTimeZoneOffset/>
                <epcList>
                    <epc>urn:epc:id:sscc:005434.40000000020</epc>
                </epcList>
                <action>OBSERVE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:receiving</bizStep>
                <disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </readPoint>
                <bizTransactionList>
                    <bizTransaction type="urn:epcglobal:cbv:btt:po" date="2019-09-25">urn:epcglobal:cbv:bt:0614141000029:4747880013</bizTransaction>
                    <bizTransaction type="urn:epcglobal:cbv:btt:inv" date="2019-09-25">urn:epcglobal:cbv:bt:7774141000029:987654321</bizTransaction>
                    <bizTransaction type="urn:epcglobal:cbv:btt:desadv" date="2019-09-25">urn:epcglobal:cbv:bt:7774141000029:987654321</bizTransaction>
                </bizTransactionList>
                <extension>
                    <sourceList>
                        <source type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:9997777.01994.0</source>
                    </sourceList>
                    <destinationList>
                        <destination type="urn:epcglobal:cbv:sdt:owning_party">urn:epc:id:sgln:9297187.01994.0</destination>
                    </destinationList>
                </extension>
                <tl:receivingEventExtensions>
                    <tl:transactionDate>2019-07-25</tl:transactionDate>
                    <tl:shipToCountryCode>US</tl:shipToCountryCode>
                    <tl:receiptDistributionType>INCOUNTRYTRANSFER</tl:receiptDistributionType>
                    <tl:supplyType>MedicalCareDistribution</tl:supplyType>
                    <tl:contractType>PrivateContract</tl:contractType>
                    <tl:contractNubmer>C102</tl:contractNubmer>
                    <tl:fundingSource>OwnFunds</tl:fundingSource>
                    <tl:transferWithoutShipment>false</tl:transferWithoutShipment>
                    <tl:entryPort></tl:entryPort>
                    <tl:exitPort></tl:exitPort>
                    <tl:epcOrderItemDetails>
                        <tl:epcOrderItemList orderItemNumber="15">
                            <tl:epcOrderItem>urn:epc:id:sscc:005434.40000000021</tl:epcOrderItem>
                        </tl:epcOrderItemList>
                    </tl:epcOrderItemDetails>
                    <tl:orderItemList>
                        <tl:orderItem>
                            <tl:orderItemNumber>15</tl:orderItemNumber>
                            <tl:packagingItemCode type="GTIN-14">00992326050107</tl:packagingItemCode>
                            <cbvmda:lotNumber>L120012</cbvmda:lotNumber>
                            <cbvmda:itemExpirationDate>2029-07-25</cbvmda:itemExpirationDate>
                            <tl:quantity>5</tl:quantity>
                            <tl:unitPrice currencyCode="USD">89.55</tl:unitPrice>
                            <tl:vat currencyCode="USD">10.45</tl:vat>
                            <tl:grossPrice currencyCode="USD">100.00</tl:grossPrice>
                            <tl:isSerialized>true</tl:isSerialized>
                            <tl:transactionIdentifier type="PO" date="2019-03-30">TI007</tl:transactionIdentifier>
                        </tl:orderItem>
                    </tl:orderItemList>
                    <tl:warehouseOperatorName>Patrick Murphy</tl:warehouseOperatorName>
                    <tl:correctiveReceipt>true</tl:correctiveReceipt>
                    <tl:originalDeliveryNumber>1234567</tl:originalDeliveryNumber>					
                </tl:receivingEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>

Data Element Error Message Description
Class 1
AggregationEvent | action Action ADD is required for is required for the AggregationEvent !!! The error occurs if bizStep = "urn:epcglobal:cbv:bi​zstep:packing", but the source does not equal "ADD" for an aggregation event.
AggregationEvent | bizLocation | id Event location in the aggregation event is required !!! The error occurs if the source is empty or null.
AggregationEvent | bizStep bizStep urn:epcglobal:cbv:bi​zstep:packing is required for the AggregationEvent !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bi​zstep:packing" for an aggregation event.
AggregationEvent | childEPCs | epc Invalid EPC format !!! The error occurs if the source could not be translated.
AggregationEvent | disposition Dispositio​n urn:epcglobal:cbv:di​sp:in_progress is required for the AggregationEvent !!! The error occurs if the source does not equal "urn:epcglobal:cbv:di​sp:in_progress" for an aggregation event.
AggregationEvent | parentID Invalid EPC format !!! The error occurs if the source is empty or null.
bizTransaction | @type Valid bizTransaction type is required if bizTransaction is populated !!! The error occurs if bizTransaction is populated, but the source is empty or null.
attribute(1) Ship to business party name is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Ship from business party name is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Carrier business party name is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold to business party name is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold from business party name is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Valid packagingLevel code required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
attribute(2) Party type is required if additional facility identifier is populated !!! The error occurs if attribute | @id = "http://epcis.tracelink.com/mda/additionalIdentifier", but the source is empty or null.
Party type is required if additional business party identifier is populated !!! The error occurs if attribute | @id = "http://epcis.tracelink.com/mda/additionalIdentifier", but the source is empty or null.
Party type is required if additional business party identifier is populated !!! The error occurs if attribute | @id = "http://epcis.tracelink.com/mda/additionalIdentifier", but the source is empty or null.
Party type is required if additional facility identifier is populated !!! The error occurs if attribute | @id = "http://epcis.tracelink.com/mda/additionalIdentifier", but the source is empty or null.
attribute(3) Valid carrier business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid sold to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid ship to location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid sold from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
attribute(4) Valid business classification code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid business classification code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
attribute(5) Carrier business party street address is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold from business party street address is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
Sold to business party street address is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
Ship from location street address is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
Ship to location street address is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
attribute(8) Ship to location city is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
Sold from business party city is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
Carrier business party city is required !!! The error occurs if VocabularyElement | attributefields are present, but the source is empty or null.
Ship from location city is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold to business party city is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
attribute(10) Sold from business party state or region is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold to business party state or region is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Ship to location state or region is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Carrier business party state or region is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Ship from location state or region is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
attribute(12) Valid Sold to business party country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid Carrier business party country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Carrier business party country is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Valid Sold from business party country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid Ship from location country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid Ship to location country is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Ship to location country is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold to business party country is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Ship from location country is required !!! The error occurs if VocabularyElement | attribute fields are present, but the source is empty or null.
Sold from business party country is required !!! The error occurs if VocabularyElement/attribute fields are present, but the source is empty or null.
cbvmda:itemExpirationDate Expiration date is required !!! The error occurs if the serial number type is China, GTIN, or NTIN, but the source is empty or null.
cbvmda:lotNumber Lot number is required !!! The error occurs if the serial number type is China, GTIN, or NTIN, but the source is empty or null.
choice%1 One of internalMaterialCode or packagingItemCode or countryDrugCode is required !!!

The error occurs if tl:internalMaterialCode, tl:packagingItemCode, and tl:countryDrugCode are empty or null.
destinationList | destination Valid sold-to business lookup identifier type is required !!! The error occurs if the source is empty or null.
Ship-to party identifier must match an identifier in VocabularyElement[@id] !!! The error occurs if no match is found between destinationList | destination and VocabularyElement | @id in the party master data header when party master address data is populated in the header.
destinationList | destination Valid ship-to business lookup identifier type is required !!! The error occurs if the source is empty or null.
EPCISMasterData Party master data is required in receiving message !!! The error occurs if VocabularyList in the source is empty or null.
ObjectEvent (Commissioning Events) | action Action ADD is required for ObjectEvent commissioning !!! The error occurs if bizStep = "urn:epcglobal:cbv:bi​zstep:commissioning", but the source does not equal "ADD" for a commissioning event.
ObjectEvent (Commissioning Event) | bizLocation | id Event location in the commissioning event is required !!! The error occurs if the source is empty or null.
ObjectEvent (Commissioning Events) | bizStep bizStep urn:epcglobal:cbv:bi​zstep:commissioning is required for ObjectEvent commissioning !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bi​zstep:commissioning" for a commissioning event.
ObjectEvent (Commissioning Events) | disposition Dispositio​n urn:epcglobal:cbv:di​sp:active is required for ObjectEvent commissioning !!! The error occurs if the source does not equal "urn:epcglobal:cbv:di​sp:active" for a commissioning event.
ObjectEvent (Commissioning Events) | epcList | epc Invalid EPC format !!! The error occurs if the source is empty or null.
ObjectEvent (Receiving Events) Receiving event data is required !!! The error occurs if receiving event is not present in source.
Only one receiving event is required !!! The error occurs if more than one receiving event is present.
ObjectEvent (Receiving Events) | action Action OBSERVE is required for ObjectEvent receiving !!! The error occurs if bizStep = "urn:epcglobal:cbv:bi​zstep:in_progress", but the source does not equal "OBSERVE" for a receiving event.
ObjectEvent (Receiving Events) | bizStep bizStep urn:epcglobal:cbv:bizstep:receiving is required for ObjectEvent receiving !!! The error occurs if the source does not equal "urn:epcglobal:cbv:bizstep:receiving" for a receiving event.
ObjectEvent (Receiving Events) | bizTransactionList Biz transaction list is required in receiving event !!! The error occurs if the source is empty or null.
ObjectEvent (Receiving Events) | disposition Dispositio​n urn:epcglobal:cbv:disp:in_progress is required for ObjectEvent receiving !!! The error occurs if the source does not equal "urn:epcglobal:cbv:disp:in_progress" for a receiving event.
ObjectEvent (Receiving Events) | epcList | epc At least one serial number in epcList is required !!! The error occurs if the source is empty or null.
ObjectEvent (Receiving Events) | extension | sourceList | source Valid sold-from business lookup identifier type is required !!! The error occurs if the source is empty or null.
Valid ship-from business lookup identifier type is required !!! The error occurs if the source is empty or null.
Ship-from party identifier must match an identifier in VocabularyElement[@id] !!! The error occurs if no match is found between sourceList | source and VocabularyElement | @id in the party master data header when party master address data is populated in the header.
Carrier party identifier must match an identifier in VocabularyElement[@id] !!! The error occurs if no match is found between sourceList | source and VocabularyElement | @id in the party master data header when party master address data is populated in the header.
Valid carrier business lookup identifier type is required !!! The error occurs if the source is empty or null.
ObjectEvent (Receiving Events) | readPoint | id Event location in the receiving event is required !!! The error occurs if the source is empty or null.
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.
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.
tl:countryDrugCode | @type Country drug code type is required if country drug code is populated !!! The error occurs if countryDrugCode is populated but the source is empty or null, or is not a valid value from the enumeration list.
tl:countryMarket Valid ISO country code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:fieldName Field name is required if ExtensionField group present in source !!! The error occurs if ExtensionField group is populated, but the source is empty or null.
tl:fieldValue Field value is required if ExtensionField group present in source !!! The error occurs if ExtensionField group is populated, but the source is empty or null.
tl:packagingLevel Packaging Level is required !!! The error occurs if the serial number type is China, GTIN, or NTIN, but the source is empty or null.
tl:packagingItemCode | @type Packaging item code type is required !!! The error occurs if packagingItemCode is populated but the source is empty or null, or is not a valid value from the enumeration list.
Packaging item code type required if packagingItemCode is populated !!! The error occurs if packagingItemCode is populated but the source is empty or null, or is not a valid value from the enumeration list.
tl:quantity Quantity value greater than 0 is required !!! The error occurs if the source = "0", OrderItemList is present and the source is less than 0, or the source is empty or null.
tl:receiptDistributionType Valid receipt distributionType is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
tl:receivingEventExtensions receivingEventExtensions required if receiving event populated !!! The error occurs if receiving event is populated, but the source is empty or null.
tl:shipFromCountryCode Valid ISO country code is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:shipToCountryCode Valid ISO country code for ship-to country is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list.
tl:supplyType Valid Supply Type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:transactionDate Transaction date is required !!! The error occurs if the source is empty or null.
tl:unitPrice | @currencyCode Valid ISO currency code is required !!! The error occurs if unitPrice is populated but the source is empty or null, or is not a valid value from the enumeration list.
VocabularyElement Ship to party info required in VocabularyElement if present in sourceList !!! The error occurs if ship to is present in sourceList, but not in VocabularyElement.
Ship to party info required in VocabularyElement if present in destinationList !!! The error occurs if ship to is present in destinationList, but not in VocabularyElement.
Sold to party identifier is required !!! The error occurs if the source is empty or null.
Sold from party identifier is required !!! The error occurs if the source is empty or null.
Ship from party info required in VocabularyElement if present in sourceList !!! The error occurs if ship from party is present in sourceList, but not in VocabularyElement.
Carrier party info required in VocabularyElement if present in sourceList !!! The error occurs if carrier party is present in sourceList, but not in VocabularyElement.
VocabularyElement | @id Valid carrier business party lookup identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid ship to location identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid ship to location lookup identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid sold to business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Item code is required in source VocabularyElement[@id] !!! The error occurs if the source is empty or null.
VocabularyElement | @id SGTIN or NTIN or CN-EDMC in VocabularyElement id is required !!! The error occurs if the source is not an SGTIN, NTIN, or CN-EDMC and master data is present in the header extension.
VocabularyElement | @id Valid sold to business party lookup identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid ship from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid carrier business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid sold from business party lookup identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
VocabularyElement | @id Valid sold from business party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Class 2
@currencyCode CurrencyCode for shipping event for delivery <DeliveryNumber> not found. The error occurs if UnitPrice is populated, but the source is empty or null.
bizTransaction | @date Transaction Identifier Date is required if Ship To Country Code = RU. The error occurs if tl:shipToCountryCode = "RU" but the source is empty or null.
destination | destinationList SOM Receiving inbound processing could not be completed. The ReceiverInfo with either ToBusinessPartyLookupId or ToBusinessPartyInfo for the ShipFromCountryCode of <ShipFromCountryCode> and ShipToCountryCode of <ShipToCountryCode> must be specified. The error occurs if the source is empty or null and:
  • Transfer or sale occurs in non-EU FMD markets where the ShipToCountryCode is not an EU FMD country and the ShipFromCountryCode is not an EU FMD country.
  • Transfer or sale export occurs from the EU FMD markets where the ShipToCountryCode is China, US, South Korea, or Russia and the ShipFromCountryCode is an EU FMD country.
destination | destinationList | @type Could not perform Location Master Data lookup to populate receiver shipping address fields. <ShipToLocationLookupId / type> <ShipToLocationLookupId> is not configured in your Company Location Master Data nor in your Partner Location Master Data. Please configure <ShipToLocationLookupId / type> <ShipToLocationLookupId> in Company Location Master Data or in Partner Location Master Data (if the ship to location is a partner location) and reprocess the file. The error occurs if cmn:ShipToLocationLookupId | @type or cmn:ShipToLocationLookupId is empty or null in Company or Partner Location Master Data.
destination | destinationList | @type Could not perform Company Master Data lookup to populate receiver business address fields. <ToBusinessPartyLookupId / type> <ToBusinessPartyLookupId> is not configured in your Company Master Data. Please configure <ToBusinessPartyLookupId / type> <ToBusinessPartyLookupId> in Company Master Data, and reprocess the file. The error occurs if cmn:ToBusinessPartyLookupId | @type or cmn:ToBusinessPartyLookupId is empty or null in Company or Partner Company Master Data.
epcList | epc Serial Number <ParentSerial> reference in aggregation but not present in ReceivingEvent / NumberList The error occurs if the source is not present in ReceivingEvent | NumberList.
N/A Serial Number <ParentSerial> reference in aggregation but not present in ReceivingEvent / NumberList The error occurs if all top-most parent serial numbers are not present in ReceingEvent | NumberList elements.
Cannot perform operation on serial number <serial number> with serial number item state <item state>. This operation can only be performed when the serial number is Pending Receipt or Shipped. The error occurs if Serial Number was not shipped.
Could not commission parent serial number <ParentSerial> because it is not an SSCC Number The error occurs if ParentSerial is not an SSCC Number.
source | sourceList | @type Could not perform Master Data lookup to populate transportation carrier business address fields. <CarrierBusinessPartyLookupId / type> <CarrierBusinessPartyLookupId > is not configured in your Company or Partner Company Master Data. Please configure <CarrierBusinessPartyLookupId / type> <CarrierBusinessPartyLookupId > in Company or Partner Company Master Data, and reprocess the file. The error occurs if cmn:CarrierBusinessPartyLookupId | @type or cmn:CarrierBusinessPartyLookupId is empty or null in Company or Partner Company Master Data.
source | sourceList | @type Could not perform Master Data lookup to populate sender shipping address fields. <ShipFromLocationLookupId / type> <ShipFromLocationLookupId> is not configured in your Company or Partner Location Master Data. Please configure <ShipFromLocationLookupId / type> <ShipFromLocationLookupId> in Company or Partner Location Master Data, and reprocess the file. The error occurs if cmn:ShipFromLocationLookupId | @type or cmn:ShipFromLocationLookupId is empty or null in Company or Partner Location Master Data.
source | sourceList | @type Could not perform Master Data lookup to populate sender business address fields. <FromBusinessPartyLookupId / type> <FromBusinessPartyLookupId> is not configured in your Company or Partner Master Data. Please configure <FromBusinessPartyLookupId / type> <FromBusinessPartyLookupId> in Company or Partner Master Data, and reprocess the file. The error occurs if cmn:FromBusinessPartyLookupId | @type or cmn:FromBusinessPartyLookupId is empty or null in Company or Partner Company Master Data.
sourceList SOM Receiving inbound processing could not be completed. The SenderInfo with either FromBusinessPartyLookupId or FromBusinessPartyInfo for the ShipFromCountryCode of <ShipFromCountryCode> and ShipToCountryCode of <ShipToCountryCode> must be specified. The error occurs if the source is empty or null and:
  • Transfer or sale occurs in non-EU FMD markets where the ShipToCountryCode is not an EU FMD country and the ShipFromCountryCode is not an EU FMD country.
  • Transfer or sale export occurs from the EU FMD markets where the ShipToCountryCode is China, US, South Korea, or Russia and the ShipFromCountryCode is an EU FMD country.
tl:contractType ContractType for receiving event for delivery <DeliveryNumber> not found. The error occurs if ShipToCountryCode = "KR" and ReceiptDistributionType = "InCountryReturn", but the source is empty or null.
tl:contractType ContractType for receiving event for delivery <DeliveryNumber> not found. The error occurs if ShipToCountryCode = "KR", but the source does not equal either "PrivateContract" or "CompetitiveBid".
tl:fundingSource Funding Source is required if Ship To Country Code is RU and Ship From Country Code is RU. The error occurs if both tl:shipToCountryCode and tl:shipFromCountryCode = "RU", but the source is empty or null.
tl:orderItem OrderItemList for shipping event for delivery <DeliveryNumber> not found. The error occurs if ShipToCountryCode = "KR" and ReceiptDistributionType = "InCountryReturn", but the source is empty or null.
tl:orderItem OrderItems for receiving event for delivery <DeliveryNumber> not found. The error occurs if ShipToCountryCode = "KR" and ReceiptDistributionType = "InCountryReturn", but the source is empty or null.
tl:shipFromCountryCode SOM Receiving inbound processing could not be completed. Both the ShipToCountryCode and ShipFromCountryCode must be specified when the Sender Info and ReceiverInfo are not specified. The error occurs if the sourceList and destinationList are both omitted, and tl:shipToCountryCode and tl:ShipFromCountrycode are empty or null.
tl:shipToCountryCode SOM Receiving inbound processing could not be completed. Both the ShipToCountryCode and ShipFromCountryCode must be specified when the Sender Info and ReceiverInfo are not specified. The error occurs if the sourceList and destinationList are both omitted, and tl:shipToCountryCode and tl:ShipFromCountrycode are empty or null.
tl:supplyType SupplyType for receiving event for delivery <DeliveryNumber> not found. The error occurs if ShipToCountryCode = "KR" and ReceiptDistributionType = "InCountryReturn", but the source is empty or null.
tl:transactionIdentifier | @date Order Item Transaction Identifier Date is required if Ship To Country Code = RU. The error occurs if tl:shipToCountryCode = "RU" but the source is empty or null.
tl:unitPrice UnitPrice is for receiving event for delivery <DeliveryNumber> not found. The error occurs if ShipToCountryCode = "KR" and ReceiptDistributionType = "InCountryReturn", but the source is empty or null.
tl:unitPrice Unit Price is required if Ship To Country Code is RU and Ship From Country Code is any of RU, AM, BY, KZ, KG. The error occurs if tl:shipToCountryCode = "RU" and tl:shipFromCountryCode = "AM", "BY", "KG", "KZ", or "RU", but the source is empty or null.
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.