A GTIN (Global Trade Item Number) & UPC (Universal Price Code) Generation and Validation Library in Elixir under the GS1 specification.
- GTIN-12 (UPC-A): this is a 12-digit number used primarily in North America
- GTIN-8 (EAN/UCC-8): this is an 8-digit number used predominately outside of North America
- GTIN-13 (EAN/UCC-13): this is a 13-digit number used predominately outside of North America
- GTIN-14 (EAN/UCC-14 or ITF-14): this is a 14-digit number used to identify trade items at various packaging levels
- Supports GTIN-8, GTIN-12 (UPC-12), GTIN-13 (GLN), GTIN-14, GSIN, SSCC codes
- Generate GTIN
- Check GTIN validity
- Lookup GS1 country prefix
WARNING 1.0.0
contains breaking changes from 0.4.0
def deps do
[{:ex_gtin, "~> 1.0.0"}]
end
- Check GTIN codes
iex> ExGtin.validate("6291041500213")
{:ok, "GTIN-13"}
iex> ExGtin.validate("6291041500214")
{:error, "Invalid Code"}
ex> ExGtin.validate!("6291041500213")
"GTIN-13"
Pass GTIN numbers in as a String, Number or an Array
iex> number = [6, 2, 9, 1, 0, 4, 1, 5, 0, 0, 2, 1,3]
iex> ExGtin.validate(number)
{:ok, "GTIN-13"}
iex> number = 6_291_041_500_213
iex> ExGtin.validate(number)
{:ok, "GTIN-13"}
- Generate GTIN codes
iex> ExGtin.generate("629104150021")
{:ok, "6291041500213"}
iex> ExGtin.generate!("629104150021")
"6291041500213"
- Lookup GS1 Prefix
iex> ExGtin.Validation.find_gs1_prefix_country("53523235")
{:ok, "GS1 Malta"}
- String
iex> ExGtin.validate("6291041500213")
{:ok, "GTIN-13"}
- Array of Integers
iex> ExGtin.validate([6, 2, 9, 1, 0, 4, 1, 5, 0, 0, 2, 1, 3])
{:ok, "GTIN-13"}
- Integer
iex> ExGtin.validate(6291041500213)
{:ok, "GTIN-13"}
Integers with leading zeros may not process properly
Documentation can be found at https://hexdocs.pm/ex_gtin on HexDocs.
Run tests with
mix test
Run test coverage
MIX_ENV=test mix coveralls
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
When making pull requests, please be sure to update the CHANGELOG.md with the corresponding changes. Please make sure that all tests pass and that the static analysis checker credo
is run.
Run static code analysis
mix credo
Generate Docs
mix docs
This project is sponsored by KickinEspresso
We use SemVer for versioning. For the versions available, see the tags on this repository.
Please refer to the Code of Conduct for details
Please refer to the Security for details
This project is licensed under the MIT License - see the LICENSE.md file for details
mix hex.publish