How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

GS1 Events API

Endpoints that allow you to retrieve EPCIS events as Web resources.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

9 operations 9 paths 85 schemas 9 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 9

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

Events 9

Endpoints that allow you to retrieve EPCIS events as Web resources.

GET

/events

Returns all EPCIS events available in the EPCIS repository.

62 params → 200401403406414500

GET

/events/{eventID}

Returns an individual EPCIS event.

8 params → 200401403404406500

GET

/eventTypes/{eventType}/events

Returns EPCIS events of a given an EPCIS event type.

62 params → 200400401403404406414500

GET

/epcs/{epc}/events

Returns EPCIS events matching the specified electronic product code.

62 params → 200400401403404406414500

GET

/bizSteps/{bizStep}/events

Returns all EPCIS events related to the business step.

62 params → 200400401403404406414500

GET

/bizLocations/{bizLocation}/events

Returns all EPCIS events related to the business location.

62 params → 200400401403404406414500

GET

/readPoints/{readPoint}/events

Returns all EPCIS events related to the read point.

62 params → 200400401403404406414500

GET

/dispositions/{disposition}/events

Returns all EPCIS events related to the disposition.

63 params → 200400401403404406414500

GET

/queries/{queryName}/events

Returns EPCIS events with the option to use pagination if needed. This endpoint supports query subscriptions using WebSockets.

21 params → 101200400401403404406413

Schemas 85

The contract defines 85 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

Upgrade

string

The Upgrade and Connection headers are needed to open a Websocket for queries.

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

QueryName

string

Unique query name.

GS1-EPC-Format

string

GS1-Query-DayOfMonth

string

Specifies that the query time must have a matching day of month value. The range for this parameter is 1 through 31, inclusive.

sensorReport

object

24 properties 1 required

AggregationEvent

vocab-other-uri

string

AssociationEvent

GS1-Query-InitialRecordTime

string

Used to specify a time to constrain what resources are considered when processing a query subscription. This value only applies the first time a subscriber rec…

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…

vocab-uri

string

time

string

readPoint

object

1 property 1 required

GS1-Query-DayOfWeek

string

Specifies that the query time must have a matching day of week value. The range for this parameter is 1 through 7, inclusive, with 1 denoting Monday, 2 denotin…

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-Query-Hour

string

Specifies that the query time must have a matching hour value. The range for this parameter is 0 through 23, inclusive, with 0 denoting the hour that begins at…

EPCISXMLQueryDocument

object

A collection of EPCIS resources.

id

string

uom

string

GS1-Query-Second

string

Specifies that the query time must have a matching seconds value. The range for this parameter is 0 through 59, inclusive.

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

Connection

string

The Upgrade and Connection headers are needed to open a Websocket for queries.

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

GS1-Query-Stream

boolean

If no schedule is specified and stream is true, the standing subscription SHALL report immediately whenever a captured EPCIS event matches the query criteria.

GS1-CBV-Min

uri

string

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

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

GS1-Query-Minute

string

Specifies that the query time must have a matching minute value. The range for this parameter is 0 through 59, inclusive.

Event

object

7 properties 2 required

epcList

array

action

string

GS1-Query-Month

string

Specifies that the query time must have a matching month value. The range for this parameter is 1 through 12, inclusive.

string

string

GS1-CBV-Version

Link

string

A pagination header link. This header works together with the perPage and nextPageToken query string parameters.

TransformationEvent

GS1-Query-ReportIfEmpty

boolean

Flag to specify subscribed clients should be notified if the query result is empty.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs GS1 publishes across the network.

GS1 Digital Link Resolver (id.gs1.org)

AE Profile APIs.io

GS1 Capture API

AE Profile APIs.io

GS1 Discovery API

AE Profile APIs.io

GS1 Queries API

AE Profile APIs.io

GS1 Subscriptions API

AE Profile APIs.io

GS1 Top Level API

AE Profile APIs.io

#Event

← Back to G APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=gs1-events-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/gs1-events-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

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