Documentation

FAQ

What is the EPC Converter?

The EPC Converter is a REST API to decode/create/generate/update an Electronic Product Code according to the GS1 EPC Tag Data Standard (TDS) 1.11. The data is provided in JSON format.

How does it work?

Register free to aquire a API token. Use your API Token to call REST API Calls to create or convert a EPC into another format. You find your API Token under "Manage Account", if you are logged in.

What is the pricing?

The service is free for 100 calls per day. If you need more calls the contact us!

What is the functionality?

The EPC Converter offers this methods:

How can I test it?

You can test the API requests with our API page. This page is using Swagger.

Contact

Please contact us!

API Calls

General considerations

HTTP-Method http://convert.erfideo.com/api/tag/epc/epchex?KEY=Your apikey

The API call are documented in this format: the used HTTP method (GET, POST), the url of the API service and the API key of the user ist added as the URL parameter (KEY). The details of the input parameters depend on which operation you are calling. In all cases, you must include your API key, which you will receive after you register for an account and log in. For a successful POST API call, do not forget to set the HTTP Accept and Content-Type headers to application/json.

The response to your request is a payload in JSON format.

In most cases, the response will include your input parameters (other than the API key). If the operation was successful, your output will include the results of encoding or decoding your input.

Each API call which returns an EPC contains special data fields for the EPC class and these general data fields:

Output Values

Parameter Description
EpcClass Epc Class name (Dod-96, Gdti-96, Gdti-174, Giai-96, Giai-202, Gid-96, Grai-96, Grai-170, Gsrn-96, Gsrnp-96, Sgln-96, Sgln-195, Sgtin-96, Sgtin-198, Sscc-96, Sgcn-96, Cpi-96, Cpi-Var, Adi-Var, Itip-110, Itip-212).
HexValue Epc Value as a Hexdecimal String.
TagUri Tag Uri represensation of the epc.
PureIdentityUri Pure identity Uri of the epc.
GS1ElementString GS1 Element String.
TagLength Tag length of the Epc.
Raw Raw byte array value Base64 encoded.
RawBinary Raw data as binary string represensation.

GS1 Company Prefix length

When translating a GS1 Key as found in a EPC forms (EPC URI, Tag URI, or binary/hexadecimal), it is necessary to indicate how many digits within the GS1 Key belong to the GS1 Company Prefix. This is because in the other EPC forms, there is an explicit separation between the GS1 Company Prefix and the rest of the identifier.

You can obtain the correct value of GS1 Company Prefix Length from an outside source. If you are the company or organization that issued the GS1 Key, then you should know the length of the GS1 Company Prefix because you used it to create the GS1 Key in the first place. If you are a trading partner of the company that issued the GS1 Key, you may ask that company. Some GS1 Member Organizations (the bodies responsible for issuing GS1 Company Prefixes to companies that create GS1 Keys) publish lists of GS1 Company Prefixes that you can consult.

Decode EPC memory bank

This API call decodes a EPC memory bank as a hex string value.

GET http://convert.erfideo.com/api/epc/decode/hex/hexvalue?KEY=key

Input Parameters

Parameter Description
hexvalue Epc Value as a Hex String.
KEY Your API Key.

Output Values

Parameter Description
HexValue Epc Value as a Hexdecimal String.
TagUri Tag Uri represensation of the epc.
PureIdentityUri Pure identity Uri of the epc.
GS1ElementString GS1 Element String.
TagLength Tag length of the Epc.
Raw Raw byte array value Base64 encoded.
RawBinary Raw data as binary string represensation.

Request

GET http://convert.erfideo.com/api/epc/decode/hex/3034257BF7194E4000000005?KEY=Your apikey

Response (JSON)

{
     "HexValue": "3034257BF7194E4000000005",
    "PureIdentityUri": "urn:epc:id:sgtin:0614141.812345.5",
    "TagUri": "urn:epc:tag:sgtin-96:1.0614141.812345.5",
    "TagLength": 96,
    "EpcClass": "sgtin-96",
    "RawBinary": "001100000011010000100101011110111111011100011001010011100100000000000000000000000000000000000101",
    "GS1ElementString": "(01)80614141123458(21)5",
    "Filter": 1,
    "CompanyPrefixLength": 7,
    "GS1Companyprefix": "0614141",
    "ItemReferenceIndicatorDigit": "812345",
    "CheckDigit": "8",
    "Gtin": "80614141123458",
    "SerialNumber": 5,
    "Raw": "MDQle/cZTkAAAAAF"
}

