About the GRP                                                      

The GS1 Registry Platform (GRP) is a central part of GS1’s data services strategy, focused on enabling user-centric consumable services built on global standards and ready to be implemented into systems using APIs.

This page provides technical information and links to relevant documentation, to enact services and applications built upon the GRP APIs.  This includes links to the latest versions of API specifications as well as quick access to the complete list of Error and Status codes for these GRP APIs.

Detailed information about the applied validation rules and available language tags or code list values (product categories, country of sale etc.) are now embedded in the API specifications.

For more information about the MO Digital Journey to connect and share data with the GRP, see: https://mozone.gs1.org/mo-digital-journey/mo-digital-journey-overview

The GS1 Customer Service team is available if you have further questions: helpdesk@gs1.org, or https://support.gs1.org

GRP API specifications and the API best practices documentation are located on the MO Zone here:
https://mozone.gs1.org/gs1-registries-technology/

The APIs offered to eligible GS1 MOs enable the following high-level capabilities:

Data IN

  • Management of Licences

  • Management of GTINs

  • Management of GLNs

  • Management of Links (L2SD)

Data OUT

  • Retrieval of Licence information (MO-internally)

  • Verified by GS1 for GTINs, GLNs and other keys (for example, SSCC, GRAI, and so on)

  • Link information- as part of Verified by GS1 response

Following are the links you can use to access the GRP API specifications and the API best practices document.

API documents have lists of Error codes and Status codes specific to each document, however for a quick reference, a full list of these can also be found below.

ERROR CODES

Error Codes for all GRP APIs

Error codes | Description

E001              Invalid attribute/key length

E002              Invalid Check digit / Invalid Check characters

E003              Invalid characters /attribute type/ key structure or format/ numeric value out of range

E004              Incorrect key: GS1 Prefix does not exist or is not assigned

E005              Incorrect number: GS1 Prefix reserved for special use

E006              GS1 Prefix is assigned or delegated to another MO

E007              GS1 Key type is invalid or not supported

E008              Invalid GS1 Prefix length

E009              Invalid or missing language/locale code

E010              Invalid or missing value for mandatory field

E011              Invalid or missing code

E012              Licence key not within MO range

E013              Invalid URL format

E014              URL scheme is not HTTP/HTTPS

E015              Invalid file format

E016              Invalid content-length

E017              Duplicate value given

E018              GTIN/Licence already exists in the registry

E019              Path and body parameters do not match

E020              Could not perform dependent request or RPC

E021              Invalid Batch size/ Batch size of {x} is too large; max allowed is 1000 / Payload must be included and contain at least one element

E022              Licence cannot be deleted until all associated identification keys or links are deleted

E023              GTIN registration rights have been transferred to GS1 <MO Name> at the request of the global brand owner

E024              Delegated prefix cannot overlap with an existing licence or Delegated Prefix

E025              Date Issued invalid format

E026              Delegated Prefix must be assigned to a different MO

E027              <Licence key> licence overlaps with one or more existing licences, or with another licence in the same payload batch

E028              Number of points is invalid or start and end points are not correct

E029              GLN record can include only one type - line, circle or polygon - in a geoShape array occurrence

E040              Licence is inactive; licence status must be active

E041              Invalid order of qualifiers; invalid item counts/out of sequence item counts for ITIP key

E042              Link context scope must contain 1 and only 1 gs1:defaultLink

 

Some error codes are reserved for one or more defined prefixes and return a specific message when encountered. These are referred to as ‘granular return messages’ and are detailed below:

E030                         Restricted Circulation keys; (Prefix range: 020-029, 040-049, 200-299)

Message Text           This key is not supported by GS1 for use in open global supply chains. It is for special applications in restricted environments and is not used for other purposes.

E031                         Used for General Manager. Keys for the EPC General Identifier (GID) scheme; (Prefix: 951)

Message Text           This key is reserved for RFID applications. It is not used for other purposes.

E032                         Used for demonstrations and examples of the GS1 system; (Prefix: 952) 

Message Text           This key is not supported by GS1 for use in open global supply chains. It is for demonstrations and is not used for other purposes.

E033                         Serial publications (ISSN); (Prefix:977)

Message Text           This key is reserved for serial publications (such as magazines). It is not used for other purposes.

E034                         Bookland (ISBN); (Prefixes: 978,979) 

Message Text           This key is reserved for books. It is not used for other purposes.

E035                         Refund receipts; (Prefix: 980) 

Message Text           This key is not supported by GS1 for use in open global supply chains. It is reserved for refund receipts and is not used for other purposes.

E036                         GS1 coupon identification for common currency areas; (Prefix range: 981-983)        

Message Text           This key is not supported by GS1 for use in open global supply chains. It is reserved for coupons and is not used for other purposes.

E037                         GS1 coupon identification; (Prefix range: 990-999)     

Message Text           This key is not supported by GS1 for use in open global supply chains. It is reserved for coupons and is not used for other purposes.

E038                         Number from prefix range not assigned to an MO and reserved for future use; (various prefix ranges)

Message Text           This key is not supported by GS1 for use in open global supply chains.

E039                         Number from MO or GO prefix range, but no licence found in GS1 Registry Platform; (various prefix ranges)

Message Text           We cannot guarantee that this key is supported by GS1 for use in open global supply chains. Please contact GS1 for further assistance if you believe that this is a GS1 key.

STATUS CODES
Status Codes for all GRP APIs (except Links APIs)
Code | Meaning | Description

1        CREATED          Record created successfully

2        MODIFIED        Record modified successfully

4        DELETED          Record deleted successfully

5        FAILED             The operation failed due to validation errors or other reasons

7        PENDING          The batch operation has been accepted and is pending processing