Sales Shipment Guidelines (EPCIS v1.0)

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

Message Type: SOM_SALES_SHIPMENT

Info Exchange Display Name: Sales 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.
NTINs must follow the GS1 Guidance standards as found on the GS1 website.
  • Ex: urn:epc:id:sgtin:415001647778.0.100000000022
  • Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
Information regarding NTINs cannot be exchanged with trade partners unless the specific format outlined above is followed. If using an NTIN without following this format, an outbound error occurs when passing data from TraceLink to a trade partner.
Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1...1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1...1]
[0/*]		 Decimal Required. This field indicates the version of the EPCIS schema used to populate the EPCIS document elements. *1
Mandatory according to the EPCIS standard.
  @creationDate [1...1]
[1/*]		 Date Required. This field indicates the date that the message was created in XML datetime format YYYY-MM-DDTHH:MM:SSZ. *2
Mandatory according to the EPCIS standard.
  EPCISHeader [0...1]
[-]		 - Required. XML file control header record.
    sbdh:StandardBusinessDocumentHeader [1...1]
[-]		 - Required. This element contains 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 number of the SBDH standard used. The HeaderVersion is set to 1.0. *3
      sbdh:Sender [1...*]
[-]		 - Required. This value reflects 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. This field indicates 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. 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...*]
[-]		 - Not used.
      sbdh:Receiver [1...*]
[-]		 - Required. This field indicates a unique identification key for the direct Receiver party of the message, representing the organization which receives the standard business document. The Receiver element is used only once with GS1 XML messages.
        sbdh:Identifier [1...1]
[1/*]		 String Required. This field indicates the GLN identifier for the receiver. The value of the Identifier element is a GLN per GS1 standards. *6
          @Authority [1...1]
[1/*]		 String Required. This attribute defines the receiver identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages. *7
        sbdh:ContactInformation [0...*]
[-]		 - Not used.
      sbdh:DocumentIdentification [1...1]
[-]		 - Required. This element contains the identification group for the message.
        sbdh:Standard [1...1]
[0/*]		 String Required. Name of the document standard contained in the file/message. The standard value for this field is EPCglobal. *8
        sbdh:TypeVersion [1...1]
[0/*]		 String Required. The version of the document included in the payload of SBDH. This is the 'complete' version of the document itself and is different than the HeaderVersion. The TypeVersion is set to 1.0. *9
        sbdh:InstanceIdentifier [1...1]
[1/*]		 String Required. Description which contains reference information which uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier identifies this document as being distinct from others. *10
        sbdh:Type [1...1]
[0/*]		 String Required. This element identifies the document type. The Type value is set to Events for a shipment event. *11
        sbdh:CreationDateAndTime [1...1]
[0/*]		 DateTime Required. This field indicates 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. *12
  EPCISBody [1...1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1...1]
[-]		 - Required. This element contains all events within the message including event details. Must choose one of the following two options:
  • Option 1: AggregationEvent (optional one or more for full packing aggregation hierarchy).
  • Option 2: ObjectEvent (only one for shipping).
      AggregationEvent [0...*]
[-]		 - Option 1 for EventList choice. 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. Time stamp of date/time when the event occurred in XML datetime format YYYY-MM-DDTHH:MM:SSZ. 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. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. *13
        recordTime [0...1]
[0/*]		 DateTime Not used.
        eventTimeZoneOffset [1...1]
[1/*]		 String Required. 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. *14
        parentID [1...1]
[0/*]		 AnyURI Required. This value is 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). This value is the serial number expressed in the GS1 Application Identifier format without parenthesis for the AI keys. See EPC Pure Identifier Format Examples. *15
        childEPCs [0...1]
[-]		 - 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 [0...*]
[1/*]		 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. *16
        action [1...1]
[1/*]		 String Required. This field indicates 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). This field must be set to ADD for an aggregation event. *17
        bizStep [0...1]
[0/*]		 AnyURI This value indicates the business step taken in the event. The bizStep value must equal urn:epcglobal:cbv:bizstep:packing for an aggregation event. *18
        disposition [0...1]
[0/*]		 AnyURI The disposition indicates the status of the message and is grouped with the bizStep and action fields to define the message event. For an aggregation event, this must equal urn:epcglobal:cbv:disp:in_progress. *19
        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, 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. *20
        bizLocation [0...1]
[-]		 - This value 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.
          id [1...1]
[1/*]		 AnyURI Required. The SGLN EPC of the location from where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. *21
        bizTransactionList [0...1]
[-]		 - Not used.
        tl:aggregationEventExtensions [0...1]
[-]		 - Extensions used for Aggregation Event.
          tl:packedStatus [0...1]
[0/*]		 String Conditionally required for China. Indicates the packaging status of the container (full, partial).

See the PackedStatus enumeration list for valid values.
          tl:quantity [0...1]
[0/*]		 Integer The quantity of items at the aggregation level.
          tl:filterValue [0...1]
[0/*]		 String The filter value used in GTN-14 and SSCC serial numbers.
          tl:packagingLevel [0...1]
[0/*]		 String The packaging level of the commissioned item using the supported enumeration values. *22

See the PackagingLevel enumeration list for valid values.
      ObjectEvent [0...*]
[-]		 - The ObjectEvent indicates the message type. This field is mandatory for Serialized Operations Manager Receive events. See for field configuration information.
        eventTime [1...1]
[1/*]		 DateTime Required. 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]. *23
        recordTime [0...1]
[0/*]		 DateTime Not used.
        eventTimeZoneOffset [1...1]
[1/*]		 String Required. 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. *24
        epcList [0...1]
[-]		 - List of the EPCs of top most containers (e.g. pallets, cases) in the shipment.
          epc [0...*]
[1/*]		 AnyURI Conditionally required if IsSerialized is set to true (one epc for each serialized OrderItem). 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. *25
        action [1...1]
[0/*]		 String Required. The action type of the event. Field mandatory for Serialized Operations Manager Receive event. The action value must equal OBSERVE. *26
        bizStep [1...1]
[1/*]		 AnyURI Required. This value indicates the business step taken in the event. The bizStep must equal urn:epcglobal:cbv:bizstep:receiving. *27
        disposition [1...1]
[1/*]		 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. *28
        readPoint [0...1]
[-]		 - This field identifies 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. *29
        bizLocation [0...1]
[-]		 - Not used.
          id [1...1]
[1/*]		 AnyURI Required. Not used.
        bizTransactionList [0...1]
[-]		 -

Conditionally required if bizStep = urn:epcglobal:cbv:bizstep:shipping.
          bizTransaction [1...1]
[0/*]		 AnyURI Required. The business transaction identifiers for the Dispatch Advice (Advance Ship Notice), Invoice, and/or Purchase Order governing this shipment, subject to Section 8.4.2 of [CBV1.0]. *30

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

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.
            @type [1...1]
[1/*]		 String Conditionally required if cmn:TransactionIdentifier is populated. The transaction identifier type using the supported enumeration values. Valid values : *31
  • urn:epcglobal:cbv:btt:bol = Bill of Lading
  • http://epcis.gs1br.org/hc/btt/notafiscal = Brazil Nota Fiscal
  • urn:epcglobal:cbv:btt:destruction = Destruction
  • urn:epcglobal:cbv:btt:inv = Invoice Number
  • urn:epcglobal:cbv:btt:other = Other
  • urn:epcglobal:cbv:btt:packslip = Packslip
  • urn:epcglobal:cbv:btt:po = Purchase Order Number
  • urn:epcglobal:cbv:btt:rma = Return Order
  • urn:epcglobal:cbv:btt:salesorder = Sales Order
  • urn:epcglobal:cbv:btt:transfer = Transfer Order Number

See the TransactionID enumeration list for valid values.
        tl:shippingEventExtensions [0...*]
[-]		 - Conditionally required if Shipping Event is populated. Extensions used for Shipping Event.
          tl:transactionDate [1...1]
[10/10]		 Date Required. Date associated with the business transaction document in bizTransactionList in YYYY-MM-DD format. This date may or may not be the same as the eventTime. *32
          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 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. *33

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. *34

See the ISOCountryCode enumeration list for valid values.

This value is mandatory for Saudi Arabia Accept report.

          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 application. *35

INCOUNTRYTRANSFER and EXPORTTRANSFER include:

  • Intra-company warehouse transfer of goods
  • Transfers between Manufacturer (Brand Owner) and 3PL.
  • Transfers between Manufacturer (Brand Owner) and CMO/CPO.
  • Transfers between CMO/CPO and 3PL of Manufacturer (Brand Owner).

CMOs/CPOs transfer of goods with Pharmaceutical Manufacturer, with another CMO/CPO of Pharmaceutical Manufacturer, with 3PL of Pharmaceutical Manufacturer should not use INCOUNTRYSALE or EXPORTSALE. These are only when a Pharmaceutical Manufacturer of a product sells their product to another company.

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

Conditionally required in the following scenarios:

  • Brazil = Populate only if performing Collection, Donation, or SampleDistribution.
  • If ShipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or EXPORTRETURN all values except for Collection apply

Identifies the type of supply that is being performed using one of the permitted values. *36

See the SupplyType enumeration list for valid values.
          tl:contractType [0...1]
[0/*]		 String Conditionally required if ShipFromCountryCode = KR. Identifies the type of contract for the sale of goods using one of the permitted values. *37

See the ContractType enumeration list for valid values.
          tl:dropShipmentIndicator [0...1]
[0/*]
 Boolean Indicates if shipment is a drop shipment. *38
          tl:portalAccessCode [0...1]
[0/*]		 String The portal access code used to access drop shipments in the serialized drop ship portal.
          tl:comments [0...1]
[0/*]		 String Optional remarks or comments associated with delivery. *39
          tl:warehouseOperatorName [0...1]
[0/*]		 String Name of the person responsible for warehouse operations.
          tl:correctiveShipment [0...1]
[0/*]		 Boolean When set to 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 a shipment is voided and corrections are made to a delivery.
          tl:disaggregateFromParent [0...1]
[0/*]		 Boolean When set to true, the system disaggregates the picked serial number from the parent container, if it is aggregated. If not set, or set to false, TraceLink generates an error if attempting to pick serial number for an item or container that is aggregated to a parent.
          tl:orderItemList [0...1]
[-]		 - Order item list group is populated to communicate the pick quantities for each item code at the EACH (unit) level.
            tl:orderItem [1...*]
[-]		 - Required. Order item group is a repeating element that captures the item code, lot number, and quantity for each item in the order. Each unique item code and lot number are communicated in a separate order item group.
              choice%1 [1...1]
[0/*]		 Choice Conditionally required if ShipFromCountryCode = KR. Populate only one of cmn:InternalMaterialCode or cmn:PackagingItemCode. One of the two options must be present.
              tl:internalMaterialCode [0...1]
[0/*]		 String Conditionally required if cmn:PackagingItemCode is not populated. Option 1 for choice%1 in OrderItem. Use to identify the product using the internal material number configured in Product Master Data. *40
              tl:packagingItemCode [0...1]
[0/*]		 String Conditionally required if cmn:InternalMaterialCode is not populated. Option 2 for choice%1 in OrderItem. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *41
                @type [1...1]
[1/*]		 String Conditionally required if cmn:PackagingItemCode is populated. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14). *42

See the ItemCode enumeration list for valid values.
              tl:lot [0...1]
[0/*]		 String Conditionally required if ShipFromCountryCode = KR and IsSerialized = false. The lot or batch code for the items to be picked (if available) in an alphanumeric string. *43
              tl:expiry [0...1]
[0/*]		 Date Expiration date for product in XML date format YYYY-MM-DD. *44
              tl:quantity [1...1]
[1/*]		 Int Conditionally required if ShipFromCountryCode = KR and IsSerialized = false. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. *45
              tl:unitPrice [0...1]
[0/*]		 Decimal Conditionally required if ShipFromCountryCode = KR. Unit price of item. *46
                @currencyCode [1...1]
[3/3]		 String Conditionally required if UnitPrice is populated. Currency ISO code using ISO 4217-2015 format. *47

See the ISOCurrency enumeration list for valid values.
              tl:isSerialized [0...1]
[0/*]		 Boolean Indicates if item is not serialized. *48
          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 sold from or transfer from business entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below. *49
Country Requirements:
  • Argentina: Provide both the GLN and the CUIT number associated with the sold from party.
  • For company's physically located in Brazil: Provide the BR_CNPJ number associated with the sold from party.
  • China: Provide the company identifier registered with China SFDA used to identify the sold from party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • Turkey: Provide the GLN associated with the sold from party.
  • US: Provide a DEA, GLN, or HIN identifier associated with the sold from party.
The business identifier is sometimes used as the LookupId in TraceLink. If multiple @type identifiers are sent for the businessId without addresses, the first businessId @type sent will be stored as the LookupId while all additional identifiers sent will be ignored.
              @type [1...1]
[1/*]		 String Required. The type of the BusinessId identifier. *50

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

Conditionally required for Argentina. 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 sold from or transfer from business entity.
              tl:businessName [1...1]
[1/*]		 String Required.The business name of the trading partner. *51
              tl:street1 [1...1]
[1/*]		 String Required. The first line of the street address. *52
              tl:street2 [0...1]
[0/*]		 String The second line of the street address. *53
              tl:city [1...1]
[1/*]		 String Required. The city. *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 state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *56
              tl:postalCode [0...1]
[1/*]		 String Conditionally required based on country postal code requirements. The ZIP or other postal code. *57
              tl:country [1...1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *58
            tl:licenseNumber [0...*]
[0/*]		 String Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *59
              @state [0...1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *60
              @agency [0...1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. *61
            tl:contactInfo [0...1]
[0/*]		 String Contact information for use by downstream trading partners to verify the message information.
              tl:name [1...1]
[0/*]		 String Required. The name of the contact department or individual at the company. *62
              tl:title [0...1]
[0/*]		 String The title of the individual if a person was provided in Name.
              tl:telephone [0...1]
[1/*]		 String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *63
              tl:email [0...1]
[0/*]		 String The email address of the contact department or individual at the company. Should be included if available. *64
              tl:url [0...1]
[0/*]		 String The Web address to facilitate authentication. *65
          tl:shipFromLocation [0...1]
[-]		 - The full business information associated with the ship from business entity.
            tl:facilityId [1...*]
[1/*]		 String Required. Populated with the ship from location identifier. *66
              @type [1...1]
[1/*]		 String

Required. The type of the BusinessId identifier. *67

See the BusinessAndLocationId enumeration list for valid values.

            tl:businessClassification [0...1]
[0/*]		 String Business classification of the ship from party.
            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 the trading partner. *68
              tl:street1 [1...1]
[1/*]		 String Required. The first line of the street address. *69
              tl:street2 [0...1]
[0/*]		 String The second line of the street address.
              tl:city [1...1]
[1/*]		 String Required. The city. *70
              tl:district [0...1]
[0/*]		 String Conditionally required for India. District Code only for India. *71
Must be a 3-digit numeric code.
              tl:stateOrRegion [1...1]
[1/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *72
              tl:postalCode [0...1]
[1/*]		 String Conditionally required based on country postal code requirements. The ZIP or other postal code. *73
              tl:country [1...1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *74
            tl:licenseNumber [0...*]
[0/*]		 String Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *75
              @state [0...1]
[0/*]		 String The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *76
              @agency [0...1]
[0/*]		 String The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. *77
            tl:contactInfo [0...1]
[-]		 - Contact information for use by downstream trading partners to verify the message information.
              tl:name [1...1]
[0/*]		 String Required. The name of the contact department or individual at the company. *78
              tl:title [0...1]
[0/*]		 String The title of the individual if a person was provided in Name.
              tl:telephone [0...1]
[1/*]		 String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *79
              tl:email [0...1]
[0/*]		 String The email address of the contact department or individual at the company. Should be included if available. *80
              tl:url [0...1]
[0/*]		 String The Web address to facilitate authentication. *81
          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 sold to or transfer to business entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below. *82
Country requirement:
  • Argentina: Provide both the GLN and the CUIT number associated with the sold to party.
  • For company's physically located in Brazil: Provide the BR_CNPJ number associated with the sold to party.
  • China: Provide the company identifier registered with China SFDA used to identify the sold to party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • Turkey: Provide the GLN associated with the sold to party.
  • US: Provide a DEA, GLN, or HIN identifier associated with the sold to party.
The business identifier is sometimes used as the LookupId in TraceLink. If multiple @type identifiers are sent for the businessId without addresses, the first businessId @type sent will be stored as the LookupId while all additional identifiers sent will be ignored.
              @type [1...1]
[1/*]		 String

Required. The type of the BusinessId identifier. *83

See the BusinessAndLocationId enumeration list for valid values.

            tl:businessClassification [0...1]
[0/*]		 String

Conditionally required for Argentina. 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 sold to or transfer to business entity.
              tl:businessName [1...1]
[1/*]		 String Required. The business name of the trading partner. *84
              tl:street1 [1...1]
[1/*]		 String Required. The first line of the street address. *85
              tl:street2 [0...1]
[0/*]		 String The second line of the street address.
              tl:city [1...1]
[1/*]		 String Required. The city. *86
              tl:district [0...1]
[0/*]		 String Conditionally required for India. District Code only for India. *87
Must be a 3-digit numeric code.
              tl:stateOrRegion [1...1]
[1/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *88
              tl:postalCode [0...1]
[1/*]		 String Conditionally required based on country postal code requirements. The ZIP or other postal code. *89
              tl:country [1...1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *90
            tl:licenseNumber [0...*]
[0/*]		 String Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *91
              @state [0...1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *92
              @agency [0...1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. *93
            tl:contactInfo [0...1]
[0/*]		 String Contact information for use by downstream trading partners to verify the message information.
              tl:name [1...1]
[0/*]		 String Required. The name of the contact department or individual at the company. *94
              tl:title [0...1]
[0/*]		 String The title of the individual if a person was provided in Name.
              tl:telephone [0...1]
[1/*]		 String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *95
              tl:email [0...1]
[0/*]		 string The email address of the contact department or individual at the company. Should be included if available. *96
              tl:url [0...1]
[0/*]		 String The Web address to facilitate authentication.
          tl:shipToLocation [0...1]
[-]		 - The full business information associated with the ship to business entity.
            tl:facilityId [1...*]
[1/*]		 String Required. Populated with the ship to location identifier. *97
              @type [1...1]
[1/*]		 String Required. The type of the BusinessId identifier. *98

See the BusinessAndLocationId enumeration list for valid values.

            tl:address [0...1]
[-]		 - Conditionally required for US. Populated with the business name and address of the ship to business entity.
              tl:businessName [1...1]
[1/*]		 String Required. The business name of the trading partner. *99
              tl:street1 [1...1]
[1/*]		 String Required. The first line of the street address. *100
              tl:street2 [0...1]
[0/*]		 String The second line of the street address.
              tl:city [1...1]
[1/*]		 String Required. The city. *101
              tl:district [0...1]
[0/*]		 String Conditionally required for India. District Code only for India. *102
Must be a 3-digit numeric code.
              tl:stateOrRegion [1...1]
[1/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *103
              tl:postalCode [0...1]
[1/*]		 String Conditionally required based on country postal code requirements. The ZIP or other postal code. *104
              tl:country [1...1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *105
            tl:licenseNumber [0...*]
[0/*]		 String Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *106
              @state [0...1]
[0/*]		 String The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *107
              @agency [0...1]
[0/*]		 String The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. *108
            tl:contactInfo [0...1]
[-]		 - Contact information for use by downstream trading partners to verify the message information.
              tl:name [1...1]
[0/*]		 String Required. The name of the contact department or individual at the company. *109
              tl:title [0...1]
[0/*]		 String The title of the individual if a person was provided in tl:name.
              tl:telephone [0...1]
[1/*]		 String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *110
              tl:email [0...1]
[0/*]		 String The email address of the contact department or individual at the company. Should be included if available. *111
              tl:url [0...1]
[0/*]		 String The Web address to facilitate authentication.
          tl:carrierParty [0...1]
[-]		 - The full business information associated with the carrier responsible for delivering the shipment.
            tl:businessId [1...*]
[1/*]		 String Required. Populated with the business identifier. *112
The business identifier is sometimes used as the LookupId in TraceLink. If multiple @type identifiers are sent for the businessId without addresses, the first businessId @type sent will be stored as the LookupId while all additional identifiers sent will be ignored.
              @type [1...1]
[1/*]		 String

The type of the BusinessId identifier. *113

See the BusinessAndLocationId enumeration list for valid values.

            tl:businessClassification [0...1]
[0/*]		 String Not used.
            tl:address [0...1]
[-]		 - Conditionally required for US. Populated with the business name and address of the carrier.
              tl:businessName [1...1]
[1/*]		 String Required. The business name of the trading partner. *114
              tl:street1 [1...1]
[1/*]		 String Required. The first line of the street address. *115
              tl:street2 [0...1]
[0/*]		 String The second line of the street address.
              tl:city [1...1]
[1/*]		 String Required. The city. *116
              tl:district [0...1]
[0/*]		 String Conditionally required for India. District Code only for India. *117
Must be a 3-digit numeric code.
              tl:stateOrRegion [1...1]
[1/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *118
              tl:postalCode [0...1]
[1/*]		 String Conditionally required based on country postal code requirements. The ZIP or other postal code. *119
              tl:country [1...1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *120
            tl:licenseNumber [0...*]
[0/*]		 String Populated with the license number of the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *121
              @state [0...1]
[0/*]		 String Required. The state or region in which the trading partner is licensed, using the standard two letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute is used to give additional context to the license number. *122
              @agency [0...1]
[0/*]		 String Required. The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. *123
            tl:contactInfo [0...1]
[0/*]		 String Contact information for use by downstream trading partners to verify the message information.
              tl:name [1...1]
[0/*]		 String Required. The name of the contact department or individual at the company. *124
              tl:title [0...1]
[0/*]		 String The title of the individual if a person was provided in Name.
              tl:telephone [0...1]
[1/*]		 String The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *125
              tl:email [0...1]
[0/*]		 String The email address of the contact department or individual at the company. Should be included if available. *126
              tl:url [0...1]
[0/*]		 String The Web address to facilitate authentication.