Receipt Guidelines (EPCIS v1.0)
See How To Use this Guide before interpreting the guidelines below.
Message Type: SOM_RECEIPT
Info Exchange Display Name: Shipment Receipt


- 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. EPCIS message root element. | ||||||||
@schemaVersion | 0/* |
1…1Decimal | Required. The version of the EPCIS schema used to populate the EPCIS document elements.1 | ||||||||
@creationDate | 1/* |
1…1DateTime | Required. The date the message was created.2 | ||||||||
EPCISHeader | - |
0…1- | 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 | 0/* |
1…1String | Required. This field indicates the version of the Standard Business Document Header (SBDH). 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…1String | 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…1String | 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…1String | 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…1String | 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 | 0/* |
1…1String | Required. This field indicates the name of the document standard contained in the file/message. The standard value for this field is EPCglobal .8 |
||||||||
sbdh:TypeVersion | 0/* |
1…1String | Required. This field reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0 .9 |
||||||||
sbdh:InstanceIdentifier | 1/* |
1…1String | Required. This field indicates 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.10 | ||||||||
sbdh:Type | 0/* |
1…1String | Required. This element identifies the document type. The Type value is set to "Events" for a shipment event.11 | ||||||||
sbdh:CreationDateAndTime | 0/* |
1…1DateTime | 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. This element contains all of the EPCIS events for this message. | ||||||||
EventList | - |
1…1- | Required. The EventList has the following structure: ObjectEvent (mandatory). | ||||||||
ObjectEvent | - |
1…*- | Required. EventList. EventList = ObjectEvent
for Receiving Events when both of the following is true:
|
||||||||
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/* |
0…1DateTime | Not used. | ||||||||
eventTimeZoneOffset | 1/* |
1…1String | 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 | ||||||||
epcList | - |
0…1- | List of the EPCs of top-most containers (e.g. pallets, cases) in the shipment. | ||||||||
epc | 0/* |
0…*AnyURI | This value is the identifier of the child items in the parent container in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples.15 | ||||||||
action | 0/* |
1…1String | Required. The action value must equal OBSERVE .16 |
||||||||
bizStep | 0/* |
0…1AnyURI | The bizStep value must equal urn:epcglobal:cbv:bizstep:receiving .17 |
||||||||
disposition | 0/* |
0…1AnyURI | The disposition value must equal urn:epcglobal:cbv:disp:in_progress .18 |
||||||||
readPoint | - |
0…1- | - | ||||||||
id | 0/* |
1…1AnyURI | 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 | ||||||||
bizLocation | - |
0…1- | Not used. | ||||||||
id | 1/* |
1…1AnyURI | Not used.20 | ||||||||
bizTransactionList | - |
0…1- |
Conditionally required if bizStep = |
||||||||
bizTransaction | 0/* |
1…*AnyURI | Required. The business transaction identifiers for the Dispatch Advice (Advance Ship Notice) and/or Invoice and/or Purchase Order governing this shipment, subject to Section 8.4.2 of [CBV1.0].21 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 the 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. A delivery number or ASN is required. ![]()
|
||||||||
@type | 1/* |
1…1String |
Required. The transaction identifier type using the supported enumeration values (e.g. PO, ASN, RETURN, etc).22 See the TransactionIdType enumeration list for valid values. |
||||||||
bizTransaction | - |
0…1- | The business transaction identifiers for the Dispatch Advice (Advance Ship Notice) governing this shipment, subject to Section 8.4.2 of [CBV1.0]. Delivery document instance. Delivery document is required in receiving message. | ||||||||
tl:receivingEventExtensions | - |
0…*- | Extensions used for Receiving Event. | ||||||||
tl:transactionDate | 20/20 |
1…1Date | Required. Date associated with the business transaction document in bizTransactionList in XML date format YYYY-MM-DD. This date may or may not be the same as the eventTime.23 | ||||||||
tl:shipToCountryCode | 2/2 |
1…1String | Required. 2 or 3 letter ISO country code
for ship to country.
This value will be referenced to advise regulatory reporting if it is
required for the specified country market. Setting this value alone does not
trigger regulatory reporting. Actual triggering of regulatory reporting is
governed by customer administrative configuration in the TraceLink
application.24 See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:shipFromCountryCode | 0/3 |
0…1String | ISO country code for ship from
country. Provides application with the information it needs to trigger
regulatory reporting in response to relevant events.25 See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:receiptDistributionType | 1/* |
1…1String | Required. Informs what types of
regulatory reporting may be triggered based on the nature of the message:
a purchase, transfer, or return within the same country or a purchase,
transfer, or return from another country.26 See the ReceiptDistributionType enumeration list for valid values. |
||||||||
tl:supplyType | 0/* |
0…1String |
Conditionally required if:
Identifies the type of supply that is being performed using one of the permitted values.27 See the SupplyType enumeration list for valid values. |
||||||||
tl:contractType | 0/* |
0…1String | Conditionally required if ShipFromCountryCode = KR and receiptDistributionType = IMPORTPURCHASE
or IMPORTRETURN . Identifies the type of contract
for the sale of goods using one of the permitted values.28See the ContractType enumeration list for valid values. |
||||||||
tl:comments | 0/* |
0…1String | Optional remarks or comments associated with delivery.29 | ||||||||
tl:deliveryCompleteFlag | 0/* |
0…1Boolean |
This field indicates the status of the delivery. Valid values:
|
||||||||
tl:disaggregateFromParent | 0/* |
0…1Boolean |
This field indicates whether the child serial number should be implicitly disaggregated from the parent container. Valid values:
|
||||||||
tl:orderItemList | - |
0…1- | 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. | ||||||||
tl:orderItem | - |
1…*- | Required. 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. | ||||||||
choice%1 | - |
1…1Choice | Required. Populate only one of cmn:InternalMaterialCode or cmn:PackagingItemCode. One of the two options must be present. If both are present or if none is present an error will be thrown. | ||||||||
tl:internalMaterialCode | 1/* |
0…1String | Conditionally required if tl: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.30 | ||||||||
tl:packagingItemCode | 1/* |
0…1String | Conditionally required if tl: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.31 | ||||||||
@type | 1/* |
1…1String |
Required. The product code type for the packaging item code using the supported enumeration values (e.g. GTIN-14).32 See the ItemCode enumeration list for valid values. |
||||||||
tl:lot | 0/* |
0…1String | 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.33 |
||||||||
tl:expiry | 0/* |
0…1Date | Expiration date for product in XML date format YYYY-MM-DD.34 | ||||||||
tl:quantity | 1/* |
1…1Integer | Required. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked.35 | ||||||||
tl:unitPrice | 1/* |
0…1Decimal | Conditionally required if ShipFromCountryCode = KR . The unit price of an item.36 |
||||||||
@currencyCode | 3/3 |
1…1String | Required. Currency ISO code using ISO
4217-2015 format.37 See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:isSerialized | 0/* |
0…1Boolean | Indicates if item is not
serialized. If omitted, default value is true .38 |
||||||||
tl:warehouseOperatorName | 0/* |
0…1String | Conditionally required for China. Name of the person responsible for warehouse operations.39 | ||||||||
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:40![]()
![]() |
||||||||
@type | 1/* |
1…1String |
Required. The type of BusinessId identifier.41 See the BusinessAndLocationId enumeration list for valid values. |
||||||||
tl:businessClassification | 0/* |
0…1String | Conditionally required for Argentina. Provide the business classification of the sold from party
. Valid values:42
|
||||||||
tl:address | - |
0…1- | Conditionally required for the US. Populated with the business name and address of the sold from or transfer from business entity. | ||||||||
tl:businessName | 1/* |
1…1String | Required. The business name of the trading partner.43 | ||||||||
tl:street1 | 1/* |
1…1String | Required. The first line of the street address.44 | ||||||||
tl:street2 | 0/* |
0…1String | The second line of the street address.45 | ||||||||
tl:city | 1/* |
1…1String | Required. The city.46 | ||||||||
tl:district | 0/* |
0…1String | Name of the district subdividing the state or region. | ||||||||
tl:stateOrRegion | 1/* |
1…1String | Required. The state, province, or region
using the standard two-letter abbreviation specified in ISO 3166-2:1998
country subdivision code.47 See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:postalCode | 1/* |
0…1String | The ZIP or other postal code.48 | ||||||||
tl:country | 1/* |
1…1String | Required. The country using the standard
two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.49 See the ISOCountryCode enumeration list for valid values. |
||||||||
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). | ||||||||
@state | 0/* |
0…1String | 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. See the ISOCountryCode enumeration list for valid values. |
||||||||
@agency | 0/* |
0…1String | The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number. | ||||||||
tl:contactInfo | - |
0…1- | Contact information for use by downstream trading partners to verify the message information. | ||||||||
tl:name | 0/* |
1…1String | Required. The name of the contact department or individual at the company. | ||||||||
tl:title | 0/* |
0…1String | The title of the individual if a person was provided in tl:name. | ||||||||
tl:telephone | 1/* |
0…1String | The phone number of the contact department or individual at the company. This must begin with the “+” character followed by the Country Calling Code. | ||||||||
tl:email | 0/* |
0…1String | The email address of the contact department or individual at the company. Should be included if available. | ||||||||
tl:url | 0/* |
0…1String | The Web address to facilitate authentication. | ||||||||
tl:shipFromLocation | - |
1…1- | Required. The full business information associated with the ship from business entity. | ||||||||
tl:facilityId | 1/* |
1…*String | Required. Populated with the ship from location identifier.50 | ||||||||
@type | 1/* |
1…1String | Required. The type of the BusinessId
identifier.51 See the BusinessAndLocationId enumeration list for valid values. |
||||||||
tl:businessClassification | 0/* |
0…1String | Business classification of the ship from party using one of the provided enumerations. | ||||||||
tl:address | - |
0…1- | Conditionally required for the US. Populated with the business name and address of the ship from business entity. | ||||||||
tl:businessName | 1/* |
1…1String | Required. The business name of the trading partner.52 | ||||||||
tl:street1 | 1/* |
1…1String | Required. The first line of the street address.53 | ||||||||
tl:street2 | 0/* |
0…1String | The second line of the street address. | ||||||||
tl:city | 1/* |
1…1String | Required. The city.54 | ||||||||
tl:district | 0/* |
0…1String | Name of the district subdividing the state or region. | ||||||||
tl:stateOrRegion | 1/* |
1…1String | Required. The state, province, or region
using the standard two-letter abbreviation specified in ISO 3166-2:1998
country subdivision code.55 See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:postalCode | 1/* |
0…1String | The ZIP or other postal code.56 | ||||||||
tl:country | 1/* |
1…1String | Required. The country, using the standard
two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.57 See the ISOCountryCode enumeration list for valid values. |
||||||||
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).58 | ||||||||
@state | 0/* |
0…1String | 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.59 See the ISOCountryCode enumeration list for valid values. |
||||||||
@agency | 0/* |
0…1String | The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number.60 | ||||||||
tl:contactInfo | - |
0…1- | Contact information for use by downstream trading partners to verify the message information. | ||||||||
tl:name | 0/* |
1…1String | Required. The name of the contact department or individual at the company.61 | ||||||||
tl:title | 0/* |
0…1String | The title of the individual if a person was provided in tl:name. | ||||||||
tl:telephone | 1/* |
0…1String | The phone number of the contact department or individual at the company. This must begin with the “+” character followed by the Country Calling Code.62 | ||||||||
tl:email | 0/* |
0…1String | The email address of the contact department or individual at the company. Should be included if available.63 | ||||||||
tl:url | 0/* |
0…1String | The Web address to facilitate authentication.64 | ||||||||
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:65![]()
![]() |
||||||||
@type | 1/* |
1…1String | Required. The type of the BusinessId
identifier.
One of the supported enumerations must be provided.66 See the BusinessAndLocationId enumeration list for valid values. |
||||||||
tl:businessClassification | 0/* |
0…1String | Conditionally required for Argentina. Provide the business classification of the sold from party. Valid values:67
|
||||||||
tl:address | - |
0…1- | Conditionally required for the US. Populated with the business name and address of the sold to or transfer to business entity. | ||||||||
tl:businessName | 1/* |
1…1String | Required. The business name of the trading partner.68 | ||||||||
tl:street1 | 1/* |
1…1String | Required. The first line of the street address.69 | ||||||||
tl:street2 | 0/* |
0…1String | The second line of the street address. | ||||||||
tl:city | 1/* |
1…1String | Required. The city.70 | ||||||||
tl:district | 0/* |
0…1String | Name of the district subdividing the state or region. | ||||||||
tl:stateOrRegion | 1/* |
1…1String | Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.71 | ||||||||
tl:postalCode | 1/* |
0…1String | The ZIP or other postal code.72 | ||||||||
tl:country | 1/* |
1…1String | Required. The country using the standard
two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.73 See the ISOCountryCode enumeration list for valid values. |
||||||||
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).74 | ||||||||
@state | 0/* |
0…1String | 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.75 See the ISOCountryCode enumeration list for valid values. |
||||||||
@agency | 0/* |
0…1String | The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number.76 | ||||||||
tl:contactInfo | - |
0…1- | Contact information for use by downstream trading partners to verify the message information. | ||||||||
tl:name | 0/* |
1…1String | Required. The name of the contact department or individual at the company.77 | ||||||||
tl:title | 0/* |
0…1String | The title of the individual if a person was provided in tl:name. | ||||||||
tl:telephone | 1/* |
0…1String | The phone number of the contact department or individual at the company. This must begin with the “+” character followed by the Country Calling Code.78 | ||||||||
tl:email | 0/* |
0…1String | The email address of the contact department or individual at the company. Should be included if available.79 | ||||||||
tl:url | 0/* |
0…1String | The Web address to facilitate authentication. | ||||||||
tl:shipToLocation | - |
1…1- | Required. The full business information associated with the ship to business entity. | ||||||||
tl:facilityId | 1/* |
1…*String | Required. Populated with the ship to location identifier.80 | ||||||||
@type | 1/* |
1…1String | Required. The type of the BusinessId
identifier.
One of the supported enumerations must be provided.81 See the BusinessAndLocationId enumeration list for valid values. |
||||||||
tl:businessClassification | 0/* |
0…1String | Business classification of the ship from party using one of the provided enumerations.82 | ||||||||
tl:address | - |
0…1- | Conditionally required for the US. Populated with the business name and address of the ship to business entity. | ||||||||
tl:businessName | 1/* |
1…1String | Required. The business name of the trading partner.83 | ||||||||
tl:street1 | 1/* |
1…1String | Required. The first line of the street address.84 | ||||||||
tl:street2 | 0/* |
0…1String | The second line of the street address. | ||||||||
tl:city | 1/* |
1…1String | Required. The city.85 | ||||||||
tl:district | 0/* |
0...1String | Name of the district subdividing the state or region. | ||||||||
tl:stateOrRegion | 1/* |
1…1String | Required. The state, province, or region
using the standard two-letter abbreviation specified in ISO 3166-2:1998
country subdivision code.86 See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:postalCode | 1/* |
0…1String | The ZIP or other postal code.87 | ||||||||
tl:country | 1/* |
1…1String | Required. The country using the standard
two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.88 See the ISOCountryCode enumeration list for valid values. |
||||||||
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).89 | ||||||||
@state | 0/* |
0…1String | 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.90 See the ISOCountryCode enumeration list for valid values. |
||||||||
@agency | 0/* |
0…1String | The agency that granted the license (e.g. Florida DOH, NABP). This attribute is used to give additional context to the license number.91 | ||||||||
tl:contactInfo | - |
0…1- | Contact information for use by downstream trading partners to verify the message information. | ||||||||
tl:name | 0/* |
1…1String | Required. The name of the contact department or individual at the company.92 | ||||||||
tl:title | 0/* |
0…1String | The title of the individual if a person was provided in tl:name. | ||||||||
tl:telephone | 1/* |
0…1String | The phone number of the contact department or individual at the company. This must begin with the “+” character followed by the Country Calling Code.93 | ||||||||
tl:email | 0/* |
0…1String | The email address of the contact department or individual at the company. Should be included if available.94 | ||||||||
tl:url | 0/* |
0…1String | 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.![]() |
||||||||
@type | 1/* |
1…1String |
Required. The type of the BusinessId identifier. See the BusinessAndLocationId enumeration list for valid values. |
||||||||
tl:businessClassification | 0/* |
0…1String | Not used. | ||||||||
tl:address | - |
0…1- | Conditionally required for the US. Populated with the business name and address of the carrier. | ||||||||
tl:businessName | 1/* |
1…1String | Required. The business name of the trading partner. | ||||||||
tl:street1 | 1/* |
1…1String | Required. The first line of the street address. | ||||||||
tl:street2 | 0/* |
0…1String | The second line of the street address. | ||||||||
tl:city | 1/* |
1…1String | Required. The city. | ||||||||
tl:stateOrRegion | 1/* |
1…1String | Required. The state, province, or region
using the standard two-letter abbreviation specified in ISO 3166-2:1998
country subdivision code. See the ISOCountryCode enumeration list for valid values. |
||||||||
tl:postalCode | 1/* |
0…1String | The ZIP or other postal code. | ||||||||
tl:country | 1/* |
1…1String | Required. The country using the standard
two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values. |