Decode EPC Tag Uri

This API call decodes a EPC Tag Uri.

GET http://convert.erfideo.com/api/epc/decode/taguri/taguri?KEY=Your apikey

Input Parameters

Parameter Description
taguri Epc Value as a Hex String.
KEY Your API Key.

Output Values

Request

GET http://convert.erfideo.com/api/epc/decode/taguri/urn:epc:tag:sgtin-96:1.0614141.812345.5?KEY=Your apikey

Response (JSON)

{
    "HexValue": "3034257BF7194E4000000005",
    "PureIdentityUri": "urn:epc:id:sgtin:0614141.812345.5",
    "TagUri": "urn:epc:tag:sgtin-96:1.0614141.812345.5",
    "TagLength": 96,
    "EpcClass": "sgtin-96",
    "RawBinary": "001100000011010000100101011110111111011100011001010011100100000000000000000000000000000000000101",
    "GS1ElementString": "(01)80614141123458(21)5",
    "Filter": 1,
    "CompanyPrefixLength": 7,
    "GS1Companyprefix": "0614141",
    "ItemReferenceIndicatorDigit": "812345",
    "CheckDigit": "8",
    "Gtin": "80614141123458",
    "SerialNumber": 5,
    "Raw": "MDQle/cZTkAAAAAF"
}

Encode Epc

Each EPC class (Dod-96, Gdti-96, Gdti-174, Giai-96, Giai-202, Gid-96, Grai-96, Grai-170, Gsrn-96, Gsrnp-96, Sgln-96, Sgln-195, Sgtin-96, Sgtin-198, Sscc-96) offers a explicit API call to encode an EPC. The naming convention is always the same

GET http://convert.erfideo.com/api/epc/encode/epcclass?parameters
Sgtin-96 example:
GET http://convert.erfideo.com/api/epc/encode/sgtin96/?filter=3&gtin=80614141123458&companyprefixlength=7&serialNumber=3598&KEY=Your apikey
Each API call is documented in detail in the next chapters.

Encode a Serialized GTIN (Sgtin-96)

This API call is used to encode a GTIN and a serial number into a Sgtin-96.

GET http://convert.erfideo.com/api/epc/encode/sgtin96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Sgtin (between 0 and 7).
Gtin Gtin according to the GS1 standards (14 length).
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
SerialNumber Serial Number (38 bit - Max: 274877906943).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Sgtin filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
ItemReferenceIndicatorDigit Item reference and the indicator digit as defined in the tag data standards.
CheckDigit Gtin check digit.
Gtin Global trade item number (Gtin) (14 in length)
SerialNumber Serial number of the Sgtin (Max: 274877906943)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/sgtin96/?filter=1&gtin=80614141123458&companyprefixlength=7&serialnumber=5&KEY=Your apikey

Response (JSON)

{
    "HexValue": "3034257BF7194E4000000005",
    "PureIdentityUri": "urn:epc:id:sgtin:0614141.812345.5",
    "TagUri": "urn:epc:tag:sgtin-96:1.0614141.812345.5",
    "TagLength": 96,
    "EpcClass": "sgtin-96",
    "RawBinary": "001100000011010000100101011110111111011100011001010011100100000000000000000000000000000000000101",
    "GS1ElementString": "(01)80614141123458(21)5",
    "Filter": 1,
    "CompanyPrefixLength": 7,
    "GS1Companyprefix": "0614141",
    "ItemReferenceIndicatorDigit": "812345",
    "CheckDigit": "8",
    "Gtin": "80614141123458",
    "SerialNumber": 5,
    "Raw": "MDQle/cZTkAAAAAF"
}

Encode a Serialized GTIN (Sgtin-198)

This API call is used to encode a GTIN and a serial number into a Sgtin-198.

GET http://convert.erfideo.com/api/epc/encode/sgtin198/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Sgtin (between 0 and 7).
Gtin Gtin according to the GS1 standards (14 length).
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
SerialNumber Serial Number (140 bit - alpha numeric defined in the GS1 General Specifications).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Sgtin filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
ItemReferenceIndicatorDigit Item reference and the indicator digit as defined in the tag data standards.
CheckDigit Gtin check digit.
Gtin Global trade item number (Gtin) (14 in length)
SerialNumber Serial number of the Sgtin (140 bit - alpha numeric defined in the GS1 General Specifications)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/sgtin198/?filter=1&gtin=80614141123458&companyprefixlength=7&serialnumber=5abc&KEY=Your apikey

