GS1

GS1 Discovery API

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

GitHub OpenAPI

Operations 30

OPTIONS / Query server settings, EPCIS version(s) and related vocabularies/standards.
GET / Returns the list of top level resources available for this EPCIS repository.
OPTIONS /capture Discover the settings of the capture interface.
OPTIONS /capture/{captureID} Query the metadata of the capture job endpoint.
OPTIONS /events Query metadata for the EPCIS events endpoint.
OPTIONS /events/{eventID} Query metadata for the endpoint to access an individual EPCIS event.
OPTIONS /eventTypes Query metadata for the EPCIS event types endpoint.
GET /eventTypes Returns all EPCIS event types currently available in the EPCIS repository.
OPTIONS /eventTypes/{eventType} Query metadata of the EPCIS event type endpoint.
OPTIONS /eventTypes/{eventType}/events Query the metadata of the endpoint to access EPCIS events by event type.
OPTIONS /epcs Query metadata related to the electronic product codes endpoint.
OPTIONS /epcs/{epc} Query metadata of the electronic product code.
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).
OPTIONS /bizSteps Query metadata related to the business steps endpoint.
OPTIONS /bizSteps/{bizStep} Query metadata of the endpoint to access an individual business step.
OPTIONS /bizSteps/{bizStep}/events Query the metadata of the endpoint to access EPCIS events by business step.
OPTIONS /bizLocations Query the metadata related to the business locations endpoint.
OPTIONS /bizLocations/{bizLocation} Query the metadata of the endpoint to access an individual business location.
OPTIONS /bizLocations/{bizLocation}/events Query the metadata of the endpoint to access EPCIS events by business location.
OPTIONS /readPoints Query the metadata related to the read points endpoint.
OPTIONS /readPoints/{readPoint} Query the metadata of the endpoint to access an individual read point.
OPTIONS /readPoints/{readPoint}/events Query the metadata of the endpoint to access EPCIS events by read point.
OPTIONS /dispositions Query the metadata related to the dispositions endpoint.
OPTIONS /dispositions/{disposition} Query the metadata of the endpoint to access an individual disposition.
OPTIONS /dispositions/{disposition}/events Query the metadata of the endpoint to access EPCIS events by disposition.
OPTIONS /queries Query the metadata of the EPCIS queries endpoint.
OPTIONS /queries/{queryName} Query the metadata of the named queries endpoint.
OPTIONS /queries/{queryName}/subscriptions Query the metadata of the subscriptions endpoint.
OPTIONS /queries/{queryName}/subscriptions/{subscriptionID} Query the metadata of the endpoint for an individual subscription.
OPTIONS /queries/{queryName}/events Query the metadata of the EPCIS events query result endpoint.

Documentation

📖
Documentation
https://www.gs1.org/standards/epcis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gs1/refs/heads/main/openapi/gs1-discovery-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gs1/refs/heads/main/json-schema/gs1-epcis-json-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gs1/refs/heads/main/json-schema/gs1-epcis-query-schema.json

Other Resources

🔗
Specification
https://ref.gs1.org/standards/epcis/2.0.1/
🔗
Artefacts
https://ref.gs1.org/standards/epcis/artefacts
🔗
Vocabulary
https://ref.gs1.org/cbv/
🔗
SourceCode
https://github.com/gs1/EPCIS

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gs1-discovery-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

gs1-discovery-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.1
  title: EPCIS 2.0 REST Bindings Discovery API
  license:
    name: Apache2
  description: 'Endpoints to obtain information about the endpoint, such as EPCIS and CBV versions or custom vocabularies.

    '
tags:
- name: Discovery
  description: 'Endpoints to obtain information about the endpoint, such as EPCIS and CBV versions or custom vocabularies.

    '
