ESM Receipt Guidelines (EPCIS v1.0)

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

Message Type: SOM_ESM_RECEIPT

Info Exchange Display Name: ESM Receipt

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.
Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[-]		 - Required. 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 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. The sender identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages. *5
      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: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 receive 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 message.
    EventList [1…1]
[-]		 - Required. All events within the transaction including event details. Mandatory for Serialized Operations Manager Receive event.
      ObjectEvent [1…*]
[-]		 - Required. The ObjectEvent indicates the transaction type. Mandatory for Serialized Operations Manager Receive events. See Transaction Identifiers for field configuration information.
        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]. *11
        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. In GMT. *12
        epcList [0…1]
[-]		 - A list of the EPCs of topmost containers (e.g. pallets, cases) in the shipment.
          epc [0…*]
[0/*]		 AnyURI Serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. Non-GS1 serial numbers (e.g. China) are expressed in native format. See EPC Pure Identifier Format Examples. *13
        action [1…1]
[0/*]		 String Required. The action type of the event. Mandatory for Serialized Operations Manager Receive event. The action value must equal OBSERVE. *14
        bizStep [0…1]
[0/*]		 AnyURI Required. The business step taken in the event. The bizStep value must equal urn:epcglobal:cbv:bizstep:receiving for a receive event. *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 field indicates the status of the message. The disposition value must equal urn:epcglobal:cbv:disp:in_progress for a receive event. *16
        readPoint [0…1]
[-]		 - 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 receive 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
        bizLocation [0…1]
[-]		 - Not used.
          id [1…1]
[1/*]		 AnyURI Required. Not used. *18
        bizTransactionList [0…1]
[-]		 - Required. A list of the business transaction identifiers. For a receive event, this element is mandatory when bizStep equals urn:epcglobal:cbv:bizstep:receiving for a receive event.
          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 the customer issues a PO Number, the customer GLN is entered; if the supplier issues ASN/delivery number, the supplier GLN is entered). *19

Different states have different requirements for the transaction number. For optimal pedigree compliance purposes, the Purchase Order number should always be included, and the Invoice Number and Dispatch Advice (Advance Ship Notice) identifier included whenever they are available.

Country requirements:
  • Mandatory for Argentina: Provide Packing Slip Number.
  • Mandatory for China: Provide Sales Order Number.
            @type [1…1]
[1/*]		 String Required. The business transaction type.

Valid values:

  • urn:epcglobal:cbv:btt:desadv = ASN number
  • urn:epcglobal:cbv:btt:inv = Invoice number
  • urn:epcglobal:cbv:btt:po = Customer PO number
  • urn:epcglobal:cbv:btt:transfer = Transfer Order number
  • urn:epcglobal:cbv:btt:salesorder = Sales Order number
  • urn:epcglobal:cbv:btt:rma = Return Authorization number
  • urn:epcglobal:cbv:btt:destruction = Destruction document number
  • urn:epcglobal:cbv:btt:packslip = Packing Slip number
  • urn:epcglobal:cbv:btt:bol = Bill of Lading
  • urn:epcglobal:cbv:btt:other = Other
  • http://epcis.gs1br.org/hc/btt/notafiscal = Brazil Nota Fiscal
        tl:receivingEventExtensions [1…*]
[-]		 - Required. The extensions used for Receiving Event.
          tl:transactionDate [1…1]
[10/10]		 Date Required. The date associated with the business message document in the bizTransactionList, in XML date format YYYY-MM-DD. *20
          tl:shipToCountryCode [1…1]
[2/2]		 String Required. The tl:shipToCountryCode field is referenced to advise 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 the TraceLink application. *21

See the ISOCountryCode enumeration list for valid values.

          tl:shipFromCountryCode [0…1]
[0/3]		 String Conditionally required. ISO country code for ship from country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events. *22

See the ISOCountryCode enumeration list for valid values.
          tl:receiptDistributionType [1…1]
[1/*]		 String The types of regulatory reporting that may be triggered based on the nature of the message. Valid values:
  • IMPORTPURCHASE - Purchase made into one country from another.
  • IMPORTRETURN - Return made into one country from another.
  • IMPORTTRANSFER - Transfer made into one country from another.
  • INCOUNTRYPURCHASE - Purchase made within the same country
  • INCOUNTRYRETURN - Return made within the same country.
  • INCOUNTRYTRANSFER - Transfer made within the same country.
          tl:supplyType [0…1]
[0/*]		 String Conditionally required depending on the country requirements. Identifies the type of supply that is being performed using one of the permitted values.
Country requirements:
  • Brazil: Populate only if performing Collection, Donation, or SampleDistribution.
  • Mandatory if ShipToCountryCode = KR and receiptDistributionType = INCOUNTRYRETURN (all values except for Collection apply).

See the SupplyType enumeration list for valid values.
          tl:contractType [0…1]
[0/*]		 String Conditionally required if ShipToCountryCode = KR (Korea) and receiptDistributionType = INCOUNTRYRETURN. Identifies the type of contract for the sale of goods using one of the permitted values.

See the ContractType enumeration list for valid values.
          tl:comments [0…1]
[0/*]		 String Optional comments or remarks regarding the delivery.
          tl:orderItemList [0…1]
[-]		 - Conditionally required to include at least one OrderItem group under OrderDetails | OrderItemList if ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. The tl:orderItemList list group is populated to communicate the expected pick quantities for each item code at the EACH (unit) level. This information is used in verification of the actual serial number, picked to verify the correct product, correct lot number (if provided) and the correct each quantity.
            tl:orderItem [1…*]
[-]		 - Required. A repeating element that captures the item code, lot number, and quantity for each item that will be picked for the order. Each unique item code and lot number are communicated in a separate order item group.
Country Requirements:
  • If ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN, there must be at least one OrderItem group under OrderDetails| OrderItemList.
  • Mandatory if OrderItemList is populated.
              Choice [1…1]
[-]		 Choice Conditionally required if ShipToCountryCode = KR. Populate only one of tl:InternalMaterialCode or tl:PackagingItemCode. One of the two options must be present.
              tl:internalMaterialCode [0…1]
[1/*]		 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. *23
              tl:packagingItemCode [0…1]
[1/*]		 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. *24
                @type [1…1]
[1/*]		 String Required. The product code type for the packaging item code using the supported enumeration values. Valid values:
  • CN-RESCODE
  • GTIN-14
  • NTIN
              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 have a quantity greater than zero if IsSerialized is false. The quantity of items at the EACH (unit) level of the item code and lot, if specified to be picked. *26
              tl:unitPrice [0…1]
[1/*]		 Decimal Conditionally required if ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. The unit price of an item. *27
                @currencyCode [1…1]
[3/3]		 String Required. Currency ISO code using ISO 4217-2015 format.

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0…1]
[0/*]		 String Indicates if item is not serialized. If omitted, defaults to true. *28
          tl:warehouseOperatorName [0…1]
[0/*]		 String Conditionally required for China. Name of the person responsible for warehouse operations in the transfer from business entity. *29
          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 business entity who sent the serial number(s). This value is mandatory for regulatory reporting. Different countries require different values as noted below: *30
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 based on country requirements. The businessClassification field is an attribute of the fromBusiness element. It indicates the business type of the assigned entity.
Country requirements:
  • Mandatory for Argentina. Valid values:
    • DISTRIBUTOR
    • HEALTHCARE
    • LOGISTICS
    • MANUFACTURER
    • WHOLESALER
    • PHARMACY
  • Mandatory if ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. Valid values:
    • IMPORTER
    • MANUFACTURER
    • WHOLESALER

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. Business name of a customer or trade partner. *31
              tl:street1 [1…1]
[1/*]		 String Required. First line of the business street address (associated with businessName field). *32
              tl:street2 [0…1]
[0/*]		 String Second line of the business street address (associated with businessName field). *33
              tl:city [1…1]
[1/*]		 String Required. Business city address (associated with businessName field). *34
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India. *35
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. Business party's state or regional address (associated with businessName field). The state, province, or region uses the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *36
              tl:postalCode [0…1]
[1/*]		 String Business party's postal/zip code (associated with businessName field). *37
              tl:country [1…1]
[1/*]		 String Required. Business party's country code (associated with businessName field). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *38
            tl:licenseNumber [0…*]
[0/*]		 String 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 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. *39
              @agency [0…1]
[0/*]		 String The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number. *40
            tl:contactInfo [0…1]
[-]		 - Contact information to be used by downstream trading partners to verify the transaction's information.
              tl:name [1…1]
[0/*]		 String Required. The name of either an individual or department that represents the business entity. *41
              tl:title [0…1]
[0/*]		 String Title of the person indicated in the name field of the business entity. *42
              tl:telephone [0…1]
[1/*]		 String Telephone number of the business entity indicated in the businessName field. This must begin with the + character followed by the Country Calling Code. *43
              tl:email [0…1]
[0/*]		 String Email address of the business entity indicated in the businessName field. *44
              tl:url [0…1]
[0/*]		 String Website of the business entity indicated in the businessName field. *45
          tl:shipFromLocation [1…1]
[-]		 - Required. The full business information associated with the ship from business entity.
            tl:facilityId *46 [1…*]
[1/*]		 String Required. The identifier 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 based on country requirements. The tl:businessClassification field is an attribute of the shipFrom element. This field indicates the business type of the assigned entity.
Country requirements:
  • Mandatory for Argentina. Valid values:
    • DISTRIBUTOR
    • HEALTHCARE
    • LOGISTICS
    • MANUFACTURER
    • WHOLESALER
    • PHARMACY
  • Mandatory if ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. Valid values:
    • IMPORTER
    • MANUFACTURER
    • WHOLESALER
            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. Business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. First line of the business street address (associated with tl:businessName field).
              tl:street2 [0…1]
[0/*]		 String Second line of the business street address (associated with tl:businessName field).
              tl:city [1…1]
[1/*]		 String Required. Business city address (associated with tl:businessName field).
              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. Business party's state or regional address (associated with businessName field). 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 Business party's postal/zip code (associated with businessName field).
              tl:country [1…1]
[1/*]		 String Required. Business party's country code (associated with tl:businessName field). 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 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 The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - Contact information to be used by downstream trading partners to verify the message's information.
              tl:name [1…1]
[0/*]		 String Required. Indicates the name of either an individual or department that represents the business entity.
              tl:title [0…1]
[0/*]		 String Title of the person indicated in the name field of the business entity.
              tl:telephone [0…1]
[1/*]		 String Telephone number of the business entity indicated in the tl:businessName field. This must begin with the + character followed by the Country Calling Code.
              tl:email [0…1]
[0/*]		 String Email address of the business entity indicated in the tl:businessName field.
              tl:url [0…1]
[0/*]		 String Website of the business entity indicated in the tl:businessName field.
          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 business entity who is receiving the serial number(s). 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 based on country requirements. The tl:businessClassification field is an attribute of the toBusiness element. It indicates the business type of the assigned entity.
Country requirements:
  • Mandatory for Argentina. Valid values:
    • DISTRIBUTOR
    • HEALTHCARE
    • LOGISTICS
    • MANUFACTURER
    • WHOLESALER
    • PHARMACY
  • Mandatory if ShipToCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. Valid values:
    • IMPORTER
    • MANUFACTURER
    • WHOLESALER

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. Business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. First line of the business street address (associated with tl:businessName field).
              tl:street2 [0…1]
[0/*]		 String Second line of the business street address (associated with tl:businessName field).
              tl:city [1…1]
[1/*]		 String Business city address (associated with tl:businessName field).
              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 Business party's state or regional address (associated with tl:businessName field). 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 Business party's postal/zip code (associated with tl:businessName field).
              tl:country [1…1]
[1/*]		 String Business party's country code (associated with tl:businessName field). 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 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 The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - 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 Title of the person indicated in the name field of the business entity.
              tl:telephone [0…1]
[1/*]		 String 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 Required. Email address of the business entity indicated in the tl:businessName field.
              tl:url [0…1]
[0/*]		 String Website of the business entity indicated in the tl:businessName field.
          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 shipTo business entity. This value is mandatory for regulatory reporting.
              @type [1…1]
[1/*]		 String Required. See the LocationIdType enumeration list for valid values:
            tl:businessClassification [0…1]
[0/*]		 String The tl:businessClassification field is an attribute of the shipTo element. It indicates the business type of the assigned entity.

Valid values for Argentina:

  • DISTRIBUTOR
  • HEALTHCARE
  • LOGISTICS
  • MANUFACTURER
  • WHOLESALER
  • PHARMACY

Valid values for S. Korea:

  • IMPORTER
  • MANUFACTURER
  • WHOLESALE
            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. Business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. First line of the business street address (associated with tl:businessName field).
              tl:street2 [0…1]
[0/*]		 String Second line of the business street address (associated with tl:businessName field).
              tl:city [1…1]
[1/*]		 String Business city address (associated with tl:businessName field).
              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 Business party's state or regional address (associated with tl:businessName field). 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 Business party's postal/zip code (associated with tl:businessName field).
              tl:country [1…1]
[1/*]		 String Business party's country code (associated with tl:businessName field). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.
            tl:licenseNumber [0…*]
[0/*]		 String 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 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 The agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.
            tl:contactInfo [0…1]
[-]		 - 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 Title of the person indicated in the name field of the business entity.
              tl:telephone [0…1]
[1/*]		 String Telephone number of the business entity indicated in the tl:businessName field. This must begin with the + character followed by the Country Calling Code.
              tl:email [0…1]
[0/*]		 String Email address of the business entity indicated in the tl:businessName field.
              tl:url [0…1]
[0/*]		 String Website of the business entity indicated in the tl:businessName field.
          tl:carrierParty [0…1]
[-]		 - Conditionally required for China. The full business information associated with the carrier responsible for delivering the shipment.
            tl:businessId [1…*]
[1/*]		 String Required. The identifier associated with the business entity who is transporting the serial number(s). 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 thecarrier party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the carrier party is provided.
              @type [1…1]
[1/*]		 String Required. See the BusinessAndLocationId enumeration list for valid values:
            tl:businessClassification [0…1]
[0/*]		 String 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. Business name of a customer or trade partner.
              tl:street1 [1…1]
[1/*]		 String Required. First line of the business street address (associated with tl:businessName field).
              tl:street2 [0…1]
[0/*]		 String Second line of the business street address (associated with tl:businessName field).
              tl:city [1…1]
[1/*]		 String Business city address (associated with tl:businessName field).
              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 Business party's state or regional address (associated with tl:businessName field). 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 Business party's postal/zip code (associated with tl:businessName field).
              tl:country [1…1]
[1/*]		 String Business party's country code (associated with tl:businessName field). The country uses the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.