Response (JSON)

{   
    "EpcClass": "sgtin-198",
    "Gtin": "80614141123458",
    "ItemReferenceIndicatorDigit": "812345",
    "SerialNumber": "5abc",
    "RawBinary": "001101100011010000100101011110111111011100011001010011100101101011100001110001011000110000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "TagLength": 198,
    "CompanyPrefixLength": 7,
    "CheckDigit": "8",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(01)80614141123458(21)5abc",
    "PureIdentityUri": "urn:epc:id:sgtin:0614141.812345.5abc",
    "Raw": "NjQle/cZTlrhxYwAAAAAAAAAAAAAAAAAAA==",
    "HexValue": "3634257BF7194E5AE1C58C0000000000000000000000000000",
    "TagUri": "urn:epc:tag:sgtin-198:1.0614141.812345.5abc"
}

Encode a US Department of Defense Identifier (Dod-96)

This API call is used to encode a US Department of Defense Identifier.

GET http://convert.erfideo.com/api/epc/encode/dod96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Sgtin (between 0 and 15).
GovernmentManagedIdentifier This field contains the respective suppliers CAGE code.
Serial Serial Number (36 bit - Max: 68719476735).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
Filter Filter values (between 0 and 15)
GovernmentManagedIdentifier Government Managed Identifier contains the respective suppliers CAGE code.
Serial Serial number of the Dod (Max: 68719476735)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/dod96/?filter=1&governmentmanagedidentifier=123ABC&serialnumber=1000&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "usdod-96",
    "TagLength": 96,
    "Filter": 1,
    "GovernmentManagedIdentifier": "123ABC",
    "Serial": 1000,
    "Raw": "LxMTIzQUJDAAAAPo",
    "RawBinary": "001011110001001100010011001000110011010000010100001001000011000000000000000000000000001111101000",
    "HexValue": "2F13132334142430000003E8",
    "TagUri": "urn:epc:tag:usdod-96:1.123ABC.1000",
    "PureIdentityUri": "urn:epc:id:usdod:123ABC.1000"
}

Encode a Global Document Type Identifier (Gdti-96)

This API call is used to encode a Document Type and a serial number into a Gdti-96.

GET http://convert.erfideo.com/api/epc/encode/gdti96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Gdti (between 0 and 7).
Gdti The Global Document Type Identifier, this field includes the serial number.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
DocType The document type encoded in the gdti.
CheckDigit The gdti check digit.
Gdti The whole Global Document Type Identifier with serial.
Serial Serial of the Gdti (Max: 2199023255551)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/gdti96?filter=1&gdti=06141411234525678&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "gdti-96",
    "Serial": 5678,
    "DocType": "12345",
    "GDTI": "06141411234525678",
    "TagLength": 96,
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(253)06141411234525678",
    "PureIdentityUri": "urn:epc:id:gdti:0614141.12345.5678",
    "Raw": "LDQle/RgcgAAABYu",
    "RawBinary": "001011000011010000100101011110111111010001100000011100100000000000000000000000000001011000101110",
    "HexValue": "2C34257BF46072000000162E",
    "TagUri": "urn:epc:tag:gdti-96:1.0614141.12345.5678"
}

Encode a Global Document Type Identifier (Gdti-174)

This API call is used to encode a Document Type and a optinal serial number into a Gdti-174.

GET http://convert.erfideo.com/api/epc/encode/gdti174?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Gdti (between 0 and 7).
Gdti The Global Document Type Identifier, this field includes the serial number.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
DocType The document type encoded in the gdti.
CheckDigit The gdti check digit.
Gdti The whole Global Document Type Identifier with serial.
Serial Serial number (alpha numeric) of the Gdti (119 bit)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/gdti174?filter=1&gdti=4012345987652ABCDefgh012345678&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "gdti-174",
    "Serial": "ABCDefgh012345678",
    "DocType": "98765",
    "GDTI": "4012345987652ABCDefgh012345678",
    "TagLength": 174,
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "4012345",
    "Filter": 1,
    "GS1ElementString": "(253)4012345987652ABCDefgh012345678",
    "PureIdentityUri": "urn:epc:id:gdti:4012345.98765.ABCDefgh012345678",
    "Raw": "PjT05OcDmwYUOJlzZ9DBiyZtGrZu4A==",
    "RawBinary": "001111100011010011110100111001001110011100000011100110110000011000010100001110001001100101110011011001111101000011000001100010110010011001101101000110101011011001101110111000",
    "HexValue": "3E34F4E4E7039B061438997367D0C18B266D1AB66EE0",
    "TagUri": "urn:epc:tag:gdti-174:1.4012345.98765.ABCDefgh012345678"
}

