Receipt Event Guidelines (EPCIS v1.0)
See How To Use this Guide before interpreting the guidelines below.
Message Type:
- SOM_RECEIPT_EVENT
Info Exchange Display Name: Receipt Event
- Ex: urn:epc:id:sgtin:415001647778.0.100000000022
- Format: urn:epc:id:sgtin:[company prefix].[indicator digit][item ref].[serial number]
| Data Element | Occurs Length |
Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| epcis:EPCISDocument | 1…1 - |
- | Required. The EPCIS message root element. | ||||||||
| @schemaVersion | 0…1 0/* |
Decimal | Required. The version of the EPCIS schema used to populate the EPCIS document elements.1 | ||||||||
| @creationDate | 0…1 1/* |
DateTime | Required. The date that the message was created in XML DateTime format YYYY-MM-DDTHH:MM:SSZ.2 | ||||||||
| EPCISHeader | 1…1 - |
- | Required. XML file control header. | ||||||||
| sbdh:StandardBusinessDocumentHeader | 1…1 - |
- | Required. The 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:ContactInformation | 0…* - |
- | This field is not used. | ||||||||
| sbdh:Receiver | 1...* - |
- | Required. A unique identification key for the direct Receiver party of the message, representing the organization which receives the standard business document. The sbdh:Receiver element is used only once with GS1 XML messages. | ||||||||
| sbdh:Identifier | 1…1 1/* |
String | Required. The GLN identifier for the receiver. The value of the sbdh:Identifier element is a GLN per GS1 standards. | ||||||||
| @Authority | 1…1 1/* |
String | Required. The receiver identifier type as a GLN. The Authority value is set to GLN for GS1 XML messages. | ||||||||
| sbdh:ContactInformation | 0…* - |
- | This field is not used. | ||||||||
| sbdh:DocumentIdentification | 1…1 - |
- | Required. The identification group for the message. | ||||||||
| sbdh:Standard | 1…1 0/* |
String | Required. Name of the document standard contained in the file/message. The standard value for this field is EPCglobal.6 |
||||||||
| sbdh:TypeVersion | 1…1 0/* |
String | Required. The version of the document included. This is the complete version of the document itself and is different from the sbdh:HeaderVersion as these are hard-coded values. The sbdh:TypeVersion is set to 1.0.7 |
||||||||
| sbdh:InstanceIdentifier | 1…1 1/* |
String | Required. The reference information, which uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This is a hard-coded value. This identifier confirms this document as being distinct from others.8 | ||||||||
| sbdh:Type | 1…1 0/* |
String | Required. The document type. The sbdh:Type value is set to Events for a shipment event.9 |
||||||||
| sbdh:CreationDateAndTime | 1…1 0/* |
DateTime | Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however if it is not included, the system assumes that the time is GMT and therefore appends the Z.10 |
||||||||
| EPCISBody | 1…1 - |
- | Required. The main body of the message. | ||||||||
| EventList | 1…1 - |
- | Required. All events within the message including event details. | ||||||||
| AggregationEvent | 0…1 - |
- | The AggregationEvent is used in the EventList and indicates an aggregation event. See Transaction Identifiers for field configuration information. Missing mandatory elements will throw an error only if AggregationEvent is present. | ||||||||
| 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].11 |
||||||||
| 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.12 | ||||||||
| parentID | 1…1 1/* |
String | Required. An Identifier of the parent container in EPC Pure Identity URI format (e.g. for an item-to-case aggregation, the EPC is of the case; for a case-to-pallet aggregation, the EPC is of the pallet). 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.13 | ||||||||
| childEPCs | 1…1 - |
- | Required. 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 1/* |
String | 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.14 | ||||||||
| 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.15 |
||||||||
| bizStep | 1…1 1/* |
String | Required. This value indicates the business step taken in the event. The bizStep value must equal urn:epcglobal:cbv:bizstep:packing for an aggregation Event.16 |
||||||||
| disposition | 1…1 1/* |
String | Required. 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.17 |
||||||||
| 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 1/* |
String | 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.18 | ||||||||
| 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/* |
String | 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.19 | ||||||||
| bizTransactionList | 0…1 - |
- | This field is not used. | ||||||||
| tl:aggregationEventExtensions | 0…1 - |
- | Extensions used for Aggregation Event. | ||||||||
| tl:packedStatus | 0…1 0/* |
String |
Required. The packed status of the item or container using the supported enumeration values. See the PackedStatus enumeration list for valid values. |
||||||||
| tl:quantity | 0…1 0/* |
Integer | The quantity of child serial numbers aggregated to the parent container in this aggregation event.20 | ||||||||
| ObjectEvent | 1...* - |
- | Required. The ObjectEvent indicates the transaction type. This field is mandatory for Serialized Operations Manager Receive events. See Transaction Identifiers 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]. | ||||||||
| recordTime | 0…1 0/* |
DateTime | Required. This field is 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. | ||||||||
| epcList | 0…1 - |
- | List of the EPCs of topmost containers (e.g. pallets, cases) in the shipment. | ||||||||
| epc | 0…* 1/* |
AnyURI | Conditionally required if cmn: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. |
||||||||
| action | 1…1 0/* |
String | Required. The action type of the event. Mandatory for Serialized Operations Manager Receive event.
The
action value is set to OBSERVE.21 |
||||||||
| bizStep | 0…1 0/* |
AnyURI | Required. This value indicates the business step taken in the event. The bizStep must equal urn:epcglobal:cbv:bizstep:receiving for a receive event.22 |
||||||||
| 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_progress for a receive event.23 |
||||||||
| readPoint | 1…1 1/* |
AnyURI | Required. 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 1/* |
AnyURI | Required. This field indicates the SGLN EPC of the location from where the event occurred. This may be a site-level SGLN or a finer-grain location identifier. | ||||||||
| bizLocation | 0…1 - |
- | This field is not used. | ||||||||
| id | 1…1 1/* |
AnyURI | Required. This field is not used. | ||||||||
| bizTransactionList | 0…1 - |
- | Required. This element contains a list of the business transaction identifiers. For a receive event, this element is mandatory when bizStep equals urn:epcglobal:cbv:bizstep:receiving. |
||||||||
| bizTransaction | 1...* 0/* |
AnyURI | Required.
This field is the business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or Invoice and/or Purchase Order (PO) governing this shipment, which are subject to Section 8.4.2 of (CBV1.0).24
The GLN that occurs after Different states have different requirements for the transaction number. For optimal pedigree compliance purposes, the PO 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 | Required. This field indicates the business transaction type. Valid values:
|
||||||||
| tl:receivingEventExtensions | 1…1 - |
- | Required. The extensions used for Receiving Event. | ||||||||
| tl:transactionDate | 1…1 10/10 |
Date | Required. The date associated with the business transaction document in the bizTransactionList, in XML date format YYYY-MM-DD.25 | ||||||||
| tl:shipToCountryCode | 0…1 2/2 |
String |
Advises regulatory reporting (will be a two- or three-letter ISO country code for ship to country) if it is required for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.26 See the ISOCountryCode enumeration list for valid values. |
||||||||
| tl:shipFromCountryCode | 0…1 0/* |
String |
ISO country code for ship from country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events. See the ISOCountryCode enumeration list for valid values. |
||||||||
| tl:receiptDistributionType | 1…1 1/* |
String |
Required. Informs what types of regulatory reporting may be triggered based on the nature of the receipt distribution: a purchase, return, or transfer within the same country; or a purchase, return, or transfer from one country to another. See the ReceiptDistributionType enumeration list for valid values. |
||||||||
| tl:supplyType | 0…1 0/* |
String | Conditionally required when tl:shipToCountryCode = KR and tl:receiptDistributionType = INCOUNTRYRETURN. Identifies the type of supply that is being performed using one of the permitted values. All values except for Collection apply.
See the SupplyType enumeration list for valid values. |
||||||||
| tl:contractType | 0…1 0/* |
String | Conditionally required when tl:shipToCountryCode = KR and tl: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 remarks or comments associated with delivery. | ||||||||
| cmn:orderItemList | 0…1 - |
- | Conditionally required when tl:shipToCountryCode = KR and tl:receiptDistributionType = INCOUNTRYRETURN. The order item 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 correct each quantity. |
||||||||
|
|
cmn:orderItem | 1...* - |
- | Required. The order item group is 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. | |||||||
| cmn:internalMaterialCode | 0…1 1/* |
String | Conditionally required if cmn:PackagingItemCode is not populated. Option 1 for choice%1 in OrderItem. Used to identify the product using the internal material number configured in Product Master Data.27 | ||||||||
| cmn:packagingItemCode | 0…1 1/* |
String | Conditionally required if cmn:InternalMaterialCode is not populated. Option 2 for choice%1 in OrderItem. Used to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data.28 | ||||||||
| @type | 0…1 0/* |
String | Conditionally required if cmn:PackagingItemCode is populated. The product code type for the packaging item code using the supported enumeration values. Valid values:
|
||||||||
| tl:lotNumber | 0…1 0/* |
String | Conditionally required if ShipFromCountryCode = KR and cmn:isSerialized = false. The lot or batch code for the items picked (if available) in an alphanumeric string.29 |
||||||||
| cmn:quantity | 1…1 1/* |
Integer | Conditionally required to have a value greater than zero if cmn:isSerialized = false. The quantize of items at the each(unit) level of the item code and lot if specified to be picked.30 |
||||||||
| cmn:unitPrice | 0…1 - |
Decimal | Conditionally required when tl:shipToCountryCode = KR and tl:receiptDistributionType = INCOUNTRYRETURN. Unit price of item.31 |
||||||||
| @currencyCode | 1…1 0/3 |
String | Conditionally required if cmn:unitPrice is populated. Currency ISO code using ISO 4217-2015 format. See the ISOCurrency enumeration list for valid values. |
||||||||
| cmn:isSerialized | 0…1 - |
Boolean | Indicates if item is not serialized.32 | ||||||||
| tl:warehouseOperatorName | 0…1 0/* |
String | Conditionally required for China. Name of the person responsible for warehouse operations in the transfer from business entity.33 | ||||||||
| tl:fromBusiness | 1…1 - |
- | Required. The full business information associated with the sold from or transfer from business entity. | ||||||||
| tl:businessId | 1...* 1/* |
String | Conditionally required if tl:businessId is populated. The identifier associated with the fromBusiness entity. Different countries require different values as noted below:34 | ||||||||
| @type | 1…1 1/* |
String |
Conditionally required if tl:businessId is populated. See the BusinessAndLocationId enumeration list for valid values. |
||||||||
| tl:businessClassification | 0…1 0/* |
String | Conditionally required for Argentina, or if tl:shipToCountryCode = KR and tl:receiptDistributionType = INCOUNTRYRETURN. The businessClassification field is an attribute of the tl:fromBusiness. This field indicates the business type of the assigned entity. The business classification of the sold from party is provided by using one of the enumerations. Several appropriate enumeration values for this message include:
See the BusinessClassification enumeration list for valid values. |
||||||||
| tl:address | 0…1 - |
- | Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner. | ||||||||
| tl:businessName | 1…1 1/* |
String | Required. The business name of a customer or trade partner.35 | ||||||||
| tl:street1 | 1…1 1/* |
String | Required. The first line of the business street address (associated with tl:businessName).36 | ||||||||
| tl:street2 | 0…1 0/* |
String | The second line of the business street address (associated with tl:businessName).37 | ||||||||
| tl:city | 1…1 1/* |
String | Required. The business city address (associated with tl:businessName).38 | ||||||||
| tl:district | 0…1 0/* |
String | Conditionally required for India. District Code only for India.39 |
||||||||
| 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.40 | ||||||||
| tl:postalCode | 0…1 1/* |
String | The business party's postal/zip code (associated with tl:businessName).41 | ||||||||
| 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.42 | ||||||||
| tl:shipFromLocation | 1…1 - |
- | Required. The full business information associated with the ship from business entity. | ||||||||
| tl:facilityId | 1...* 1/* |
String | Required. The identifier (see BusinessAndLocationId for enumerators) associated with the shipFrom business entity.43 | ||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:facilityId is populated. See the BusinessAndLocationId enumeration list for valid values. | ||||||||
| tl:businessClassification | 0…1 0/* |
String | Conditionally required for Argentina. The businessClassification field is an attribute of the a element. This field indicates the business type of the assigned entity.
See the BusinessClassification enumeration list for valid values. |
||||||||
| tl:address | 0…1 - |
- | Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner. | ||||||||
| tl:businessName | 1…1 1/* |
String | Required. The business name of a customer or trade partner. | ||||||||
| tl:street1 | 1…1 1/* |
String | Required. The first line of the business street address (associated with tl:businessName). | ||||||||
| tl:street2 | 0…1 0/* |
String | The second line of the business street address (associated with tl:businessName). | ||||||||
| tl:city | 1…1 1/* |
String | Required. The business city address (associated with tl:businessName). | ||||||||
| tl:district | 0…1 0/* |
String | Conditionally required for India. District Code only for India.
|
||||||||
| 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 | This element contains the facility's license number. This element may be repeated to include as many license numbers as required (e.g. state and federal license). | ||||||||
| @state | 0…1 0/* |
String | This field indicates the state or region in which the business entity is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. This attribute provides additional context to the license number.44 | ||||||||
| @agency | 0…1 0/* |
String | This field indicates the agency that granted the license (e.g. Florida DOH, NABP). This attribute provides additional context to the license number.45 | ||||||||
| 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 | Conditionally required if tl:contactInfo is populated. Indicates the name of either an individual or department that represents the business entity.46 | ||||||||
| tl:title | 0…1 0/* |
String | Indicates the title of the person indicated in the name field of the business entity.47 | ||||||||
| tl:telephone | 0…1 1/* |
String | Indicates the telephone number of the business entity indicated in tl:businessName. This must begin with the + character followed by the Country Calling Code.48 |
||||||||
| tl:email | 0…1 0/* |
String | Indicates the email address of the business entity indicated in tl:businessName.49 | ||||||||
| tl:url | 0…1 0/* |
String | Indicates the website of the business entity indicated in tl:businessName.50 | ||||||||
| tl:toBusiness | 1…1 - |
- | Required. The full business information associated with the sold to or transfer to business entity. | ||||||||
| tl:businessId | 1...* 1/* |
String | Conditionally required if tl:businessId is populated. The identifier associated with the toBusiness entity. Different countries require different values as noted below: | ||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:businessId is populated. See the BusinessAndLocationId enumeration list for valid values. | ||||||||
| tl:businessClassification | 0…1 0/* |
String |
Conditionally required for Argentina or if tl:shipToCountryCode = For Argentina, the business classification of the sold to party is provided by using one of the enumerations. Valid values:
See the BusinessClassification enumeration list for valid values. |
||||||||
| tl:address | 0…1 - |
- | Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner. | ||||||||
| tl:businessName | 1…1 1/* |
String | Required. The business name of a customer or trade partner. | ||||||||
| tl:street1 | 1…1 1/* |
String | Required. The first line of the business street address (associated with tl:businessName). | ||||||||
| tl:street2 | 0…1 0/* |
String | The second line of the business street address (associated with tl:businessName). | ||||||||
| tl:city | 1…1 1/* |
String | Required. The business city address (associated with tl:businessName). | ||||||||
| tl:district | 0…1 0/* |
String | Conditionally required for India. District Code only for India.
|
||||||||
| 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: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 | ||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:facilityId is populated. See the BusinessAndLocationId enumeration list for valid values. | ||||||||
| tl:businessClassification | 0…1 0/* |
String |
The businessClassification field is an attribute of the shipTo element. This field indicates the business type of the assigned entity. Valid values:
|
||||||||
| tl:address | 0…1 - |
- | Conditionally required for US. This TraceLink required value is populated with the business name and address of a customer or trade partner. | ||||||||
| tl:businessName | 1…1 1/* |
String | Required. The business name of a customer or trade partner. | ||||||||
| tl:street1 | 1…1 1/* |
String | Required. The first line of the business street address (associated with tl:businessName). | ||||||||
| tl:street2 | 0…1 0/* |
String | The second line of the business street address (associated with tl:businessName). | ||||||||
| tl:city | 1…1 1/* |
String | Required. The business city address (associated with tl:businessName). | ||||||||
| tl:district | 0…1 0/* |
String | Conditionally required for India. District Code only for India.
|
||||||||
| 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 | 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 - |
- | The contact information to be used by downstream trading partners to verify the message's information. | ||||||||
| tl:name | 1…1 0/* |
String | Conditionally required if tl:contactInfo is populated. Indicates 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 | 1…1 1/* |
String | Required. 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 - |
- | Conditionally required for China. The full business information associated with the carrier responsible for delivering the shipment. | ||||||||
| tl:businessId | 1…* 1/* |
String | Conditionally required if tl:businessId is populated. The identifier associated with the carrierParty entity. Different countries require different values as noted below: | ||||||||
| @type | 1…1 1/* |
String | Conditionally required if tl:businessId is populated. See the BusinessAndLocationId enumeration list for valid values. | ||||||||
| tl:businessClassification | 0…1 0/* |
String | This field is not used. | ||||||||
| tl:address | 0…1 - |
- | Conditionally required for US. This TraceLink mandatory value is populated with the business name and address of a customer or trade partner. | ||||||||
| tl:businessName | 1…1 1/* |
String | Required. The business name of a customer or trade partner. | ||||||||
| tl:street1 | 1…1 1/* |
String | Required. The first line of the business street address (associated with tl:businessName). | ||||||||
| tl:street2 | 0…1 0/* |
String | The second line of the business street address (associated with tl:businessName). | ||||||||
| tl:city | 1…1 1/* |
String | Required. The business city address (associated with tl:businessName). | ||||||||
| tl:district | 0…1 0/* |
String | Conditionally required for India. District Code only for India.
|
||||||||
| 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. | ||||||||