How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GS1 Discovery API

Endpoints to obtain information about the endpoint, such as EPCIS and CBV versions or custom vocabularies.

GS1 Discovery API is one of 7 APIs that GS1 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Discovery. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 30 operations across 28 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 2.0.1.

Requests are made against the base URL https://id.gs1.org.

30 operations 28 paths 27 schemas 2 GET28 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.1
Base URL
https://id.gs1.org
License
Apache2
Resource Areas
1

Paths & Operations 30

Across 28 paths, the API surfaces 30 operations — 2 GET, 28 OPTIONS. Each is listed below with its method, path, parameters, and response codes.

Discovery 30

Endpoints to obtain information about the endpoint, such as EPCIS and CBV versions or custom vocabularies.

OPTIONS
/
Query server settings, EPCIS version(s) and related vocabularies/standards.
→ 204401403406500
GET
/
Returns the list of top level resources available for this EPCIS repository.
5 params → 200401403406500
OPTIONS
/capture
Discover the settings of the capture interface.
1 param → 204401403406500
OPTIONS
/capture/{captureID}
Query the metadata of the capture job endpoint.
2 params → 204401403404406500
OPTIONS
/events
Query metadata for the EPCIS events endpoint.
1 param → 204401403406414500
OPTIONS
/events/{eventID}
Query metadata for the endpoint to access an individual EPCIS event.
2 params → 204401403404406500
OPTIONS
/eventTypes
Query metadata for the EPCIS event types endpoint.
1 param → 204401403406500
GET
/eventTypes
Returns all EPCIS event types currently available in the EPCIS repository.
8 params → 200401403406500
OPTIONS
/eventTypes/{eventType}
Query metadata of the EPCIS event type endpoint.
2 params → 204401403404406500
OPTIONS
/eventTypes/{eventType}/events
Query the metadata of the endpoint to access EPCIS events by event type.
2 params → 204401403404406414500
OPTIONS
/epcs
Query metadata related to the electronic product codes endpoint.
1 param → 204401403406500
OPTIONS
/epcs/{epc}
Query metadata of the electronic product code.
2 params → 204401403404406500
OPTIONS
/epcs/{epc}/events
Query the metadata of the endpoint to access EPCIS events by EPC in a URN or constrained GS1 Digital Link form (URL encoded).
2 params → 204401403404406414500
OPTIONS
/bizSteps
Query metadata related to the business steps endpoint.
1 param → 204401403406500
OPTIONS
/bizSteps/{bizStep}
Query metadata of the endpoint to access an individual business step.
2 params → 204401403404406500
OPTIONS
/bizSteps/{bizStep}/events
Query the metadata of the endpoint to access EPCIS events by business step.
2 params → 204401403404406414500
OPTIONS
/bizLocations
Query the metadata related to the business locations endpoint.
1 param → 204401403406500
OPTIONS
/bizLocations/{bizLocation}
Query the metadata of the endpoint to access an individual business location.
1 param → 204401403404406500
OPTIONS
/bizLocations/{bizLocation}/events
Query the metadata of the endpoint to access EPCIS events by business location.
2 params → 204401403404406414500
OPTIONS
/readPoints
Query the metadata related to the read points endpoint.
1 param → 204401403406500
OPTIONS
/readPoints/{readPoint}
Query the metadata of the endpoint to access an individual read point.
1 param → 204401403404406500
OPTIONS
/readPoints/{readPoint}/events
Query the metadata of the endpoint to access EPCIS events by read point.
2 params → 204401403404406414500
OPTIONS
/dispositions
Query the metadata related to the dispositions endpoint.
1 param → 204401403406500
OPTIONS
/dispositions/{disposition}
Query the metadata of the endpoint to access an individual disposition.
2 params → 204401403404406500
OPTIONS
/dispositions/{disposition}/events
Query the metadata of the endpoint to access EPCIS events by disposition.
2 params → 204401403404406414500
OPTIONS
/queries
Query the metadata of the EPCIS queries endpoint.
1 param → 204401403406500
OPTIONS
/queries/{queryName}
Query the metadata of the named queries endpoint.
2 params → 204401403404406500
OPTIONS
/queries/{queryName}/subscriptions
Query the metadata of the subscriptions endpoint.
2 params → 204401403404406500
OPTIONS
/queries/{queryName}/subscriptions/{subscriptionID}
Query the metadata of the endpoint for an individual subscription.
3 params → 204401403404406500
OPTIONS
/queries/{queryName}/events
Query the metadata of the EPCIS events query result endpoint.
2 params → 204401403404406414500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are RFC7807ProblemResponseBody (5 properties), TopLevelResourceCollection (3 properties), EventTypeCollection (3 properties). Each schema is shown below with its type and property counts.

LDContext
JSON-LD @context.
GS1-EPCIS-Version
GS1-Extensions
object
NextPageToken
string
Parameter that points to the next list of results when requesting a list of events that is larger than the value specified with the perPage parameter. Some tec…
GS1-CBV-XML-Format
string
EventTypeCollection
object
Event type item list
3 properties 3 required
GS1-EPCIS-Min
PerPage
integer
This parameter helps to control the amount of data returned to the client through pagination. In the case of EPCIS events, perPage specifies the maximum number…
EPCISEventTypes
The five types of EPCIS events or an extended event denoted by a URI.
GS1-Query-Min-Record-Time
string
In the context of an active query subscription, its value is set initially to initialRecordTime and then updated to the most recent execution timestamp for the…
GS1-Next-Page-Token-Expires
string
GS1-EPCIS-Max
GS1-Capture-Error-Behaviour
string
version
string
GS1-EPCIS-Capture-Limit
integer
TopLevelResourceCollection
object
3 properties 3 required
subscriptionID
string
The ID of a WebHook subscription.
RFC7807ProblemResponseBody
object
A response as specified in [RFC 7807](https://tools.ietf.org/html/rfc7807).
5 properties 2 required
GS1-Vendor-Version
QueryName
string
Unique query name.
GS1-EPC-Format
string
GS1-CBV-Version
Link
string
A pagination header link. This header works together with the perPage and nextPageToken query string parameters.
TopLevelResources
string
The seven top level resources of an EPCIS.
GS1-EPCIS-Capture-File-Size-Limit
integer
GS1-CBV-Min
GS1-CBV-Max

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gs1-discovery-api-openapi.yml Raw ↑

Other APIs GS1 publishes across the network.

GS1 Digital Link Resolver (id.gs1.org)
GS1 Capture API
GS1 Events API
GS1 Queries API
GS1 Subscriptions API
GS1 Top Level API
Where this information came from

This is an independent, third-party profile of GS1 Discovery API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.