Encode a Global Individual Asset Identifier (Giai-96)

This API call is used to encode a Global Individual Asset Identifier into a Giai-96.

GET http://convert.erfideo.com/api/epc/encode/giai96?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Giai (between 0 and 7).
Giai The Global Individual Asset Identifier.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
Giai The whole Global Individual Asset Identifier.
AssetReference The Asset Reference of the Giai (Max: 4611686018427387903)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/giai96?filter=1&giai=06141415678&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "giai-96",
    "AssetReference": "5678",
    "TagLength": 96,
    "CompanyPrefixLength": 7,
    "CheckDigit": "",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(8004)06141415678",
    "PureIdentityUri": "urn:epc:id:giai:0614141.5678",
    "Raw": "NDQle/QAAAAAABYu",
    "RawBinary": "001101000011010000100101011110111111010000000000000000000000000000000000000000000001011000101110",
    "HexValue": "3434257BF40000000000162E",
    "TagUri": "urn:epc:tag:giai-96:1.0614141.5678"
}

Encode a Global Individual Asset Identifier (Giai-202)

This API call is used to encode a Global Individual Asset Identifier into a Giai-202.

GET http://convert.erfideo.com/api/epc/encode/giai202?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Giai (between 0 and 7).
Giai The Global Individual Asset Identifier.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
GIAI The whole Global Individual Asset Identifier.
AssetReference The Asset Reference of the Giai (148-168 bit alpha numeric)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/giai202?filter=1&giai=06141415678abc&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "giai-202",
    "AssetReference": "5678abc",
    "TagLength": 202,
    "CompanyPrefixLength": 7,
    "CheckDigit": "",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(8004)06141415678abc",
    "PureIdentityUri": "urn:epc:id:giai:0614141.5678abc",
    "Raw": "ODQle/WrZu4w4sYAAAAAAAAAAAAAAAAAAAA=",
    "RawBinary": "0011100000110100001001010111101111110101101010110110011011101110001100001110001011000110000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "HexValue": "3834257BF5AB66EE30E2C600000000000000000000000000000",
    "TagUri": "urn:epc:tag:giai-202:1.0614141.5678abc"
}

Encode a General Identifier (Gid-96)

This API call is used to encode a General Identifier into a Gid-96.

GET http://convert.erfideo.com/api/epc/encode/gid96?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
GeneralManagerNumber The General Manager Number identifies an organizational entity (essentially a company, manager or other organization) that is responsible for maintaining the numbers in Object Class and Serial Number. (Max: 268435455)
ObjectClass The Object Class is used by an EPC managing entity to identify a class or "type" of thing. (Max: 16777215)
SerialNumber Serial Number code, or serial number, is unique within each object class. (Max: 68719476735)
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GeneralManagerNumber The General Manager Number identifies an organizational entity (essentially a company, manager or other organization) that is responsible for maintaining the numbers in Object Class and Serial Number. (Max: 268435455)
ObjectClass The Object Class is used by an EPC managing entity to identify a class or "type" of thing. (Max: 16777215)
SerialNumber Serial Number code, or serial number, is unique within each object class. (Max: 68719476735)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/gid96?generalmanagernumber=2598&objectclass=400&serialnumber=987649786&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "gid-96",
    "GeneralManagerNumber": 2598,
    "ObjectClass": 400,
    "SerialNumber": 987649786,
    "TagLength": 96,
    "Raw": "NQAAomAAGQA63lb6",
    "RawBinary": "001101010000000000000000101000100110000000000000000110010000000000111010110111100101011011111010",
    "HexValue": "350000A2600019003ADE56FA",
    "TagUri": "urn:epc:tag:gid-96:2598.400.987649786",
    "PureIdentityUri": "urn:epc:id:gid:2598.400.987649786"
}

Encode a Global Returnable Asset Identifier (Grai-96)

This API call is used to encode a Global Returnable Asset Identifier into a Grai-96.