paths:
  /:
    options:
      tags:
      - Discovery
      summary: Query server settings, EPCIS version(s) and related vocabularies/standards.
      description: '`OPTIONS` on the root path gives the client an overview of the server''s EPCIS-related configurations.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
    get:
      tags:
      - Discovery
      summary: Returns the list of top level resources available for this EPCIS repository.
      parameters:
      - $ref: '#/components/parameters/GS1-Extensions'
      - $ref: '#/components/parameters/GS1-EPCIS-Min'
      - $ref: '#/components/parameters/GS1-EPCIS-Max'
      - $ref: '#/components/parameters/GS1-CBV-Min'
      - $ref: '#/components/parameters/GS1-CBV-Max'
      description: 'This endpoint returns all the top-level resources currently available in the repository.

        '
      responses:
        '200':
          $ref: '#/components/responses/200SupportedTopLevel'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /capture:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Discover the settings of the capture interface.
      description: 'The `OPTIONS` method is used as a discovery service for `/capture`. It describes

        - which EPCIS and CBV versions are supported,

        - the EPCIS and CBV extensions,

        - the maximum payload size as count of EPCIS events (`GS1-EPCIS-Capture-Limit` header) or as a maximum payload size in bytes (`GS1-EPCIS-Capture-File-Size-Limit` header)

        - what the server will do if an error occurred during capture (`GS1-Capture-Error-Behaviour` header).

        The list of headers is not exhaustive. It only describes the functionality specific to EPCIS 2.0.

        '
      responses:
        '204':
          $ref: '#/components/responses/204CaptureEndpointDiscovery'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /capture/{captureID}:
    parameters:
    - in: path
      name: captureID
      example: id9261379075
      description: A unique value identifying a capture job generated by the server.
      required: true
      schema:
        type: string
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the capture job endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used for a given capture job.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /events:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata for the EPCIS events endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204WritableResourcesDiscovery'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /events/{eventID}:
    parameters:
    - $ref: '#/components/parameters/EventID'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata for the endpoint to access an individual EPCIS event.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /eventTypes:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata for the EPCIS event types endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
    get:
      tags:
      - Discovery
      summary: Returns all EPCIS event types currently available in the EPCIS repository.
      parameters:
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/PerPage'
      - $ref: '#/components/parameters/GS1-Extensions'
      - $ref: '#/components/parameters/GS1-EPCIS-Min'
      - $ref: '#/components/parameters/GS1-EPCIS-Max'
      - $ref: '#/components/parameters/GS1-CBV-Min'
      - $ref: '#/components/parameters/GS1-CBV-Max'
      description: EPCIS event types specify the schema of an event. This endpoint returns the 5 standard event types as well as any custom event types supported by this repository.
      responses:
        '200':
          $ref: '#/components/responses/200SupportedEventTypes'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /eventTypes/{eventType}:
    parameters:
    - $ref: '#/components/parameters/EventType'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata of the EPCIS event type endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /eventTypes/{eventType}/events:
    parameters:
    - $ref: '#/components/parameters/EventType'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access EPCIS events by event type.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /epcs:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata related to the electronic product codes endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /epcs/{epc}:
    parameters:
    - $ref: '#/components/parameters/EPC'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata of the electronic product code.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /epcs/{epc}/events:
    parameters:
    - $ref: '#/components/parameters/EPC'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access EPCIS events by EPC in a URN or constrained GS1 Digital Link form (URL encoded).
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /bizSteps:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata related to the business steps endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /bizSteps/{bizStep}:
    parameters:
    - $ref: '#/components/parameters/BizStep'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query metadata of the endpoint to access an individual business step.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /bizSteps/{bizStep}/events:
    parameters:
    - $ref: '#/components/parameters/BizStep'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access EPCIS events by business step.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /bizLocations:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata related to the business locations endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /bizLocations/{bizLocation}:
    parameters:
    - $ref: '#/components/parameters/BizLocation'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access an individual business location.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /bizLocations/{bizLocation}/events:
    parameters:
    - $ref: '#/components/parameters/BizLocation'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access EPCIS events by business location.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /readPoints:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata related to the read points endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /readPoints/{readPoint}:
    parameters:
    - $ref: '#/components/parameters/ReadPoint'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access an individual read point.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /readPoints/{readPoint}/events:
    parameters:
    - $ref: '#/components/parameters/ReadPoint'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access EPCIS events by read point.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /dispositions:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata related to the dispositions endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /dispositions/{disposition}:
    parameters:
    - $ref: '#/components/parameters/GS1-Extensions'
    - $ref: '#/components/parameters/Disposition'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access an individual disposition.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /dispositions/{disposition}/events:
    parameters:
    - $ref: '#/components/parameters/Disposition'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the endpoint to access EPCIS events by disposition.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /queries:
    options:
      tags:
      - Discovery
      summary: Query the metadata of the EPCIS queries endpoint.
      parameters:
      - $ref: '#/components/parameters/GS1-Extensions'
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204WritableResourcesDiscovery'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /queries/{queryName}:
    parameters:
    - $ref: '#/components/parameters/QueryName'
    options:
      parameters:
      - $ref: '#/components/parameters/GS1-Extensions'
      tags:
      - Discovery
      summary: Query the metadata of the named queries endpoint.
      description: 'EPCIS 2.0 supports a number of custom headers to describe custom vocabularies and support multiple versions

        of EPCIS and CBV. The `OPTIONS` method allows the client to discover which vocabularies and EPCIS and CBV

        versions are used.

        '
      responses:
        '204':
          $ref: '#/components/responses/204RemovableResourcesDiscovery'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /queries/{queryName}/subscriptions:
    parameters:
    - $ref: '#/components/parameters/QueryName'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the subscriptions endpoint.
      description: 'The `OPTIONS` method is used as a discovery service for query subscriptions.

        '
      responses:
        '204':
          $ref: '#/components/responses/204WritableResourcesDiscovery'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /queries/{queryName}/subscriptions/{subscriptionID}:
    parameters:
    - $ref: '#/components/parameters/QueryName'
    - in: path
      name: subscriptionID
      required: true
      example: df5a33e3-5aa3-4403-ae01-99b83234e27b
      schema:
        $ref: '#/components/schemas/subscriptionID'
    options:
      parameters:
      - $ref: '#/components/parameters/GS1-Extensions'
      tags:
      - Discovery
      summary: Query the metadata of the endpoint for an individual subscription.
      description: 'The `OPTIONS` method is used to discover capabilities for a query subscription.

        '
      responses:
        '204':
          $ref: '#/components/responses/204SubscriptionEndpointDiscovery'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '500':
          $ref: '#/components/responses/500ImplementationException'
  /queries/{queryName}/events:
    parameters:
    - $ref: '#/components/parameters/QueryName'
    - $ref: '#/components/parameters/GS1-Extensions'
    options:
      tags:
      - Discovery
      summary: Query the metadata of the EPCIS events query result endpoint.
      description: 'The `OPTIONS` method is used to discover capabilities for named queries. It describes which EPCIS and CBV

        versions are used in the query result supported as well as EPCIS and CBV extensions.

        '
      responses:
        '204':
          $ref: '#/components/responses/204DefaultDiscoveryResponse'
        '401':
          $ref: '#/components/responses/401UnauthorizedRequest'
        '403':
          $ref: '#/components/responses/403ClientUnauthorized'
        '404':
          $ref: '#/components/responses/404ResourceNotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '414':
          $ref: '#/components/responses/414URLTooLong'
        '500':
          $ref: '#/components/responses/500ImplementationException'
