Shipment Event Guidelines (EPCIS v1.0)

See How To Use this Guide before interpreting the guidelines below.

Message Type: SOM_SHIPMENT_EVENT_IB

Info Exchange Display Name: Received Shipment 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.
Only send top-level container serial numbers for this message.
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 [0…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. *1
  @creationDate [0…1]
[1/*]		 DateTime Required. The date that the message was created in XML datetime format YYYY-MM-DDTHH:MM:SSZ. *2
  EPCISHeader [1…1]
[-]		 - Required. The XML file control header.
    sbdh:StandardBusinessDocumentHeader [1…1]
[-]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information along with the document identification.
      sbdh:HeaderVersion [1…1]
[0/*]		 String Required. The version of the Standard Business Document Header (SBDH). The sbdh:HeaderVersion is set to 1.0. *3
      sbdh:Sender [1…*]
[-]		 - Required. A unique identification key for the Sender party of the message, representing the organization which created the standard business document. The sbdh:Sender element must only be used once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The GLN identifier for the sender. The value of the sbdh:Identifier element is a GLN per GS1 standards. *4
          @Authority [1…1]
[1/*]		 String Required. This attribute defines the sender identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages. *5
        sbdh:ContactInformation [0…*]
[-]		 - This field is not used.
      sbdh:Receiver [1…*]
[-]		 - Required. A unique identification key for the direct Receiver party of the message, representing the organization which receives the standard business document. The sbdh:Receiver element is used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The GLN identifier for the receiver. The value of the sbdh:Identifier element is a GLN per GS1 standards.
          @Authority [1…1]
[1/*]		 String Required. The receiver identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages.
        sbdh:ContactInformation [0…*]
[-]		 - This field is not used.
      sbdh:DocumentIdentification [1…1]
[-]		 - Required. The identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. The name of the document standard contained in the file/message. The standard value for this field is EPCglobal. *6
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. The version of the document included. This is the complete version of the document itself and is different from the sbdh:HeaderVersion as these are hard-coded values. The sbdh:TypeVersion is set to 1.0. *7
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. The reference information, which uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This is a hard-coded value. This identifier confirms this document as being distinct from others. *8
        sbdh:Type [1…1]
[0/*]		 String Required. The document type. The sbdh:Type value is set to Events for a shipment event. *9
        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. *10
  EPCISBody [1…1]
[-]		 - Required. Only one of the following choice options may be selected in any one loop on EPCISBody | EventList: ObjectEvent or AggregationEvent.
    EventList [1…1]
[-]		 - Required. The EventList has the following structure:
  • ObjectEvent (one or more for commissioning)
  • AggregationEvent (one or more for aggregation)
  • ObjectEvent (one for shipping).
      Choice [-]
[-]		 Choice Required. Either ObjectEvent or AggregationEvent must be chosen for the EventList, but not both. This choice is for inbound messages only.
      ObjectEvent [0…1]
[-]		 - The ObjectEvent indicates the message type. Choice 1 for the EventList. Data = ObjectEvent for the Commissioning Events.

EventList = ObjectEvent 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. The time stamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. 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. *11
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        recordTime [0…1]
[0/*]		 DateTime This field is not used. 
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time - whether it is standard time or daylight saving time. Per Section 7.2.8 of [EPCIS1.0.1]. *12
        baseExtension [0…1]
[-]		 - This field is not used. 
        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. *13
        action [1…1]
[0/*]		 String Required. The action type of the event. For a shipping event, this value must equal ADD. *14
        bizStep [0…1]
[0/*]		 AnyURI Required. This value indicates the business step taken in the event. The bizStep value must equal urn:epcglobal:cbv:bizstep:commissioning. *15
        disposition [0…1]
[0/*]		 AnyURI Required. The bizStep and disposition fields define the message event and are grouped together under the GS1 EPCIS guidelines. The disposition indicates the status of the message. The disposition value must equal urn:epcglobal:cbv:disp:active. *16
        readPoint [0…1]
[-]		 - This field identifies the location where the event occurred, i.e. the warehouse GLN location ID and storage location (e.g. shelf, bin), in URN format.
          id [1…1]
[0/*]		 AnyURI Required. This field indicates the SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a finer-grain location identifier. *17
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizLocation [0…1]
[-]		 - 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.
          id [1…1]
[1/*]		 AnyURI Required. The SGLN EPC of the location from where the event occurred. *18
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizTransactionList [0…1]
[-]		 - This field is not used.
        extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        tl:commissionEventExtensions [0…1]
[-]		 - Conditionally required for China. This element contains the extensions used for the commission ObjectEvent. Mandatory for a commission event.
          tl:filterValue [0…1]
[-]		 Integer

This field is not used.
          tl:packagingLevel [1…1]
[-]		 - Required. The packaging level of the commissioned item using the supported enumeration values (enumerator is mandatory). *19

See the PackagingLevel enumeration list for valid values.
          tl:epcAttributes [0…*]
[-]		 - This field supports optional inclusion of human readable barcode content that is associated with each epc number in a commission event. This information is included only if provided in the original commission event.
            @epc [1…1]
[1/*]		 String Required. The identifier of the child items in the parent container in EPC Pure Identity URI format as specified in Section 6 of (TDS1.5). See EPC Pure Identifier Format Examples. *20
            tl:barcodeContent [1…1]
[1/*]		 String  Required. The human readable barcode contents encoded in the 2D barcode with parenthesis for the AI keys. *21
          tl:plantLocationId [0…1]
[0/*]		 String Identifier of plant where products were commissioned. *22
          tl:productionLineId [0…1]
[1/*]		 String Conditionally required for China. The identifier of the production line where products were commissioned. *23
          tl:lineManagerName [0…1]
[0/*]		 String Conditionally required for China. The name of the person responsible as the production line manager for the commissioned products. *24
          tl:companyPrefix [0…1]
[0/*]		 String This field is not used.
          tl:itemDetail [0…1]
[-]		 - The product attributes associated with the commissioned serial number(s).
            tl:internalMaterialCode [0…1]
[0/*]		 String The internal material number for the product in the Pharmaceutical Manufacturer's internal systems (such as ERP). *25
The message may include either tl:internalMaterialCode, tl:countryDrugCode, or both, but all packaging levels must be consistent.
            tl:packagingItemCode [0…1]
[0/*]		 String The product code for the commissioned item. *26
              @type [1…1]
[1/*]		 String

Conditionally required if tl:packagingItemCode is present. Indicates the ItemCode type with the provided enumerators.

See the ItemCode enumeration list for valid values.
            tl:countryDrugCode [0…1]
[0/*]		 String The national drug code for the commissioned item. *27
The message may include either tl:internalMaterialCode, tl:countryDrugCode, or both, but all packaging levels must be consistent.
              @type [0…1]
[1/*]		 String Required. Indicates the countryDrugCode with the provided enumerators. Valid values:
  • AT_PZN
  • BE_ABP_CODE
  • BR_ANVISA_REGISTRATION
  • CA_DIN
  • CH_SWISSMEDIC
  • CN_SUBTYPE
  • DE_PZN
  • ES_CODIGO_NATIONAL
  • FR_CIP13
  • GR_EOFCODE
  • IT_BOLLINO
  • KR_KFDA_CODE
  • LU_NATIONAL_NUMBER
  • NRD_VNR_CODE
  • PT_AIM
  • SA_SAUDI_DRUG_CODE
  • UK_AMPP
  • US_NDC442
  • US_NDC532
  • US_NDC541
  • US_NDC542
            tl:lot [1…1]
[1/*]		 String Required. The lot or batch code for the serialized item. *28
            tl:expiry [1…1]
[10/10]		 Date Required. The expiration date for the serialized item, formatted in YYYY-MM-DD format. *29
            tl:manufacturingDate [0…1]
[0/10]		 Date The date of manufacture for the serialized item, formatted in YYYY-MM-DD format. *30
            tl:countryMarket [0…1]
[0/3]		 String

The target country market indicated by the approved ISO country code enumerations.

See the ISOCountryCode enumeration list for valid values.
          tl:referenceDocuments [0…1]
[-]		 - The reference document identifier associated with the commissioning activity.
            tl:poNumber [0…1]
[0/*]		 String Conditionally required for transaction type PO. The purchase order number associated with the serial number indicated. *31
            tl:poLine [0…1]
[0/*]		 String The purchase order line number. *32
            tl:workOrderNumber [0…1]
[0/*]		 String The work order number associated with serial number use. *33
            tl:referenceIdentifier [0…1]
[0/*]		 String The reference identifier (such as any type of identifier) associated with serial number use. *34
      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. The time stamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. 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. *35
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        recordTime [0…1]
[0/*]		 DateTime This field is not used.
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time - whether it is standard time or daylight saving time, per Section 7.2.8 of [EPCIS1.0.1]. *36
        baseExtension [0…1]
[-]		 - This field is not used.
        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). *37 See EPC Pure Identifier Format Examples.
        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. *38 See EPC Pure Identifier Format Examples.
        action [1…1]
[1/*]		 String

Required. The action taken in the message, e.g. an action value is set to ADD for a commissioning event and to DELETE for a decommission event. The action value must equal ADD for an aggregation event.

See the ActionType enumeration list for valid values.
        bizStep [0…1]
[0/*]		 AnyURI The business step taken in the event. The bizStep value must equal urn:epcglobal:cbv:bizstep:packing for an aggregation Event.
        disposition [0…1]
[0/*]		 AnyURI The status of the message, which is grouped with the bizStep and action fields to define the message event. The disposition value must equal urn:epcglobal:cbv:disp:in_progress for an aggregation event.
        readPoint [0…1]
[-]		 - 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 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.
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizLocation [0…1]
[-]		 - 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.
          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.
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizTransactionList [0…1]
[-]		 - This field is not used.
        extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        tl:aggregationEventExtensions [0…1]
[-]		 - The extensions used for the aggregation event.
          tl:packedStatus [0…1]
[0/*]		 String

The packed status of the item or container using the supported enumeration values.

See the PackedStatus enumeration list for valid values.
          tl:quantity [0…1]
[-]		 Integer The quantity of child serial numbers aggregated to the parent container in this aggregation event. *39
      ObjectEvent [0…*]
[-]		 - Choice 2 for EventList. Data = ObjectEvent for Shipping Events. The ObjectEvent indicates the transaction type

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

  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:shipping
  • disposition = urn:epcglobal:cbv:disp:in_transit
        eventTime [1…1]
[1/*]		 DateTime Required. The time stamp of date/time when the event occurred. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. 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.
The Event Time must be indicated in seconds. Default milliseconds to 0. This results in efficiency gains and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        recordTime [0…1]
[0/*]		 DateTime This field is not used. 
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time - whether it is standard time or daylight saving time. Per Section 7.2.8 of [EPCIS1.0.1].
        baseExtension [0…1]
[-]		 - This field is not used. 
        epcList [1…1]
[-]		 - Required. List of the EPCs of topmost containers (e.g. pallets, cases) in the shipment.
          epc [1…*]
[1/*]		 String Required. The identifier of the epc type in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples.
        action [1…1]
[0/*]		 String

Required. The action type of the event. The action value must equal OBSERVE for a shipping event.

See the ActionType enumeration list for valid values.
        bizStep [0…1]
[0/*]		 AnyURI Required. The business step taken in the event. The bizStep value must equal urn:epcglobal:cbv:bizstep:shipping for a shipping event.
        disposition [0…1]
[0/*]		 AnyURI Required. The bizStep and disposition fields define the message event and are grouped together under the GS1 EPCIS guidelines. The disposition indicates the status of the transaction. The disposition value must equal urn:epcglobal:cbv:disp:in_transit for a shipping event.
        readPoint [0…1]
[-]		 - Required. The location where the event occurred; that is, the warehouse GLN location ID and storage location (e.g. shelf, bin) in URN format, that recorded the shipping 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.
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizLocation [0…1]
[-]		 - This field is not used.
          id [1…1]
[1/*]		 AnyURI Required. This field is not used.
          extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        bizTransactionList [0…1]
[-]		 - Conditionally required for a ship event when bizStep equals urn:epcglobal:cbv:bizstep:shipping. 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).
            @type [1…1]
[1/*]		 String

Required. The business transaction identifier type. See the TransactionId enumeration list for valid values.
        extension [0…1]
[-]		 - This field is not used - GS1 Reserved.
        tl:shippingEventExtensions [1…*]
[-]		 - Required. The extensions used for the Shipping Event. Mandatory for a shipping event.
          tl:transactionDate [1…1]
[10/10]		 Date Required. The date associated with the business transaction document in the bizTransactionList in YYYY-MM-DD format. This date may or may not be the same as the eventTime. *40
          tl:shipToCountryCode [1…1]
[1/3]		 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 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 system. *41

See the ISOCountryCode enumeration list for valid values.
          tl:shipFromCountryCode [0…1]
[0/3]		 String

Conditionally required if SalesDistributionType = 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. *42

See the ISOCountryCode enumeration list for valid values.
          tl:salesDistributionType [1…1]
[1/*]		 String

Required. This value will be 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. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink system.

See the SalesDistType enumeration list for valid values.
          tl:supplyType [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or INCOUNTRYSALE. Identifies the type of supply that is being performed using one of the permitted enumeration values. All values except for Collection apply.
Country Requirements:
  • Brazil: populate only if performing Collection, Donation, or SampleDistribution.

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 INCOUNTRYSALE. Identifies the type of contract for the sale of goods using one of the permitted enumeration values. 

See the ContractType enumeration list for valid values.
          tl:dropShipmentIndicator [0…1]
[0/*]		 Boolean Indicates if shipment is a drop shipment (when set to true).
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with delivery.
          tl:warehouseOperatorName [0…1] String Conditionally required for China. Name of the person responsible for warehouse operations in the transfer from business entity. *43
          tl:orderItemList [0…1]
[-]		 - The order item list group is populated to communicate the pick quantities for each item code at the EACH (unit) level.
            tl:orderItem [0…*]
[-]		 - The 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.
At least one OrderItem group is mandatory if ShipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE.
              choice1 [1…1]
[-]		 Choice Conditionally required if tl:shipFromCountryCode = KR. Either cmn:InternalMaterialCode or cmn:PackagingItemCode must be selected.
              tl:internalMaterialCode [0…1]
[0/*]		 String Conditionally required if tl:packagingItemCode is not populated. Option 1 for choice1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *44
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if tl:internalMaterialCode is not populated. Option 2 for choice1 in OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *45
                @type [1…1]
[1/*]		 String

Conditionally required if tl:packagingItemCode is not populated. The product code type for the packaging item code using the supported enumeration values.

See the ItemCode enumeration list for valid values.
              tl:lot [0…1]
[0/*]		 String The lot or batch code for the items to be picked (if available) in an alphanumeric string. *46
              tl:quantity [1…1]
[1/*]		 Integer Conditionally required and must be greater than zero if tl:isSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot, if specified to be picked. *47
              tl:unitPrice [0…1]
[0/*]		 Decimal Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or INCOUNTRYSALE. Note that zero is an acceptable value. Unit price of the item. *48
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format. *49

See the ISOCurrency enumeration list for valid values.
          tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is serialized. If omitted, the value defaults to true.
          tl:fromBusiness [1…1]
[-]		 - Required. The full business information associated with the sold from or transfer from business entity.
            tl:businessId [1…*]
[1/*]		 String Required. The identifier associated with the tl:fromBusiness entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below: *50
Country Requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • For company's physically located in Brazil: The BR_CNPJ number associated with the sold from party.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @type [1…1]
[1/*]		 String

Required.

The type of the business identifier. See the BusinessAndLocationId enumeration list for valid values.
            tl:businessClassification [0…1]
[0/*]		 String Conditionally required if ShipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE. The tl:businessClassification field is an attribute of the fromBusiness element. This field indicates the business type of the assigned entity.
Country Requirements:
  • Mandatory for Argentina: Provide the business classification of the sold from party is provided by using one of the enumerations.

See the BusinessClassification enumeration list for valid values.
            tl:address [0…1]
[-]		 - Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner.
              tl:businessName [1…1]
[1/*]		 String Required. The business name of a customer or trade partner. *51
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the business street address (associated with tl:businessName). *52
              tl:street2 [0…1]
[0/*]		 String The second line of the business street address (associated with tl:businessName). *53
              tl:city [1…1]
[1/*]		 String Required. The business city address (associated with tl:businessName). *54
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India. *55
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The business party's state or regional address (associated with tl:businessName). The state, province, or region uses the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *56
              tl:postalCode [0…1]
[0/*]		 String The business party's postal/zip code (associated with tl:businessName). *57
              tl:country [1…1]
[1/*]		 String Required. The business party's country code (associated with tl:businessName). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *58
            tl:licenseNumber [0…*]
[0/*]		 String This element contains the facility's license number. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
              @state [0…1]
[0/*]		 String Required. The state or region in which the business entity is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute provides additional context to the license number. *59
              @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number. *60
            tl:contactInfo [0…1]
[-]		 - The contact information to be used by downstream trading partners to verify the message's information.
              tl:name [1…1]
[0/*]		 String Required. The name of either an individual or department that represents the business entity. *61
              tl:title [0…1]
[0/*]		 String The title of the person indicated in the name field of the business entity. *62
              tl:telephone [0…1]
[1/*]		 String The telephone number of the business entity indicated in tl:businessName. This must begin with the + character followed by the Country Calling Code. *63
              tl:email [0…1]
[0/*]		 String Indicates the email address of the business entity indicated in tl:businessName. *64
              tl:url [0…1]
[0/*]		 String Indicates the website of the business entity indicated in tl:businessName. *65
          tl:shipFromLocation [0…1]
[-]		 - The full business information associated with the ship from business entity.
            tl:facilityId [1…*]
[1/*]		 String Conditionally required if tl:shipFromLocation is populated. The identifier (see BusinessAndLocationId for enumerators) associated with the shipFrom business entity. *66
              @type [1…1]
[1/*]		 String

Required.

The type of the identifier associated with shipFrom business entity.

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

Conditionally required for Argentina; the business classification of the ship from party is provided by using one of the enumerations. The businessClassification field is an attribute of the shipFrom element. This field indicates the business type of the assigned entity.

See the BusinessClassification enumeration list for valid values.
            tl:address [0…1]
[-]		 - Conditionally required for US. Populated with the business name and address of the ship from business entity.
              tl:businessName [1…1]
[1/*]		 String Required. The business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the business street address (associated with tl:businessName).
              tl:street2 [0…1]
[0/*]		 String The second line of the business street address (associated with tl:businessName).
              tl:city [1…1]
[1/*]		 String Required. The business city address (associated with tl:businessName).
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The business party's state or regional address (associated with tl:businessName). The state, province, or region uses the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
              tl:postalCode [0…1]
[0/*]		 String The business party's postal/zip code (associated with tl:businessName).
              tl:country [1…1]
[1/*]		 String Required. The business party's country code (associated with tl:businessName). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
            tl:licenseNumber [0…*]
[0/*]		 String The facility's license number. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
              @state [0…1]
[0/*]		 String Required. This field indicates the state or region in which the business entity is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute provides additional context to the license number.
              @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - The contact information to be used by downstream trading partners to verify the message's information.
              tl:name [1…1]
[0/*]		 String Required. The name of either an individual or department that represents the business entity.
              tl:title [0…1]
[0/*]		 String The title of the person indicated in the name field of the business entity.
              tl:telephone [0…1]
[0/*]		 String The telephone number of the business entity indicated in tl:businessName. This must begin with the + character followed by the Country Calling Code.
              tl:email [0…1]
[0/*]		 String The email address of the business entity indicated in tl:businessName.
              tl:url [0…1]
[0/*]		 String The website of the business entity indicated in tl:businessName.
          tl:toBusiness [1…1]
[-]		 - Required. The full business information associated with the sold to or transfer to business entity.
            tl:businessId [1…*]
[1/*]		 String Required. The identifier associated with the fromBusiness entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below:
Country Requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold to party are provided.
  • For company's physically located in Brazil: The BR_CNPJ number associated with the sold to party.
  • China: The company identifier registered with China SFDA used to identify the sold to party is provided.
  • Turkey: The GLN associated with the sold to party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold to party is provided.
              @type [1…1]
[1/*]		 String

Required.

The type of the business identifier. See the BusinessAndLocationId enumeration list for valid values.
            tl:businessClassification [0…1]
[0/*]		 String Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or INCOUNTRYSALE. The businessClassification field is an attribute of the fromBusiness element. This field indicates the business type of the assigned entity.
Country Requirements:
  • Mandatory for Argentina: the business classification of the sold from party is provided by using one of the enumerations.

See the BusinessClassification enumeration list for valid values.
            tl:address [0…1]
[-]		 - Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner.
              tl:businessName [1…1]
[1/*]		 String Required. The business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the business street address (associated with tl:businessName).
              tl:street2 [0…1]
[0/*]		 String The second line of the business street address (associated with tl:businessName).
              tl:city [1…1]
[1/*]		 String Required. The business city address (associated with tl:businessName).
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The business party's state or regional address (associated with tl:businessName). The state, province, or region uses the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
              tl:postalCode [0…1]
[1/*]		 String The business party's postal/zip code (associated with tl:businessName).
              tl:country [1…1]
[1/*]		 String Required. The business party's country code (associated with tl:businessName). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
            tl:licenseNumber [0…*]
[0/*]		 String The facility's license number. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
              @state [0…1]
[0/*]		 String Required. The state or region in which the business entity is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute provides additional context to the license number.
              @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - The contact information to be used by downstream trading partners to verify the message's information.
              tl:name [1…1]
[0/*]		 String Required. The name of either an individual or department that represents the business entity.
              tl:title [0…1]
[0/*]		 String The title of the person indicated in tl:businessName.
              tl:telephone [0…1]
[1/*]		 String The telephone number of the business entity indicated in tl:businessName. This must begin with the + character followed by the Country Calling Code.
              tl:email [0…1]
[0/*]		 String The email address of the business entity indicated in tl:businessName.
              tl:url [0…1]
[0/*]		 String The website of the business entity indicated in tl:businessName.
          tl:shipToLocation [1…1]
[-]		 - Required. The full business information associated with the ship to business entity.
            tl:facilityId [1…*]
[1/*]		 String Required. The identifier (see BusinessAndLocationId for enumerators) associated with the shipFrom business entity. This value is mandatory for regulatory reporting.
              @type [1…1]
[1/*]		 String Required.

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

Conditionally required for Argentina; the business classification of the ship from party is provided by using one of the enumerations. The businessClassification field is an attribute of the shipFrom element. This field indicates the business type of the assigned entity.

See the BusinessClassification enumeration list for valid values.
            tl:address [0…1]
[-]		 - Conditionally required for US. This TraceLink required value is populated with the business name and address of a customer or trade partner.
              tl:businessName [1…1]
[1/*]		 String Required. The business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the business street address (associated with tl:businessName).
              tl:street2 [0…1]
[0/*]		 String The second line of the business street address (associated with tl:businessName).
              tl:city [1…1]
[1/*]		 String Required. The business city address (associated with tl:businessName).
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The business party's state or regional address (associated with tl:businessName). The state, province, or region uses the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
              tl:postalCode [0…1]
[1/*]		 String The business party's postal/zip code (associated with tl:businessName).
              tl:country [1…1]
[1/*]		 String Required. The business party's country code (associated with tl:businessName). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
            tl:licenseNumber [0…*]
[0/*]		 String The facility's license number. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
              @state [0…1]
[0/*]		 String Required. The state or region in which the business entity is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute provides additional context to the license number.
              @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - The contact information to be used by downstream trading partners to verify the message's information.
              tl:name [1…1]
[0/*]		 String Required. The name of either an individual or department that represents the business entity.
              tl:title [0…1]
[0/*]		 String The title of the person indicated in the name field of the business entity.
              tl:telephone [0…1]
[1/*]		 String The telephone number of the business entity indicated in tl:businessName. This must begin with the + character followed by the Country Calling Code.
              tl:email [0…1]
[0/*]		 String The email address of the business entity indicated in tl:businessName.
              tl:url [0…1]
[0/*]		 String The website of the business entity indicated in tl:businessName.
          tl:carrierParty [0…1]
[-]		 - The full business information associated with the carrier responsible for delivering the shipment.
            tl:businessId [1…*]
[1/*]		 String Required. The identifier associated with the fromBusiness entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below:
Country Requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • For company's physically located in Brazil: The BR_CNPJ number associated with the sold from party.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @type [1…1]
[1/*]		 String

Required.

See the BusinessAndLocationId enumeration list for valid values.
            tl:businessClassification [0…1]
[0/*]		 String This field is not used.
            tl:address [0…1]
[-]		 - Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner.
              tl:businessName [1…1]
[1/*]		 String Required. The business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the business street address (associated with tl:businessName).
              tl:street2 [0…1]
[0/*]		 String The second line of the business street address (associated with tl:businessName).
              tl:city [1…1]
[1/*]		 String Required. The business city address (associated with tl:businessName).
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The business party's state or regional address (associated with tl:businessName). The state, province, or region uses the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
              tl:postalCode [0…1]
[1/*]		 String The business party's postal/zip code (associated with tl:businessName).
              tl:country [1…1]
[1/*]		 String Required. The business party's country code (associated with tl:businessName). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
            tl:licenseNumber [0…*]
[0/*]		 String The facility's license number. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
              @state [0…1]
[0/*]		 String Required. The state or region in which the business entity is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute provides additional context to the license number.
              @agency [0…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - The contact information to be used by downstream trading partners to verify the message's information.
              tl:name [1…1]
[0/*]		 String Required. The name of either an individual or department that represents the business entity.
              tl:title [0…1]
[0/*]		 String The title of the person indicated in the name field of the business entity.
              tl:telephone [0…1]
[1/*]		 String The telephone number of the business entity indicated in tl:businessName. This must begin with the + character followed by the Country Calling Code.
              tl:email [0…1]
[0/*]		 String The email address of the business entity indicated in tl:businessName.
              tl:url [0…1]
[0/*]		 String The website of the business entity indicated in tl:businessName.