GET http://convert.erfideo.com/api/epc/encode/grai96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Grai The Global Returnable Asset Identifier.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
AssetType The Asset Type, assigned by the managing entity to a particular class of asset.
CheckDigit The gdti check digit.
Grai The whole Global Returnable Asset Identifier.
Serial The Serial Number, assigned by the managing entity to an individual object. (Max: 274877906943)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/grai96?filter=1&grai=006141411234525678&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "grai-96",
    "TagLength": 96,
    "Serial": 5678,
    "AssetType": "12345",
    "GRAI": "006141411234525678",
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(8003)006141411234525678",
    "PureIdentityUri": "urn:epc:id:grai:0614141.12345.5678",
    "Raw": "MzQle/QMDkAAABYu",
    "RawBinary": "001100110011010000100101011110111111010000001100000011100100000000000000000000000001011000101110",
    "HexValue": "3334257BF40C0E400000162E",
    "TagUri": "urn:epc:tag:grai-96:1.0614141.12345.5678"
}

Encode a Global Returnable Asset Identifier (Grai-170)

This API call is used to encode a Global Returnable Asset Identifier into a Grai-170.

GET http://convert.erfideo.com/api/epc/encode/grai170/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Grai The Global Returnable Asset Identifier.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
AssetType The Asset Type, assigned by the managing entity to a particular class of asset.
CheckDigit The gdti check digit.
Grai The whole Global Returnable Asset Identifier.
Serial The Serial Number, assigned by the managing entity to an individual object. (112 bit alpha numeric)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/grai170?filter=1&grai=006141411234525678&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "grai-170",
    "TagLength": 170,
    "Serial": "5678abc",
    "AssetType": "12345",
    "GRAI": "006141411234525678abc",
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(8003)006141411234525678abc",
    "PureIdentityUri": "urn:epc:id:grai:0614141.12345.5678abc",
    "Raw": "NzQle/QMDlq2buMOLGAAAAAAAAAAAA==",
    "RawBinary": "00110111001101000010010101111011111101000000110000001110010110101011011001101110111000110000111000101100011000000000000000000000000000000000000000000000000000000000000000",
    "HexValue": "3734257BF40C0E5AB66EE30E2C60000000000000000",
    "TagUri": "urn:epc:tag:grai-170:1.0614141.12345.5678abc"
}

Encode a Global Service Relation Number (Gsrn-96)

This API call is used to encode a Global Service Relation Number into a Gsrn-96.

GET http://convert.erfideo.com/api/epc/encode/gsrn96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Gsrn The Global Service Relation Number.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter value (between 0 and 7).
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
CheckDigit The gdti check digit.
Gsrn The whole Global Service Relation Number.
ServiceReference The Service Reference, assigned by the managing entity to a particular service recipient. (Max: 99999999999)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/gsrn96?filter=1&gsrn=061414112345678902&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "gsrn-96",
    "ServiceReference": "1234567890",
    "TagLength": 96,
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(8018)061414112345678902",
    "PureIdentityUri": "urn:epc:id:gsrn:0614141.1234567890",
    "Raw": "LTQle/RJlgLSAAAA",
    "RawBinary": "001011010011010000100101011110111111010001001001100101100000001011010010000000000000000000000000",
    "HexValue": "2D34257BF4499602D2000000",
    "TagUri": "urn:epc:tag:gsrn-96:1.0614141.1234567890"
}

Encode a Global Service Relation Number - Provider (Gsrnp-96)

This API call is used to encode a Global Service Relation Number - Provider into a Gsrnp-96.

GET http://convert.erfideo.com/api/epc/encode/gsrnp96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Gsrn The Global Service Relation Number.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter value (between 0 and 7).
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
CheckDigit The gdti check digit.
Gsrnp The whole Global Service Relation Number - Provider.
ServiceReference The Service Reference, assigned by the managing entity to a particular service recipient. (Max: 99999999999)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/gsrnp96?filter=1&gsrnp=061414112345678902&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "gsrnp-96",
    "ServiceReference": "1234567890",
    "TagLength": 96,
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(8017)061414112345678902",
    "PureIdentityUri": "urn:epc:id:gsrnp:0614141.1234567890",
    "Raw": "LjQle/RJlgLSAAAA",
    "RawBinary": "001011100011010000100101011110111111010001001001100101100000001011010010000000000000000000000000",
    "HexValue": "2E34257BF4499602D2000000",
    "TagUri": "urn:epc:tag:gsrnp-96:1.0614141.1234567890"
}

Encode a Global Location Number With or Without Extension (Sgln-96)

This API call is used to encode a Global Location Number With or Without Extension into a Sgln-96.

