ESM Shipment Guidelines (EPCIS v1.0)

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

Message Type: SOM_ESM_SHIPMENT

Info Exchange Display Name: ESM Shipment

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. The EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. *1
  @creationDate [1…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 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 Identifier element is a GLN per GS1 standards. *4
          @Authority [1…1]
[1/*]		 String Required. 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 transaction.
        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 shipping 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. The main body of the shipment message.
    EventList [1…1]
[-]		 - Required. The EventList includes one ObjectEvent (one for shipping).
      ObjectEvent [0…*]
[-]		 - The ObjectEvent indicates the transaction type. Choice 1 for the EventList. Data = ObjectEvent for the Commissioning Events.

EventList = ObjectEvent when all of the following is true:

  • action = OBSERVE
  • bizStep = urn:epcglobal:cbv:bizstep:shipping
  • 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
        recordTime [0…1]
[0/*]		 DateTime 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]
[-]		 - 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. *13
        action [1…*]
[0/*]		 String Required. The action type of the event. The action value must equal OBSERVE for a shipping event. *14
        bizStep [1…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. *15
        disposition [1…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:in_transit. *16
        readPoint [1…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. *17
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizLocation [0…1]
[-]		 - Not used.
          id [1…1]
[1/*]		 AnyURI Required. Not used. *18
          extension [0…1]
[-]		 - Not used - GS1 Reserved.
        bizTransactionList [0…1]
[-]		 - Conditionally required if bizStep = 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 bizTransaction type using the provided enumerators. Valid values:
  • ASN
  • INVOICE
  • PO
  • TRANSFER
        extension [0…1]
[-]		 - Not used - GS1 Reserved.
        tl:shippingEventExtensions [0…*]
[-]		 - Conditionally required for China or if Shipping Event is populated. The extensions used for the 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. *19
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. Advises regulatory reporting (will be a two- or three-letter ISO country code for ship to country) if it is mandatory 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 TraceLink. *20

See the ISOCountryCode enumeration list for valid values.
          tl:shipFromCountryCode [0…1]
[2/2]		 String Conditionally required if the Shipment Type is set to Sale - Export, Return - Export, or Transfer - Export. 2 letter ISO country code for the ship from country. This value will be referenced to advise regulatory reporting if it is mandatory for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in TraceLink. *21

The system should default the ship from country code to the value in ship to country code when the Shipment Type is set to Sale – Export, Return – Export, or Transfer – Export; otherwise, the field is optional.

See the ISOCountryCode enumeration list for valid values.
          tl:salesDistributionType [0…1]
[1/*]		 String Required. Advises regulatory reporting of exportation, 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 TraceLink.

To set this value, compare the ship from country with the ship to country.

See the SalesDistType enumeration list for valid values.

          tl:supplyType [0…1]
[0/*]		 String

Conditionally required in the following cases:

  • For Brazil, only if performing a Collection, Donation, or SampleDistribution.
  • If tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or INCOUNTRYSALE; all values except for Collection apply.

Identifies the type of supply that is being performed using one of the enumerations.

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 enumerations.

See the ContractType enumeration list for valid values.
          tl:dropShipmentIndicator [0…1]
[0/*]		 Boolean Indicates if the shipment is a drop shipment.  
          tl:comments [0…1]
[0/*]		 String Optional remarks or comments associated with delivery.
          tl:warehouseOperatorName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible for warehouse operations in the transfer from business entity. *22
          tl:correctiveShipment [0…1]
[1/*]		 Boolean If true, indicates that a new Serialized Operations Manager Shipment is correcting a previously voided Serialized Operations Manager Shipment message. Default value is false, which indicates that it is not a corrective shipment.  
          tl:originalDeliveryNumber [0…1]
[0/*]		 String Original delivery number. Records original delivery number replaced when shipment voided and corrections made to delivery.  
          tl:orderItemList [0…1]
[-]		 - Conditionally required to include at least one OrderItem group if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or INCOUNTRYSALE. The order item list including details about the shipment order item.
            tl:orderItem [1…*]
[-]		 - Required. Details about shipment order item.
              tl:internalMaterialCode [0…1]
[0/*]		 String Conditionally required if tl:packagingItemCode is not populated. Used to identify the product using the internal material number configured in Product Master Data. *23
All packaging levels must have the same tl:internalMaterialCode.
              tl:packagingItemCode [0…1]
[0/*]		 String Conditionally required if tl:internalMaterialCode is not populated. Used to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *24
                @type [1…1]
[1/*]		 String Required. 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. *25
              tl:quantity [1…1]
[1/*]		 Integer Conditionally required to be present and greater than zero if tl:isSerialized = false. The quantity of items at the EACH (unit) level of the item code. *26
              tl:unitPrice [0…1]
[1/*]		 Decimal Conditionally required if tl:shipFromCountryCode = KR and tl:salesDistributionType = EXPORTSALE or INCOUNTRYSALE. The unit price of an item. Zero is an acceptable answer.  *27
                @currencyCode [1…1]
[3/3]		   Required. Currency ISO code using ISO 4217-2015 format. *28
              tl:isSerialized [0…1]
[0/*]		 Boolean Indicates if item is serialized. If omitted, the default value is set 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 fromBusiness entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below: *29
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 is provided.
  • 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

Conditionally required in the following cases:

  • For Argentina: the business classification of the sold from party is provided by using one of the enumerations.
  • If tl:shipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE.

The business type of the assigned entity.

See the BusinessClassification enumeration list for valid values.
            tl:address [0…1]
[-]		 - Conditionally required for US. 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 *30
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the business street address (associated with tl:businessName). *31
              tl:street2 [0…1]
[0/*]		 String The second line of the business street address (associated with tl:businessName). *32
              tl:city [1…1]
[1/*]		 String Required. The business city address (associated with tl:businessName). *33
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India. *34
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. *35
              tl:postalCode [0…1]
[1/*]		 String The business party's postal/zip code (associated with tl:businessName). *36
              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. *37
            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 [1…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. *38
              @agency [1…1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number. *39
            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. *40
              tl:title [0…1]
[0/*]		 String The title of the person indicated in the name field of the business entity. *41
              tl:telephone [0…1]
[1/*]		 String The telephone number of the business entity indicated in the businessName field. This must begin with the + character followed by the Country Calling Code. *42
              tl:email [0…1]
[0/*]		 String The email address of the business entity indicated in tl:businessName. *43
              tl:url [0…1]
[0/*]		 String The website of the business entity indicated in tl:businessName. *44
          tl:shipFromLocation [1…1]
[-]		 - Required. The full business information associated with the ship from business entity.
            tl:facilityId [1…*]
[1/*]		 String Required. The identifier associated with the shipFrom business entity. This value is mandatory for regulatory reporting. *45
              @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 business type of the assigned entity.

Valid values:

  • CARRYING_FORWARDING_AGENT
  • CHEMIST
  • DISTRIBUTOR
  • EXPORTER
  • FINANCER
  • HEALTHCARE
  • IMPORTER
  • LOGISTICS
  • MANUFACTURER
  • PACKAGER
  • PHARMACY
  • RETURNSPROCESSOR
  • STOCKIST
  • WHOLESALER
            tl:address [0…1]
[-]		 - Conditionally required for US. 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 the businessName field. 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 is provided.
  • 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. See the BusinessAndLocationId enumeration list for valid values:
            tl:businessClassification [0…1]
[0/*]		 String

Conditionally required in the following cases:

  • For Argentina: the business classification of the sold from party is provided by using one of the enumerations.
  • If tl:shipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE.

The business type of the assigned entity. Valid values:

  • CARRYING_FORWARDING_AGENT
  • CHEMIST
  • DISTRIBUTOR
  • EXPORTER
  • FINANCER
  • HEALTHCARE
  • IMPORTER
  • LOGISTICS
  • MANUFACTURER
  • PACKAGER
  • PHARMACY
  • RETURNSPROCESSOR
  • STOCKIST
  • WHOLESALER
            tl:address [0…1]
[-]		 - Conditionally required for US. 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]
[-]		 - This element contains 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:shipToLocation [1…1]
[-]		 - Required. The full business information associated with the ship to business entity.
            tl:facilityId [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 business type of the assigned entity.

Valid values:

  • CARRYING_FORWARDING_AGENT
  • CHEMIST
  • DISTRIBUTOR
  • EXPORTER
  • FINANCER
  • HEALTHCARE
  • IMPORTER
  • LOGISTICS
  • MANUFACTURER
  • PACKAGER
  • PHARMACY
  • RETURNSPROCESSOR
  • STOCKIST
  • WHOLESALER
            tl:address [0…1]
[-]		 - Conditionally required for US. 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 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 carrier party are provided.
  • For company's physically located in Brazil: The BR_CNPJ number associated with the carrier party is provided.
  • China: The company identifier registered with China SFDA used to identify the carrier party is provided.
  • Turkey: The GLN associated with the carrier party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the carrier party is provided.

See the BusinessAndLocationId enumeration list for valid values:
              @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. 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 Required. 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.