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 Top Level API

Endpoints to browse or retrieve information about EPCIS resources:- events- types of events- electronic product codes- business steps- business locations- read points- dispositions

GS1 Top Level 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 Top-level. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 13 operations across 13 paths, and defines 77 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.

13 operations 13 paths 77 schemas 13 GET

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 13

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

Top-level 13

Endpoints to browse or retrieve information about EPCIS resources: - events - types of events - electronic product codes - business steps - business locations - read points - disp…

GET
/events
Returns all EPCIS events available in the EPCIS repository.
62 params → 200401403406414500
GET
/eventTypes
Returns all EPCIS event types currently available in the EPCIS repository.
8 params → 200401403406500
GET
/eventTypes/{eventType}
Returns all sub-resources of an EPCIS event type.
6 params → 200400401403404406500
GET
/epcs
Returns known electronic product codes.
8 params → 200401403406500
GET
/epcs/{epc}
Returns all sub-resources of an electronic product code.
2 params → 200400401403404406500
GET
/bizSteps
Returns known business steps.
8 params → 200401403406500
GET
/bizSteps/{bizStep}
Returns all sub-resources of a business step.
2 params → 200400401403404406500
GET
/bizLocations
Returns known business locations.
8 params → 200401403406500
GET
/bizLocations/{bizLocation}
Returns all sub-resources of a business location.
3 params → 200400401403404406500
GET
/readPoints
Returns known read points.
8 params → 200401403406500
GET
/readPoints/{readPoint}
Returns all sub-resources of a read point.
3 params → 200400401403404406500
GET
/dispositions
Returns known dispositions.
8 params → 200401403406500
GET
/dispositions/{disposition}
Returns all sub-resources of a disposition.
2 params → 200400401403404406500

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are sensorReport (24 properties), sensorMetadata (8 properties), Event (7 properties), epcisQueryDocument (6 properties). Each schema is shown below with its type and property counts.

error-reason
queryResults
object
3 properties 2 required
ObjectEvent
ilmd
object
attribute
object
2 properties 1 required
component
GS1-Extensions
object
bizStep
sensorElement
object
2 properties 1 required
eventID
GS1-Next-Page-Token-Expires
string
GS1-EPCIS-Max
errorDeclaration
object
3 properties 1 required
certificationInfo
bizTransaction-type
resultsBody
object
2 properties 1 required
disposition
BizStepCollection
object
3 properties 3 required
GS1-EPC-Format
string
sensorReport
object
24 properties 1 required
UriCollection
object
A list of items which are URIs such as EPCs or business locations.
3 properties 3 required
AggregationEvent
vocab-other-uri
string
AssociationEvent
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…
ResourceCollection
object
A collection of sub-resources that includes at least the events one (for HATEOAS discovery).
3 properties 3 required
vocab-uri
string
time
string
readPoint
object
1 property 1 required
EPCISEventTypes
The five types of EPCIS events or an extended event denoted by a URI.
EPCISXMLQueryDocument
object
A collection of EPCIS resources.
id
string
DispositionCollection
object
3 properties 3 required
uom
string
source-dest-type
hexBinary
string
sensorAlertType
EPCISEvent
EPCIS Event. It must validate against the normative EPCIS JSON Schema or EPCIS SHACL .
decimal
number
TransactionEvent
GS1-EPCIS-Version
quantityList
array
vocabularyList
array
destination
object
2 properties 2 required
sensorReportList
array
bizLocation
object
1 property 1 required
eventList
array
quantityElement
object
3 properties 1 required
bizTransaction
object
2 properties 1 required
epcisQueryDocumentBody
object
1 property 1 required
version
string
RFC7807ProblemResponseBody
object
A response as specified in [RFC 7807](https://tools.ietf.org/html/rfc7807).
5 properties 2 required
source
object
2 properties 2 required
boolean
boolean
uri
string
GS1-CBV-Min
GS1-CBV-Max
persistentDisposition
LDContext
JSON-LD @context.
measurementType
vocabularyElement
object
3 properties 1 required
epcisQueryDocument
object
6 properties 3 required
Extended-Event
GS1-CBV-XML-Format
string
sensorMetadata
object
8 properties
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…
vocabulary
object
2 properties 1 required
vocab-nonGS1WebVoc-uri
string
Event
object
7 properties 2 required
epcList
array
action
string
string
string
GS1-CBV-Version
Link
string
A pagination header link. This header works together with the perPage and nextPageToken query string parameters.
TransformationEvent

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gs1-top-level-api-openapi.yml Raw ↑

Other APIs GS1 publishes across the network.

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

This is an independent, third-party profile of GS1 Top Level 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.