GET http://convert.erfideo.com/api/epc/encode/sgln96/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Gln The Location Reference, assigned uniquely by the managing entity to a specific physical location.
Extension The GLN Extension, assigned by the managing entity to an individual unique location. If the entire GLN Extension is just a single zero digit, it indicates that the SGLN stands for a GLN, without an extension. (Max: 2199023255551)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
AssetType The Asset Type, assigned by the managing entity to a particular class of asset.
CheckDigit The gdti check digit.
Gln The Global Location Number.
LocationReference The Location Reference, assigned uniquely by the managing entity to a specific physical location.
Extension The GLN Extension, assigned by the managing entity to an individual unique location. If the entire GLN Extension is just a single zero digit, it indicates that the SGLN stands for a GLN, without an extension. (Max: 2199023255551)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/sgln96?filter=1&gln=0614141123452&companyprefixlength=7&extension=535&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "sgln-96",
    "Extension": 535,
    "LocationReference": "12345",
    "GLN": "0614141123452",
    "TagLength": 96,
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(414)0614141123452(254)535",
    "PureIdentityUri": "urn:epc:id:sgln:0614141.12345.535",
    "Raw": "MjQle/RgcgAAAAIX",
    "RawBinary": "001100100011010000100101011110111111010001100000011100100000000000000000000000000000001000010111",
    "HexValue": "3234257BF460720000000217",
    "TagUri": "urn:epc:tag:sgln-96:1.0614141.12345.535"
}

Encode a Global Location Number With or Without Extension (Sgln-195)

This API call is used to encode a Global Location Number With or Without Extension into a Sgln-96.

GET http://convert.erfideo.com/api/epc/encode/sgln195/?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Gln The Location Reference, assigned uniquely by the managing entity to a specific physical location.
Extension The GLN Extension, assigned by the managing entity to an individual unique location. If the entire GLN Extension is just a single zero digit, it indicates that the SGLN stands for a GLN, without an extension. (140 bit alpha numeric)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
AssetType The Asset Type, assigned by the managing entity to a particular class of asset.
CheckDigit The gdti check digit.
Gln The Global Location Number.
LocationReference The Location Reference, assigned uniquely by the managing entity to a specific physical location.
Extension The GLN Extension, assigned by the managing entity to an individual unique location. If the entire GLN Extension is just a single zero digit, it indicates that the SGLN stands for a GLN, without an extension. (140 bit alpha numeric)

Sample Request

GET http://convert.erfideo.com/api/epc/encode/sgln195?filter=1&gln=0614141123452&companyprefixlength=7&extension=535abc&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "sgln-195",
    "Extension": "535abc",
    "GS1Companyprefix": "0614141",
    "LocationReference": "12345",
    "GLN": "0614141123452",
    "TagLength": 195,
    "CompanyPrefixLength": 7,
    "CheckDigit": "2",
    "Filter": 1,
    "GS1ElementString": "(414)0614141123452(254)535abc",
    "PureIdentityUri": "urn:epc:id:sgln:0614141.12345.535abc",
    "Raw": "OTQle/RgctWbXDixgAAAAAAAAAAAAAAAAA==",
    "RawBinary": "001110010011010000100101011110111111010001100000011100101101010110011011010111000011100010110001100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "HexValue": "3934257BF46072D59B5C38B18000000000000000000000000",
    "TagUri": "urn:epc:tag:sgln-195:1.0614141.12345.535abc"
}

Encode a Serial Shipping Container Code (Sscc-96)

This API call is used to encode a Serial Shipping Container Code into a Sscc-96.

GET http://convert.erfideo.com/api/epc/encode/sscc96?<Input Parameters>&KEY=Your apikey

Input Parameters

Parameter Description
Filter Filter value of the Grai (between 0 and 7).
Sscc The Serial Reference, assigned by the managing entity to a particular logistics handling unit.
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
KEY Your API Key.

Output Values

In addition to the general EPC data fields described in this chapter the following data is provided:

Parameter Description
GS1ElementString GS1 enconding of the company prefix and serial number.
Filter Filter values (between 0 and 7)
CompanyPrefixLength Company Prefix Length as described in this chapter (between 6 and 12).
GS1Companyprefix GS1 company prefix.
AssetType The Asset Type, assigned by the managing entity to a particular class of asset.
CheckDigit The gdti check digit.
Sscc The Serial Shipping Container Code.
ExtensionDigit The Serial Reference extension digit.
SerialReference The Serial Reference, assigned by the managing entity to a particular logistics handling unit.

Sample Request

