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 Capture API

Endpoints to capture EPCIS events in bulk or individually.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 4 operations across 3 paths, and defines 72 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 3 paths 72 schemas 2 GET2 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 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Capture 4

Endpoints to capture EPCIS events in bulk or individually.

POST
/capture
Asynchronous capture endpoint for one or more EPCIS events.
4 params body → 202400401403406413415500
GET
/capture
Returns a list of capture jobs.
6 params → 200401403406500
GET
/capture/{captureID}
Returns information about the capture job.
4 params → 200401403404406500
POST
/events
Synchronous capture interface for a single EPCIS event.
3 params body → 201400401403406409413415

Schemas 72

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

error-reason
queryResults
object
3 properties 2 required
ObjectEvent
attribute
object
2 properties 1 required
ilmd
object
component
GS1-Extensions
object
epcisHeader
object
1 property
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
GS1-EPCIS-Capture-File-Size-Limit
integer
sensorReport
object
24 properties 1 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…
vocab-uri
string
time
string
readPoint
object
1 property 1 required
epcisDocument
object
10 properties 5 required
id
string
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
CaptureJob
object
When EPCIS events are added through the capture interface, the capture process can run asynchronously. If the payload is syntactically correct and the client i…
GS1-Capture-Error-Behaviour
string
epcisQueryDocumentBody
object
1 property 1 required
version
string
GS1-EPCIS-Capture-Limit
integer
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
persistentDisposition
vocabularyElement
object
3 properties 1 required
LDContext
JSON-LD @context.
measurementType
epcisQueryDocument
object
6 properties 3 required
Extended-Event
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
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-capture-api-openapi.yml Raw ↑

Other APIs GS1 publishes across the network.

GS1 Digital Link Resolver (id.gs1.org)
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 Subscriptions API
AE Profile APIs.io
GS1 Top Level API
AE Profile APIs.io
#Capture
← Back to G APIs
API Details
ID
gs1:gs1-capture-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-capture-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gs1-capture-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 Capture 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.