Sales Shipment Guidelines (XML)
See How To Use this Guide before interpreting the guidelines below.
Message Type: SOM_SALES_SHIPMENT
Info Exchange Display Name: Sales Shipment


Data Element | Occurs Length |
Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
SOMSalesShipmentMessage | - |
1...1- | Required. Root element of message. | |||||||
som:ControlFileHeader | - |
1...1- | Required. The message document's header information. | |||||||
cmn:FileSenderNumber | 1/20 |
1...1String | ||||||||
cmn:FileReceiverNumber | 1/20 |
1...1String | Required. The company identifier of the file’s recipient.1 | |||||||
cmn:FileControlNumber | 1/20 |
1...1String | Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages.2 | |||||||
cmn:FileDate | 10/10 |
1...1Date | Required. The date that the message is sent in YYYY-MM-DD format. Date and times must be in GMT.3 | |||||||
cmn:FileTime | 9/9 |
1...1Time | Required. Time file generated in XML in HH:MM:SSZ format. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z .4 |
|||||||
som:MessageBody | - |
1...1- | Required. The Message Body includes all of the Serialized Operations Manager Sales Shipment message details including, but not restricted to, location, delivery, and order information. | |||||||
cmn:LocationId | 0/34 |
0...1String |
The LocationId field specifies the identifier of the facility/warehouse so as to scope the Shipment status update for the serial numbers only at the specified location.5 If the location is omitted, the Shipment status update will be applied globally to all matching serial numbers in the system. |
|||||||
cmn:EventDateTime | 0/* |
0...1DateTime | Timestamp of the date/time of the shipment event with the UTC time zone indicator in format: YYYY-MM-DDTHH:MM:SS.ssZ. ![]() |
|||||||
cmn:EventTimeZoneOffset | 0/* |
0...1String | Time zone offset of the place where the event occurred, consistent with what choice was made for cmn:eventTime. A time offset is the amount of time added or subtracted from UTC (Coordinated Universal Time) to get the current civil time regardless of whether it is standard time or Daylight saving time.6 | |||||||
cmn:DeliveryNumber | 1/* |
1...1String | Required. Indicates the DeliveryNumber that links the order information to the serialized pick information for this customer delivery.7 cmn:DeliveryNumber must be unique for across all shipments. |
|||||||
cmn:DeliveryCompleteFlag | 1/* |
1...1Boolean | Required. TraceLink allows communication of the data all in one message, or deliver the information incrementally over a period of time. If sending the data all at once, set flag to true. If sending data incrementally, set flag to false.8 Values must be lowercase or an error results. When set to true, cmn:DeliveryCompleteFlag instructs TraceLink to:
If only partial information is provided in the message (e.g. order detail only, serial numbers only) and the DeliveryCompleteFlag is set to true, the park/retry function returns the message to the queue for period reprocessing for up to two hours and updates the message with any previously omitted details when they become available. This enables an ERP system to send Order Details while the warehouse system sends the serial numbers separately, allowing the order in which this information is received to be arbitrary. |
|||||||
som:OrderDetails | - |
0...1- | Can be communicated at any time (e.g. before or after the picked serial numbers have been communicated). | |||||||
cmn:DisaggregateFromParent | 0/* |
0...1Boolean | When set to true instructs the system to disaggregate the picked serial number from the parent container, if it is aggregated.
If not set, or set to false , the system will operate in default mode which is to generate an error if attempting to pick serial number for an item or container that is aggregated to a parent container.9 |
|||||||
cmn:CorrectiveShipment | 0/* |
0...1Boolean | Default value is false , which indicates that it is not a corrective shipment.![]() true , indicates that a new Serialized Operations Manager shipment is correcting a previously voided Serialized Operations Manager shipment message. The corrected message must be voided before the new shipment. |
|||||||
cmn:OriginalDeliveryNumber | 0/* |
0...1String | If the corrective delivery is using a new delivery number, provide original delivery number for cross-reference purposes. | |||||||
cmn:EntryPort | 0/* |
0...1String | Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint). | |||||||
cmn:ExitPort | 0/* |
0...1String | Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint). | |||||||
cmn:TransactionIdentifier | 0/* |
0...* String | The transaction identifier is associated with the picked serial numbers for regulatory reporting purposes. At least one transaction id is required![]()
|
|||||||
@type | 1/* |
1...1String | Required. The transaction identifier type. Valid values:
|
|||||||
@date | 0/* |
0...1Date |
RU . |
|||||||
cmn:TransactionDate | 1/* |
1...1Date | Required. Indicates the date when the transfer of ownership occurred between the FromBusinessParty and ToBusinessParty. The date of the message in XML YYYY-MM-DD format.12![]() |
|||||||
cmn:TransactionTime | 0/* |
0...1Time | ||||||||
cmn:ShipToCountryCode | 2/2 |
1...1String | Required.
Two-letter ISO country code for ship-to 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. The actual trigger for regulatory reporting is governed by customer administrative configuration in TraceLink.14 See the ISOCountryCode enumeration list for valid values. |
|||||||
cmn:ShipFromCountryCode | 2/2 |
0...1String | Conditionally required if cmn:SalesDistributionType = EXPORTSALE , EXPORTTRANSFER , or EXPORTRETURN . ISO country code for the ship-from country. Provides TraceLink with the information needed to trigger regulatory reporting in response to relevant events.
See the ISOCountryCode enumeration list for valid values. |
|||||||
cmn:SalesDistributionType | 1/* |
1...1String | Required. This value is referenced to advise 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. Setting this value alone does not trigger regulatory reporting. The actual triggering of regulatory reporting is governed by customer administrative configuration in TraceLink.15 See the SalesDistType enumeration list for valid values. |
|||||||
cmn:SupplyType | 0/* |
0...1String |
Conditionally required:
Identifies the type of supply that is being performed. See the SupplyType enumeration list for valid values. |
|||||||
cmn:ContractType | 0/* |
0...1String | 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/* |
0...1String | Optional field that includes comments (up to 200 characters) associated with the delivery.![]() KR and cmn:SalesDistributionType = EXPORTSALE or INCOUNTRYSALE , this value is included in compliance reporting. |
|||||||
cmn:DropShipment | 0/* |
0...1Boolean | If set to true , this value indicates that a shipment is a drop shipment. A drop shipment occurs when there is a delivery of product from a manufacturer or original supplier direct to the end customer, without passing through the wholesale distributor who processed the sale.16 |
|||||||
cmn:PortalAccessCode | 0/* |
0...1String | The portal access code used to access drop shipments in the serialized drop ship portal. | |||||||
cmn:ContractNumber | 0/* |
0...1String | Identification number of the contract.17 | |||||||
cmn:FundingSource | 0/* |
0...1String | RU . |
|||||||
cmn:DeliveryInspection | 0/* |
0...1String |
The inspection status of the physical delivery against the delivery documentation. See the DeliveryInspection enumeration list for valid values. |
|||||||
cmn:DeliveryInspectionDate | 10/10 |
0...1Date | The date of the physical delivery inspection against the delivery documentation in YYYY-MM-DD format.19 | |||||||
cmn:DeliveryInspectionNote | 0/* |
0...1String | Comments about the physical delivery inspection against the delivery documentation. | |||||||
cmn:RemovalFromCirculation | 0/* |
0...1String |
Reason the product in the delivery is taken out of the supply chain. See the RemovalFromCirculation enumeration list for valid values. |
|||||||
cmn:AggregationInspection | 0/* |
0...1String |
The inspection status of the aggregation hierarchy of the container. See the AggregationInspection enumeration list for valid values. |
|||||||
cmn:OrderItemList | - |
0...1- |
KR and cmn:SalesDistributionType = EXPORTSALE or INCOUNTRYSALE . cmn:OrderItemList can include serialized and not serialized products that are subject to compliance reporting. |
|||||||
cmn:AllowShortVerificationCount | 0/* |
0...1Boolean |
Instructs the system whether to allow short picks when verifying the quantities of what is expected to be picked (in cmn:OrderItemList) against the each quantities of actual scanned serial numbers (in cmn:AddedPickedItems).20 Values must be lower case only.
If no value is specified, |
|||||||
cmn:OrderItem | - |
1...*- | Required. The cmn:OrderItem group is a repeating element that captures the item code, lot number, and quantity for each item that will be picked for that order. Each unique item code and lot number are communicated in a separate order item group.
Either cmn:InternalMaterialCode or cmn:PackagingItemCode is mandatory with cmn:Quantity. |
|||||||
cmn:OrderItemNumber | 0/* |
0…1String | 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...1Choice | Required. A choice between the cmn:InternalMaterialCode and cmn:PackagingItemCode for cmn:OrderItem is required for this message. Cannot use both or none. | |||||||
cmn:InternalMaterialCode | 1/* |
0...1String | Conditionally required if cmn:PackagingItemCode is not populated. Option 1 for OrderItem. Used to identify the product using the internal material number, which is configured in the Product Master Data, and associated with serial number at time of commissioning.21 | |||||||
cmn:PackagingItemCode | 0/* |
0...1String | Conditionally required if cmn:InternalMaterialCode is not populated. This is Option 2 for the OrderItem message. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data, and associated with serial number at time of commissioning.22 | |||||||
@type | 1/* |
0...1String | Required. The packaging item code type. See the ItemCode enumeration list for valid values. |
|||||||
cmn:LotNumber | 0/* |
0...1String | The lot or batch code for the items to be picked (if available).23 | |||||||
cmn:ExpirationDate | 0/* |
0...1Date |
KR and cmn:SalesDistributionType = EXPORTSALE or INCOUNTRYSALE for non-serialized products. |
|||||||
cmn:Quantity | 1/* |
1...1Integer | Required. The quantity of items at the EACH (unit) level of the item. Quantity must be greater than zero if cmn:IsSerialized = false . If multiple GTINs at the same packaging level are associated with the same internal material code, the system automatically combines quantities from those GTINs and provides a single quantity for the Internal Material Code.25 |
|||||||
cmn:UnitPrice | 1/* |
0...1Decimal |
The unit price of an item. |
|||||||
@currencyCode | 3/3 |
1...1String |
Required.Currency ISO code using ISO 4217-2015 format.26 See the ISOCurrency enumeration list for valid values.
|
|||||||
cmn:VAT | - |
0...1Decimal | Value Added Tax per unit.27 | |||||||
@currencyCode | 3/3 |
1...1String | Required. Currency ISO code using ISO 4217-2015 format.28 See the ISOCurrency enumeration list for valid values. |
|||||||
cmn:GrossPrice | 0/* |
0...1Decimal | Price including unit price and all taxes and fees. 29 | |||||||
@currencyCode | 3/3 |
1...1String | Required.Currency ISO code using ISO 4217-2015 format.30 See the ISOCurrency enumeration list for valid values. |
|||||||
cmn:IsSerialized | 0/* |
0...1Boolean | Conditionally required if cmn:shipFromCountryCode = KR and cmn:SalesDistributionType = EXPORTSALE or INCOUNTRYSALE for non-serialized products. Indicates if the item is not serialized. If omitted, defaults the 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.31 | |||||||
@type | 1/* |
1...1String | Required. The transaction identifier type. Valid values:
|
|||||||
@date | 0/* |
0...1Date | Required.Conditionally required if cmn:ShipToCountryCode = RU . The transaction identifier date.32 |
|||||||
cmn:SenderInfo | - |
0...1 - | Conditional requirements:
Optional if:
Mandatory if:
This message contains information about the supply chain partner that is sending the return shipment. The cmn:FromBusinessParty and cmn:ShipFromLocation elements determine whether to use master data lookup to populate the address, license, and contact elements. Only one of cmn:FromBusinessParty or cmn:ShipFromLocation elements may be present at once. |
|||||||
choice%1 | - |
0...1 Choice | Option 1 within choice%1 of cmn:SenderInfo contains only the cmn:FromBusinessPartyLookupId (in this case, TraceLink populatse all of the cmn: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/* |
0...1String |
Option 1 for the SenderInfo group. cmn: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 cmn:FromBusinessPartyInfo.33![]() |
|||||||
@type | 1/* |
1...1String | Required. The type of the sold from business entity identifier. See the BusinessLookupId enumeration list for valid values. |
|||||||
cmn:FromBusinessPartyInfo | 1/* |
0...1 - | Conditionally required if cmn:SenderInfo is populated, but cmn:FromBusinessPartyLookupId is not populated. Option 2 for the cmn:SenderInfo group. 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. The BusinessId field indicates the identifier associated with the business party who owns the goods at the time of the shipment. This value is mandatory for regulatory reporting.34 Different countries require different values as noted below: ![]()
|
|||||||
@type | 1/* |
1...1String | Required. The business id type. See the BusinessAndLocationId enumeration list for valid values. |
|||||||
cmn:BusinessClassifcation | 0/* |
0...1String | Conditionally required:
Classifies the business type of the TraceLink customer or trading partner. See the BusinessClassification enumeration list for valid values. |
|||||||
cmn:BusinessInfo | - |
0...1- | ||||||||
cmn:BusinessName | 1/* |
1...1String | Required. The business name of the TraceLink Customer or Trading Partner.35 | |||||||
cmn:Street1 | 1/* |
1...1String | Required. The first line of the street address for the company indicated in cmn:BusinessName.36 | |||||||
cmn:Street2 | 0/* |
0...1String | The second line of the street address for the company indicated in cmn:BusinessName.37 | |||||||
cmn:City | 1/* |
1...1String | Required. The city of the company indicated in cmn:BusinessName.38 | |||||||
cmn:Village | 0/* |
0...1String | Name of the village in which the company is located. | |||||||
cmn:HouseNumber | 0/* |
0...1String | 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/* |
0...1String | Name of the township in which the company is located. | |||||||
cmn:District | 0/* |
0...1String |
Name of the district subdividing the state or region. |
|||||||
cmn:StateOrRegion | 1/* |
1...1String | 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.39 See the ISOCountryCode enumeration list for valid values. |
|||||||
cmn:PostalCode | 0/* |
0...1String | The zip or other postal code of the company indicated in cmn:BusinessName.40 | |||||||
cmn:Country | 1/* |
1...1String | Required.
Two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
The country code of the company indicated in cmn:BusinessName.41 See the ISOCountryCode enumeration list for valid values. |
|||||||
cmn:CorporateFax | 0/* |
0...1String | Company fax number. | |||||||
cmn:AddressObjectGUID | 0/* |
0...1String |
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/* |
0...1String |
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/* |
0...1String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | |||||||
cmn:PremisesCode | 0/* |
0...1String | Identifier representing a physical area within the company location (e.g. a location's second floor). | |||||||
choice%2 | - |
0...1Choice | Optional choice element: No error if neither are present.
Option 1 within choice%2of senderInfo contains only the cmn:ShipFromLocationLookupId (in this case TraceLink populates all of the ShipFromLocationInfo fielded data based on company location master data lookup). Populate this element only if master data lookup is desire. This choice is restricted to TraceLink Customers only. ![]() Option 2 within choice2 of senderInfo contains full cmn:ShipFromLocationInfo business address fielded data that is populated by the customer directly in the interface. Populate this element fully only if no master data lookup is desired. |
|||||||
cmn:ShipFromLocationLookupId | 1/* |
0...1String | Option 1 for the SenderInfo complex message. 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 cmn:ShipFromLocationInfo.42 | |||||||
@type | 1/* |
1...1String | Required. Ship-from location lookup id type. See the LocationLookupId enumeration list for valid values. |
|||||||
cmn:ShipFromLocationInfo | - |
0...1- | ||||||||
cmn:FacilityId | 0/* |
0...*String | Conditionally required
This field is populated with either the ship-from Location Identifier or the ship-to location identifier.43 |
|||||||
@type | 1/* |
1...1String | Required. The business id type. See the BusinessAndLocationId enumeration list for valid values. |
|||||||
cmn:LocationInfo | - |
0...1String | Conditionally required for the US. This field is populated with the business name and address of the cmn:ShipFrom business entity. | |||||||
cmn:BusinessName | 1/* |
1...1String | Required. The business name of the TraceLink Customer or Trading Partner.44 | |||||||
cmn:Street1 | 1/* |
1...1String | Required. The first line of the street address for the company indicated in cmn:BusinessName.45 | |||||||
cmn:Street2 | 0/* |
0...1String | The second line of the street address for the company indicated in cmn:BusinessName.46 | |||||||
cmn:City | 1/* |
1...1String | Required. The city of the company indicated in cmn:BusinessName.47 | |||||||
cmn:Village | 0/* |
0…1String | Name of the village in which the company is located. | |||||||
cmn:HouseNumber | 0/* |
0…1String | 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/* |
0…1String | Name of the township in which the company is located. | |||||||
cmn:District | 0/* |
0...1String |
Name of the district subdividing the state or region. |
|||||||
cmn:StateOrRegion | 1/* |
1...1String | 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.48 See the ISOCountryCode enumeration list for valid values. |
|||||||
cmn:PostalCode | 0/* |
0...1String | The zip or other postal code of the company indicated in cmn:BusinessName.49 | |||||||
cmn:Country | 1/* |
1...1String | Required.
Two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
The country code of the company indicated in cmn:BusinessName.50 See the ISOCountryCode enumeration list for valid values. |
|||||||
cmn:CorporateFax | 0/* |
0...1String | Company fax number. | |||||||
cmn:AddressObjectGUID | 0/* |
0...1String |
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/* |
0...1String |
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/* |
0...1String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | |||||||
cmn:PremisesCode | 0/* |
0...1String | Identifier representing a physical area within the company location (e.g. a location's second floor). | |||||||
cmn:LicenseNumber | 0/* |
0...*String | Populate with the license number of the ship-to or ship-from facility. This is contingent on if this field is associated with the cmn:ShipFromLocationInfo or cmn:ShipToLocationInfo element. This element may be repeated to include as many license numbers as required (e.g. state and federal license).51 | |||||||
@state | 0/* |
0...1String | This attribute is used to give additional context to the LicenseNumber field. 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.52 | |||||||
@agency | 0/* |
0...1String | 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).53 | |||||||
cmn:ContactInfo | - |
0...1String | Contains contact information for use by downstream trading partners to authenticate (i.e. verify) the message 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. ![]() |
|||||||
cmn:Name | 0/* |
0...1String | The name of the contact department or individual at the designated company.54 | |||||||
cmn:Title | 0/* |
0...1String | Title information is optional within cmn:ContactInfo. The title refers to the individual's job title who is indicated in the Name field.55 | |||||||
cmn:Telephone | 1/* |
1...1String | 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.56 | |||||||
cmn:Email | 0/* |
0...1String | The email address of the contact department or individual at the designated company. Should be included if available.57 | |||||||
cmn:Url | 0/* |
0...1String | URL information is optional within cmn:ContactInfo. The URL refers to the designated company’s web address that facilitates authentication.58 | |||||||
cmn:ReceiverInfo | - |
0...1 String |
Conditional requirements: Optional if:
Mandatory if:
Information about the supply chain partner that is receiving the shipment. cmn:ReceiverInfo contains an XML Choice element on the cmn:ToBusinessPartyLookupId and cmn: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 cmn:ReceiverInfo contains only cmn: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 cmn: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/* |
0...1String |
Option 1 for cmn:ReceiverInfo.
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.59![]() |
|||||||
@type | 1/* |
1...1String |
Required. The type of the sold to business entity identifier. See the LocationLookupId enumeration list for valid values. |
|||||||
cmn:ToBusinessPartyInfo | - |
0...1String | Conditionally required if cmn:ToBusinessPartyLookupId is not populated. Full business information associated with the sold to business entity. Option 2 for cmn:ReceiverInfo. | |||||||
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.
|
|||||||
@type | 1/* |
1...1String |
Required. The business id type. See the BusinessAndLocationId enumeration list for valid values. |
|||||||
cmn:BusinessClassification | 1/* |
0...1String | Conditionally required:
This field classifies the business type of the receiving business entity. Valid values:
|
|||||||
cmn:BusinessInfo | 0/* |
0...1String | ||||||||
cmn:BusinessName | 1/* |
1...1String | Required. The name of the receiving business entity. | |||||||
cmn:Street1 | 1/* |
1...1String | Required. The first line of the street address for the company indicated in cmn:BusinessName. | |||||||
cmn:Street2 | 0/* |
0...1String | The second line of the street address for the company indicated in cmn:BusinessName. | |||||||
cmn:City | 1/* |
1...1String | Required. The city of the company indicated in cmn:BusinessName. | |||||||
cmn:Village | 0/* |
0...1String | Name of the village in which the company is located. | |||||||
cmn:HouseNumber | 0/* |
0...1String | 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/* |
0...1String | Name of the township in which the company is located. | |||||||
cmn:District | 0/* |
0...1String |
Name of the district subdividing the state or region. |
|||||||
cmn:StateOrRegion | 1/* |
1...1String | 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 | 0/* |
0...1String | The zip or other postal code of the company indicated in cmn:BusinessName. | |||||||
cmn:Country | 1/* |
1...1String | 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/* |
0...1String | Company fax number. | |||||||
cmn:AddressObjectGUID | 0/* |
0...1String |
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/* |
0...1String |
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/* |
0...1String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | |||||||
cmn:PremisesCode | 0/* |
0...1String | Identifier representing a physical area within the company location (e.g. a location's second floor). | |||||||
choice%2 | - |
0...1Choice | Can choose either cmn:ShipToLocationLookupId or cmn:ShipToLocationInfo; cannot choose both. No error thrown if none are present. | |||||||
cmn:ShipToLocationLookupId | 0/* |
0...1String | 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...1String | Required. Ship-to location type. See the LocationLookupId enumeration list for valid values. |
|||||||
cmn:ShipToLocationInfo | 0/* |
0...1String | Conditionally required if |
|||||||
cmn:FacilityId | 0/* |
0...*String | Required. This field is populated with either the ship-from Location Identifier or the ship-to location identifier.61![]() |
|||||||
@type | 1/* |
1...1String | Required. The facility id type. See the BusinessAndLocationId enumeration list for valid values. |
|||||||
cmn:LocationInfo | 1/* |
0...1String | Conditionally required for the US. This field is populated with the business name and address of the business entity. | |||||||
cmn:BusinessName | 1/* |
1...1String | Required. The name of the receiving business entity. | |||||||
cmn:Street1 | 1/* |
1...1String | Required. The first line of the street address for the company indicated in cmn:BusinessName. | |||||||
cmn:Street2 | 0/* |
0...1String | The second line of the street address for the company indicated in cmn:BusinessName. | |||||||
cmn:City | 1/* |
1...1String | Required. The city of the company indicated in cmn:BusinessName. | |||||||
cmn:Village | 0/* |
0...1String | Name of the village in which the company is located. | |||||||
cmn:HouseNumber | 0/* |
0...1String | 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/* |
0...1String | Name of the township in which the company is located. | |||||||
cmn:District | 0/* |
0...1String |
Name of the district subdividing the state or region. |
|||||||
cmn:StateOrRegion | 1/* |
1...1String | 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 | 0/* |
0...1String | The zip or other postal code of the company indicated in cmn:BusinessName. | |||||||
cmn:Country | 1/* |
1...1String | 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/* |
0...1String | Company fax number. | |||||||
cmn:AddressObjectGUID | 0/* |
0...1String |
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/* |
0...1String |
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/* |
0...1String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | |||||||
cmn:PremisesCode | 0/* |
0...1String | 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/* |
0...1String | 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/* |
0...1String | 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- | Do not include for Ship-To Location as it is not used. | |||||||
cmn:CarrierInfo | - |
0...*- | The full business information associated with the carrier responsible for delivering the shipment. cmn:CarrierInfo contains an XML Choice element that governs whether master data lookup will be used to populate the address elements. The choice elements allow only one of the element sets contained in the choice declaration to be present within the containing element. | |||||||
Choice | - |
1...1Choice | Required. Must choose between cmn:CarrierBusinessPartyLookupId and cmn:CarrierBusinessPartyInfo. Cannot choose both or none. | |||||||
cmn:CarrierBusinessPartyLookupId | 1/* |
0...1String | 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.62 | |||||||
@type | 1/* |
1...1String | Required. The business party type. See the BusinessLookupId enumeration list for valid values. |
|||||||
cmn:CarrierBusinessPartyInfo | - |
0...1- | Conditionally required if cmn:CarrierBusinessPartyLookupId is not populated. This is Option 2 for cmn:CarrierInfo option. This element contains the full business information associated with the transportation carrier business entity. | |||||||
cmn:BusinessId | 1/* |
1...*String |
Required. Indicates the identifier associated with either the sold from business entity or the sold to business entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below: ![]()
|
|||||||
@type | 1/* |
1...1String | Required. The business id type. See the BusinessAndLocationId enumeration list for valid values. |
|||||||
cmn:BusinessClassification | 0/* |
0...1String | This field classifies the business type of the TraceLink customer or trading partner. Valid values:
![]() |
|||||||
cmn:BusinessInfo | - |
0...1- |
|
|||||||
cmn:BusinessName | 1/* |
1...1String | Required. The name of the receiving business entity. | |||||||
cmn:Street1 | 1/* |
1...1String | Required. The first line of the street address for the company indicated in cmn:BusinessName. | |||||||
cmn:Street2 | 0/* |
0...1String | The second line of the street address for the company indicated in cmn:BusinessName. | |||||||
cmn:City | 1/* |
1...1String | Required. The city of the company indicated in cmn:BusinessName. | |||||||
cmn:Village | 0/* |
0...1String | Name of the village in which the company is located. | |||||||
cmn:HouseNumber | 0/* |
0...1String | 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/* |
0...1String | Name of the township in which the company is located. | |||||||
cmn:District | 0/* |
0...1String |
Name of the district subdividing the state or region. |
|||||||
cmn:StateOrRegion | 1/* |
1...1String | 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 | 0/* |
0...1String | The zip or other postal code of the company indicated in cmn:BusinessName. | |||||||
cmn:Country | 1/* |
1...1String | 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/* |
0...1String | Company fax number. | |||||||
cmn:AddressObjectGUID | 0/* |
0...1String |
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/* |
0...1String |
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/* |
0...1String | The code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code). | |||||||
cmn:PremisesCode | 0/* |
0...1String | Identifier representing a physical area within the company location (e.g. a location's second floor). | |||||||
cmn:WarehouseOperatorName | 0/* |
0...1String | 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).63 | |||||||
som:AddPickedItems | - |
0...1- | List of serial numbers for the outermost handling units (e.g. container/tote) picked for this delivery. 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 picked and subsequent shipped status. | |||||||
cmn:Serial | 1/* |
1...*String | Required. This attribute identifies the serial numbers included in the transaction and their format.64 | |||||||
@format | 0/* |
0...1String | Required. The format of the serial number. See the Format enumeration list for valid values. |
|||||||
@orderItemNumber | 0/* |
0...1String | Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:OrderItem. | |||||||
som:RemoveUnpickedItems | - |
0...1- | List of serial numbers that were previously reported as picked for this delivery, but have been unpicked (e.g. will not be part of the delivery). TraceLink looks up the child aggregations of the serial numbers provided in the list and updates the container and all sub-child items with the available status and disassociates them from the delivery. | |||||||
cmn:Serial | 1/* |
1...*String | Required. Serial number previously reported as picked for this delivery. One serial number is included per picked container (or item if shipping loose items).65 | |||||||
@format | 0/* |
0...1String | Indicates the serial number format of the number(s) provided in the Serial field. See the Format enumeration list for valid values. |
|||||||
som:AddPickedLot | - |
0...1- | Product code and lot number used to determine the serial number content of a shipment created through a TL XML message that specifies a product code and lot number. Decommissioned and destroyed serial numbers are excluded from serial number content added via som:AddPickedLot. Decommissioning or destroying serial numbers after adding them to a shipment via cmn:AddPickedLot results in message failure. |
|||||||
cmn:ProductLotNumbers | - |
1...*- | Required. Product code data elements within a choice grouping. | |||||||
choice%1 | - |
1...1Choice | Required. Choice of either an cmn:InternalMaterialCode or cmn:CountryDrugCode with type attribute. At least one is mandatory. | |||||||
cmn:InternalMaterialCode | 0/* |
0...1String | Internal material number for the product in the brand owner's internal systems (e.g. ERP).66![]() |
|||||||
cmn:CountryDrugCode | 1/* |
0...1String | The national drug code for the commissioned item (e.g. NDC number for US products).67![]() |
|||||||
@type | 0/* |
0...1String | Required. The national drug code type.68 See the CountryDrugCode enumeration list for valid values. |
|||||||
cmn:LotNumber | 1/* |
1...1String | Required. The lot or batch code for the serialized item in an alphanumeric string.69 | |||||||
som:RemoveUnpickedLot | - |
0...1- | Populate with product code(s) and lot number(s) that are used to determine serial number content of unpicked product for a shipment created through a TL XML message that specifies a product code and lot number. | |||||||
cmn:ProductLotNumbers | - |
1...*- | Required. Product code data elements within a choice grouping. | |||||||
choice%1 | - |
1...1Choice | Required. Choice of either an cmn:InternalMaterialCode or cmn:CountryDrugCode with type attribute. At least one is mandatory. | |||||||
cmn:InternalMaterialCode | 0/* |
0...1String | Internal material number for the product in the brand owner's internal systems (e.g. ERP).70![]() |
|||||||
cmn:CountryDrugCode | 1/* |
0...1String | The national drug code for the commissioned item (e.g. NDC number for US products).71![]() |
|||||||
@type | 0/* |
0...1String | Required. The national drug code type.72 See the CountryDrugCode enumeration list for valid values. |
|||||||
cmn:LotNumber | 1/* |
1...1String | Required. The lot or batch code for the serialized item in an alphanumeric string.73 | |||||||
som:Aggregation | - |
0...*- | The Aggregation item group is used to communicate new aggregations created by the warehouse that are included in the shipment.
The PickedItems will continue to include the top level container serial numbers and/or loose items. If the warehouse created a new aggregation (e.g. created a new pallet, created a new mixed case), the aggregation hierarchies created in the warehouse are communicated in the Aggregation element. If an existing case is shipped, the case just needs to be scanned and the case hierarchy would not be provided. If a new mixed case is created, the hierarchy for the new case will be communicated. This enables the distribution warehouse to locally manage changes to aggregation hierarchies and communicate just the new aggregation hierarchies of the shipped goods at the time of shipment, without having to send disaggregation and aggregation events. The backend will perform the implicit disaggregate and aggregate operations to achieve the end state aggregation hierarchy prior to processing the shipment. It will also auto-commission the SSCC numbers for new cases and pallets when these SSCC numbers are not yet commissioned. |
|||||||
cmn:EventDateTime | 0/* |
0...1DateTime |
Timestamp of date/time of aggregation event with the UTC time zone indicator in format: YYYY-MM-DDTHH:MM:SS.ssZ. ![]() |
|||||||
cmn:EventTimeZoneOffset | 0/* |
0...1String |
Time zone offset of the place where the event occurred, consistent with what choice was made for cmn:eventTime. A time offset is the amount of time added or subtracted from UTC (Coordinated Universal Time) to get the current civil time regardless of whether it is standard time or Daylight saving time.74 |
|||||||
cmn:EventLocation | 1/* |
1...1String | Required. Site-level SGLN of the location where the event occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). | |||||||
cmn:ParentSerial | 1/* |
1...1String | 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- | The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers. | |||||||
@filterValue | - |
0...1- | The filter value used in GTIN-14 and SSCC serial numbers. | |||||||
@format | 1/* |
0...1String | Required. The format of the serial number. See the Format enumeration list for valid values. |
|||||||
@packedStatus | 1/* |
0...1String | The packed status of the item or container using the supported enumeration values. See the PackedStatus enumeration list for valid values. |
|||||||
cmn:PackagingLevel | 0* |
0...1String | The packaging level of the commissioned item using the supported enumeration values. See the PackagingLevel enumeration list for valid values. |
|||||||
cmn:NumberList | - |
1...1- | Required. Contains the list of serial numbers for the items packed into the parent 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/* |
0...1String | The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers. | |||||||
@filterValue | 0/* |
0...1String | The filter value used in GTIN-14 and SSCC serial numbers. | |||||||
@format | 1/* |
0...1String | Required. The format of the serial number. See the Format enumeration list for valid values. |
|||||||
@packedStatus | 1/* |
0...1String | The packed status of the item or container using the supported enumeration values. See the PackedStatus enumeration list for valid values. |
|||||||
@orderItemNumber | 0/* |
0...1String | Order item number attribute associating specific serial numbers with the price, VAT, and cost taxes reported in a specific instance of cmn:orderItem. |