GET http://convert.erfideo.com/api/epc/encode/sscc96?filter=1&sscc=106141412345678908&companyprefixlength=7&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "sscc-96",
    "SerialReference": "1234567890",
    "ExtensionDigit": 1,
    "SSCC": "106141412345678908",
    "TagLength": 96,
    "CompanyPrefixLength": 7,
    "CheckDigit": "8",
    "GS1Companyprefix": "0614141",
    "Filter": 1,
    "GS1ElementString": "(00)106141412345678908",
    "PureIdentityUri": "urn:epc:id:sscc:0614141.1234567890",
    "Raw": "MTQle/RJlgLSAAAA",
    "RawBinary": "001100010011010000100101011110111111010001001001100101100000001011010010000000000000000000000000",
    "HexValue": "3134257BF4499602D2000000",
    "TagUri": "urn:epc:tag:sscc-96:1.0614141.1234567890"
}

Encode a Serialised Global Coupon Number (Sgcn-96)

This API call is used to encode a Global Coupon Number into a Sgcn-96.

GET http://convert.erfideo.com/api/epc/encode/sgcn96?<Input Parameters>&KEY=Your apikey

Detail description comming soon...

Encode a Component and Part Identifier (Cpi-96)

This API call is used to encode a Component and Part Identifier to a Cpi-96.

GET http://convert.erfideo.com/api/epc/encode/cpi96?<Input Parameters>&KEY=Your apikey

Detail description comming soon...

Encode a Component and Part Identifier (Cpi-Var)

This API call is used to encode a Component and Part Identifier to a Cpi-Var.

GET http://convert.erfideo.com/api/epc/encode/cpivar?<Input Parameters>&KEY=Your apikey

Detail description comming soon...

Encode an Aerospace and Defense Identifier (Adi-Var)

This API call is used to encode an Aerospace and Defense Identifier to an Aid-Var.

GET http://convert.erfideo.com/api/epc/encode/adivar?<Input Parameters>&KEY=Your apikey

Detail description comming soon...

Encode an Individual Trade Item Piece (Itip-110)

This API call is used to encode an Individual Trade Item Piece to an Itip-110.

GET http://convert.erfideo.com/api/epc/encode/itip110?<Input Parameters>&KEY=Your apikey

Detail description comming soon...

Encode an Individual Trade Item Piece (Itip-212)

This API call is used to encode an Individual Trade Item Piece to an Itip-212.

GET http://convert.erfideo.com/api/epc/encode/itip212?<Input Parameters>&KEY=Your apikey

Detail description comming soon...

Update EPC

This API call allow you to update one field of an EPC class to a new value. For example somebody like to change the serial number of a Sgtin-96 to another value.

POST http://convert.erfideo.com/api/epc/update/EPC Hex Value?&KEY=Your apikey

Body:

{
    "Field to Update" : New Value
}

Sample Request

GET http://convert.erfideo.com/api/epc/update/3074257BF7194E4000001A85?KEY=Your apikey

Body:

{
    "SerialNumber" : 1000
}

Response (JSON)

{
    "HexValue": "3074257BF7194E40000003E8",
    "PureIdentityUri": "urn:epc:id:sgtin:0614141.812345.1000",
    "TagUri": "urn:epc:tag:sgtin-96:3.0614141.812345.1000",
    "TagLength": 96,
    "EpcClass": "sgtin-96",
    "RawBinary": "001100000111010000100101011110111111011100011001010011100100000000000000000000000000001111101000",
    "GS1ElementString": "(01)80614141123458(21)1000",
    "Filter": 3,
    "CompanyPrefixLength": 7,
    "GS1Companyprefix": "0614141",
    "ItemReferenceIndicatorDigit": "812345",
    "CheckDigit": "8",
    "Gtin": "80614141123458",
    "SerialNumber": 1000,
    "Raw": "MHQle/cZTkAAAAPo"
}

Tag Types

This API call provides metadata information to all EPC schemes. This could be interesting if somebody is doing any further processing of EPC data.

Request

GET http://convert.erfideo.com/api/epc/types?KEY=Your apikey

Output Values

A list of all EPC classes with this values:

Parameter Description
Type Type of this EPC class.
FullName Internal full name of this EPC class
DisplayName Display name of this EPC class
TagLength Tag length of this EPC class.
HeaderByte Header byte of this EPC class.
Fields A list of data provided by this EPC class.
Field/Name Name of the field.
Field/DisplayName Display name of the field.
Field/Type Type of the field (String or Integer).
Field/MinValue Min value of the field, if it is a number.
Field/MaxValue Max value of the field, if it is a number.
Field/Regex Regex of the field, if it is a string.
Field/Create Create - for future use.
Field/ReadOnly Read only if the field is changeable with the update API call.

