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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GS1

GS1 Subscriptions API

EPCIS 2.0 supports query subscriptions using Webhooks or Websockets.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 4 operations across 2 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.

4 operations 2 paths 85 schemas 1 DELETE2 GET1 POST

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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 4

EPCIS 2.0 supports query subscriptions using Webhooks or Websockets.

GET
/queries/{queryName}/subscriptions
Returns active subscriptions with the option to use pagination if needed.
6 params → 200400401403404406500
POST
/queries/{queryName}/subscriptions
Creates a query subscription.
5 params body → 201401403404406415500
GET
/queries/{queryName}/subscriptions/{subscriptionID}
Returns the details of a subscription. This method is useful to verify if a subscription is still active.
5 params → 200401403404406500
DELETE
/queries/{queryName}/subscriptions/{subscriptionID}
Unsubscribes a client by deleting the query subscription.
unsubscribe 2 params → 204401403404406500

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), AbstractQuerySubscriptionResponse (7 properties), Event (7 properties). Each schema is shown below with its type and property counts.

queryResults
object
3 properties 2 required
error-reason
ObjectEvent
ilmd
object
attribute
object
2 properties 1 required
component
GS1-Extensions
object
bizStep
sensorElement
object
2 properties 1 required
eventID
QueryStreamSubscription
object
If no query schedule is specified, the client must explicitly set stream to true. This restriction is to prevent clients from accidentally subscribing to EPCIS…
1 property 1 required
GS1-Next-Page-Token-Expires
string
GS1-EPCIS-Max
GS1-Signature
string
Used to sign events sent by the repository to subscribers. The choice of signature type is implementation specific but examples would be using HMAC with SHA-25…
AbstractQuerySubscriptionResponse
object
This schema contains shared features of EPCIS query subscriptions response.
7 properties 3 required
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…
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…
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…
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
AbstractQuerySubscription
object
This schema contains shared features of EPCIS query subscriptions. If the schema is used in a response, the secret should not be fully revealed.
3 properties 2 required
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
dest
string
Callback URL to receive EPCIS resources and errors.
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.
uri
string
QueryScheduleSubscription
object
A scheduled query subscription is a time-based query execution scheduler. EPCIS 2.0 scheduled queries are scheduled in the same manner as cron jobs. For exampl…
2 properties 1 required
persistentDisposition
LDContext
JSON-LD @context.
vocabularyElement
object
3 properties 1 required
measurementType
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.
subscriptionID
string
The ID of a WebHook subscription.
string
string
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

gs1-subscriptions-api-openapi.yml Raw ↑

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 Events API
AE Profile APIs.io
GS1 Queries API
AE Profile APIs.io
GS1 Top Level API
AE Profile APIs.io
#Subscription
← Back to G APIs
API Details
ID
gs1:gs1-subscriptions-api
Base URL
https://id.gs1.org
Docs
https://ref.gs1.org/standards/epcis/
Provider
GS1
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gs1-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gs1-subscriptions-api"

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

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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