Skip to content
This repository has been archived by the owner on Oct 21, 2021. It is now read-only.

doc IBMFoodTrust ID (identifiers)

Josh Horton edited this page Feb 10, 2021 · 17 revisions

IBM Food Trust Identifiers

In some instances, you may need to use identifiers that are not registered with GS1. For these cases, IBM Food Trust provides the following identifiers:

  • IBM Food Trust Organization Prefixes
  • IBM Food Trust Product Identifiers (supports a lot or serial number)
  • IBM Food Trust Location Identifiers (supports a sub-location extension)
  • IBM Food Trust Logistic Unit Identifiers

If you have a GS1 Registered Company Prefix, use it as your IBM Food Trust Organization Prefix. Otherwise, a new IBM Food Trust Organization Prefix can be provided for you. For transactions and events submitted to IBM Food Trust, IBM Food Trust identifiers can be used in place of their GS1/EPC counterparts, for products, locations, and logistic units. All IBM Food Trust identifiers are fully-qualified URNs that follow RFC 2141 (similar to GS1 URNs). For each instance of an IBM Food Trust identifier in your submitted data, the fully-qualified URN must be specified.

IBM Food Trust Organization Prefixes

IBM Food Trust Organization Prefixes are 13 or more numeric digits. Each prefix is a unique identifier (UUID) and assigned to a single organization.

Example of an IBM Food Trust Organization Prefix: 1234567890123

Format for IBM Food Trust Identifier Fields

With the exception of IBM Food Trust Organization Prefixes, the IBM Food Trust identifier fields referenced in this document are strings that follow the RFC 2141 URN syntax specification (similar to GS1 URNs), with one restriction. IBM Food Trust identifier fields cannot contain a colon:, comma ,, or period . character, which are reserved for use as delimiters in IBM Food Trust URNs.

The following IBM Food Trust identifier fields must conform to the IBM Food Trust identifier field format:

  • <Item Reference>
  • <Lot Number>
  • <Serial Number>
  • <Location Reference>
  • <Extension>
  • <Serial Reference>

IBM Food Trust Identifiers - Types and Formats

Table 1 displays the IBM Food Trust identifier types and URN formats:

Table 1. IBM Food Trust Identifiers

Element Syntax and Example
Product urn:ibm:ift:product:class:<Company Prefix>.<Item Reference>
urn:ibm:ift:product:class:1234567890123.product_123
Product with Lot # urn:ibm:ift:product:lot:class:<Company Prefix>.<Item Reference>.<Lot Number>
urn:ibm:ift:product:lot:class:1234567890123.product_123.lot4
Product with Serial # urn:ibm:ift:product:serial:obj:<Company Prefix>.<Item Reference>.<Serial Number>
urn:ibm:ift:product:serial:obj:1234567890123.product_123.serialnumber_4567
Location urn:ibm:ift:location:loc:<Company Prefix>.<Location Reference>
urn:ibm:ift:location:loc:1234567890123.store_123
Location with Extension urn:ibm:ift:location:extension:loc:<Company Prefix>.<Location Reference>.<Extension>
urn:ibm:ift:location:extension:loc:1234567890123.store_123.producedepartment
Public Location Type* urn:ibm:ift:location:<TYPE>:loc:<ID>
urn:ibm:ift:location:unlocode:loc:usnyc
Public Location Type with Extension* urn:ibm:ift:location:<TYPE>:ext:loc:<ID>.<EXT>
urn:ibm:ift:location:unlocode:ext:loc:usnyc.import
Logistic Unit urn:ibm:ift:lpn:obj:<Company Prefix>.<Serial Reference>
urn:ibm:ift:lpn:obj:1234567890123.pallet_12345678
Business Transaction Identifier urn:ibm:ift:bt:<Company Prefix>.<Location Reference>.<Transaction Id>
urn:ibm:ift:bt:1234567890123.store_123.1234
FTPI urn:ibm:ift:product:class:1234567890123.product-123
urn:ibm:ift:product:class:<Company Prefix>.<Item Reference>
LFTPI urn:ibm:ift:product:lot:class:1234567890123.product-123.lot4
urn:ibm:ift:product:lot:class:<Company Prefix>.<Item Reference>.<Lot Number>
SFTPI urn:ibm:ift:product:serial:obj:1234567890123.product-123.serial-number-4567
urn:ibm:ift:product:serial:obj:<Company Prefix>.<Item Reference>.<Serial Number>
FTLI urn:ibm:ift:location:loc:1234567890123.store-123
urn:ibm:ift:location:loc:<Company Prefix>.<Location Reference>
SFTLI urn:ibm:ift:location:extension:loc:1234567890123.store-123.toy-department
urn:ibm:ift:location:extension:loc:<Company Prefix>.<Location Reference>.<Extension>
FTLPN urn:ibm:ift:lpn:obj:1234567890123.pallet-12345678
urn:ibm:ift:lpn:obj:<Company Prefix>.<Serial Reference>
SSCC_LA urn:ibm:provenance:ids:supplychain:aggregation:lpn:5012345.xyz123
urn:ibm:provenance:ids:supplychain:<Document Type>:lpn:<Company Prefix>.*
IFT_ENTITY urn:ibm:ift:bt:1234567890123.store-123.1234
urn:ibm:ift:bt:<Company Prefix>.<Location Reference>.<Transaction Id>
IFT_DISPOSITION urn:ibm:ift:bv:disp:destroyed
urn:ibm:ift:bv:disp:<Disposition>
Valid Dispositions = active, container_closed, damaged, destroyed, dispensed, disposed, encoded, expired, in_progress, in_transit, inactive, no_pedigree_match, non_sellable_other, partially_dispensed, recalled, reserved, retail_sold, returned, sellable_accessible, sellable_not_accessible, stolen, unknown

*Table 2 describes the Public Location Type identifier formats for publicly-owned ports, farms, and growing regions:

Table 2. IBM Food Trust Public Location Type Identifiers

Element Syntax and Example
Public Location Type urn:ibm:ift:location:<TYPE>:loc:<ID>
urn:ibm:ift:location:unlocode:loc:usnyc
Public Location Type with Extension urn:ibm:ift:location:<TYPE>:ext:loc:<ID>.<EXT>
urn:ibm:ift:location:unlocode:ext:loc:usnyc.import

*Table 3 describes the Public Location Type variables and supported values:

Table 3. Public Location Type Variables and Values

Variable Value
<TYPE> For ports - unlocode
<TYPE> For growing regions and farms - pma.
<ID> For unlocode - Any lowercase five-character (country + location) UNECE identifier
<ID> For pma - Any lowercase two-character U.S. state abbreviation EXCEPT for ca and az | yuma | phoenix | south_az | north_ca | salinas | santa_maria | south_ca | imperial_vly | coachella | central_vly | north_mx | central_mx | south_mx
<EXT> For unlocode only - import | export
Clone this wiki locally