Response (JSON)

[
    {
    "Type": "Sgtin96",
    "FullName": "Connect.Core.Tag.Sgtin96",
    "DisplayName": "SGTIN 96 - Serialized Global Trade Item Number",
    "TagLength": 96,
    "HeaderByte": 48,
    "Fields": [
        {
            "Name": "HexValue",
            "DisplayName": "Hex Value",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": false
        },
        {
            "Name": "PureIdentityUri",
            "DisplayName": "Pure Identity Uri",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": false
        },
        {
            "Name": "TagUri",
            "DisplayName": "Tag Uri",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": false
        },
        {
            "Name": "TagLength",
            "DisplayName": "Tag Length",
            "Type": "Int",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": true
        },
        {
            "Name": "EpcClass",
            "DisplayName": "Epc Class",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": true
        },
        {
            "Name": "RawBinary",
            "DisplayName": "Raw Binary",
            "Type": "Int",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": true
        },
        {
            "Name": "GS1ElementString",
            "DisplayName": "GS1 Element String",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": false
        },
        {
            "Name": "Filter",
            "DisplayName": "Filter",
            "Type": "Int",
            "MinValue": 0,
            "MaxValue": 7,
            "Regex": null,
            "Create": true,
            "ReadOnly": false
        },
        {
            "Name": "CompanyPrefixLength",
            "DisplayName": "Company Prefix Length",
            "Type": "Int",
            "MinValue": 6,
            "MaxValue": 12,
            "Regex": null,
            "Create": true,
            "ReadOnly": false
        },
        {
            "Name": "GS1Companyprefix",
            "DisplayName": "GS1 Company Prefix",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": "[0-9]{6,12}",
            "Create": false,
            "ReadOnly": false
        },
        {
            "Name": "ItemReferenceIndicatorDigit",
            "DisplayName": "Item Reference",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": "[0-9]{1,7}",
            "Create": false,
            "ReadOnly": false
        },
        {
            "Name": "CheckDigit",
            "DisplayName": "Check Digit",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": null,
            "Create": false,
            "ReadOnly": true
        },
        {
            "Name": "Gtin",
            "DisplayName": "Gtin",
            "Type": "String",
            "MinValue": 0,
            "MaxValue": 0,
            "Regex": "[0-9]{8,14}",
            "Create": true,
            "ReadOnly": false
        },
        {
            "Name": "SerialNumber",
            "DisplayName": "Serial Number",
            "Type": "Int",
            "MinValue": 0,
            "MaxValue": 274877906943,
            "Regex": null,
            "Create": true,
            "ReadOnly": false
        }
    ]
},
... other EPC classes
]

Generate Random EPC

This API call can be used to create a random EPC for one of the supported EPC schemes for testing purposes.

GET http://convert.erfideo.com/api/epc/generate/?<EPC scheme>&KEY=Your apikey

Input Parameters

Parameter Description
EPC scheme Use one of the supported EPC schemes: Dod-96, Gdti-96, Gdti-174, Giai-96, Giai-202, Gid-96, Grai-96, Grai-170, Gsrn-96, Gsrnp-96, Sgln-96, Sgln-195, Sgtin-96, Sgtin-198, Sscc-96
KEY Your API Key.

Sample Request

GET http://convert.erfideo.com/api/epc/generate?type=Sgtin-96&KEY=Your apikey

Response (JSON)

{
    "EpcClass": "sgtin-96",
    "GS1ElementString": "(01)01794362595609(21)368430199",
    "HexValue": "3018AF3B00FD7A0015F5CC77",
    "Gtin": "01794362595609",
    "ItemReferenceIndicatorDigit": "0259560",
    "SerialNumber": 368430199,
    "TagLength": 96,
    "CompanyPrefixLength": 6,
    "CheckDigit": "9",
    "GS1Companyprefix": "179436",
    "Filter": 0,
    "PureIdentityUri": "urn:epc:id:sgtin:179436.0259560.368430199",
    "Raw": "MBivOwD9egAV9cx3",
    "RawBinary": "001100000001100010101111001110110000000011111101011110100000000000010101111101011100110001110111",
    "TagUri": "urn:epc:tag:sgtin-96:0.179436.0259560.368430199"
}