components:
  parameters:
    GS1-Extensions:
      in: header
      name: GS1-Extensions
      description: 'Specific EPCIS or CBV extensions supported (e.g., for FIT).

        '
      schema:
        $ref: '#/components/schemas/GS1-Extensions'
      style: simple
      explode: true
    EPC:
      description: An electronic product code value.
      example: urn:epc:id:sgtin:0614141.107346.2018
      required: true
      in: path
      name: epc
      schema:
        type: string
        format: uri
    BizStep:
      description: A business step value.
      example: urn:epcglobal:cbv:bizstep:receiving
      required: true
      in: path
      name: bizStep
      schema:
        type: string
        format: uri
    EventType:
      name: eventType
      in: path
      example: ObjectEvent
      required: true
      description: 'Names of EPCIS event types.

        '
      schema:
        oneOf:
        - $ref: '#/components/schemas/EPCISEventTypes'
    Disposition:
      description: A disposition value.
      example: in_progress
      required: true
      in: path
      name: disposition
      schema:
        type: string
        format: uri
    PerPage:
      in: query
      name: perPage
      schema:
        $ref: '#/components/schemas/PerPage'
    QueryName:
      in: path
      name: queryName
      description: The name of an EPCIS event query.
      required: true
      schema:
        $ref: '#/components/schemas/QueryName'
    BizLocation:
      description: A business location value.
      example: urn:epc:id:sgln:0012345.11111.0
      required: true
      in: path
      name: bizLocation
      schema:
        type: string
        format: uri
    GS1-EPCIS-Min:
      in: header
      name: GS1-EPCIS-Min
      description: 'The lowest EPCIS version supported.

        '
      schema:
        $ref: '#/components/schemas/GS1-EPCIS-Min'
    EventID:
      name: eventID
      in: path
      description: 'The ID of an EPCIS event. An EPCIS event I

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gs1/refs/heads/main/openapi/gs1-discovery-api-openapi.yml