IBM identifiers

For uploading product, location, transaction, and event data, IBM identifiers can be used as an alternative to GS1 identifiers. All IBM identifier formats are fully qualified URNs that follow the RFC 2141 URN syntax specification.

Identifier types

As alternatives to GS1 registration, IBM can generate identifiers for the following attributes (you can also choose to generate and use your own unique identifiers):

  • Organization prefix
  • Product identifiers (supports a lot or serial number)
  • Location (facility) identifiers (supports a sublocation extension)
  • Logistic unit identifiers (shipping container)

To upload data that uses an IBM identifier, the fully qualified URN must be specified.

Organization prefixes

An IBM organization prefix is 13 digits (for example: 1234567890123).

Note: If your organization has a registered GS1 Company Prefix, use that value as your organization prefix.

Product and location identifiers

Except for organization prefixes, IBM identifier formats referenced in this document are strings that follow the RFC 2141 URN syntax specification (comparable to GS1 URNs). The URN specifications exclude the following octets and characters from the URN character set and if used must be %encoded:

octets 1-32 (1-20 hex)
\
"
&
<
>
[
]
^
`
{
|
}
~
octets 127-255 (7F-FF hex)

IBM identifiers also cannot contain a colon :, comma ,, or period . character, which are reserved for use as URN delimiters. IBM identifiers must conform to the required URN formats.

IBM identifiers and formats

The following IBM identifiers and URN formats are supported in Transparent Supply:

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.produce-department
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
Container 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
TS_ENTITY urn:ibm:ift:bt:<Company Prefix>.<Location Reference>.<Transaction Id> urn:ibm:ift:bt:1234567890123.store-123.1234
TS_DISPOSITION urn:ibm:ift:bv:disp:<Disposition> urn:ibm:ift:bv:disp:destroyed 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

Public Location Identifiers

For data privacy and security, public locations do not convey the entitlement of master data in the same manner as owned locations. When you use public locations, more fields are required in the destinationList or sourceList to ensure that the entitlement of master data is conveyed to partner organizations in the supply chain.

An organization that is shipping products to a public location must update the destinationList to include:

  • The public location
  • A location that is owned by the receiving organization (for example company headquarters)

DestinationList Example

<destinationList>
      <destination type="urn:epcglobal:cbv:sdt:location">urn:ibm:ift:location:unlocode:loc:usnyc</destination>
      <destination type="urn:epcglobal:cbv:sdt:owning_party">urn:ibm:ift:location:loc:PARTNER_PREFIX.PARTNER_ID</destination>
</destinationList>

An organization that is receiving products from a public location must update the sourceList to include:

  • The public location
  • A location owned by the shipping organization (for example company headquarters)

SourceList Example

<sourceList>
      <source type="urn:epcglobal:cbv:sdt:location">urn:ibm:ift:location:unlocode:loc:usnyc</source>
      <source type="urn:epcglobal:cbv:sdt:owning_party">urn:ibm:ift:location:loc:PARTNER_PREFIX.PARTNER_ID</source>
</sourceList>

The following IBM public location type identifier formats are supported for publicly owned ports, farms, and growing regions:

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
Location (company headquarters) urn:ibm:ift:location:loc:<Company Prefix>.<Location Reference> urn:ibm:ift:location:loc:PARTNER_PREFIX.PARTNER_ID
  • The following IBM public location type variables and values are supported:
Variable Value
<TYPE> For public ports - unlocode
<TYPE> For public growing regions and farms - pma.
<ID> For unlocode - Any lowercase five-character (country + location) UNECE identifier
<ID> For pma - Any lowercase two-character US 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