> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Query EPCIS events of one event type

> ``GET /events`` restricted to one event type (GS1 EPCIS 2.0 REST binding, ``/eventTypes/{eventType}/events``). Takes every ``GET /events`` query parameter; the path's event type is ANDed onto them. Same ``EPCISQueryDocument`` body and ``Link`` pagination. Results are scoped to the caller's organization.



## OpenAPI

````yaml /openapi/openapi-epcis.json get /epcis/api/2.0/eventTypes/{eventType}/events
openapi: 3.1.0
info:
  title: EPCIS 2.0 API
  version: 2.0.0
  description: >
    EPCIS 2.0 event capture and query, scoped to lot-level supply chain
    traceability and recall containment — not warehouse logistics, cold-chain
    monitoring, or business-document exchange.


    Roles claimed: EPCIS 2.0 capture interface server, EPCIS 2.0 data. Not
    claimed: EPCIS 2.0 query interface server; Query callback interface
    implementation.


    Binding: REST over HTTPS. Serialization: JSON and JSON-LD. Vocabulary: GS1
    CBV 2.0. XML and EPCIS 1.2 are out of scope by design, not a pending
    decision.


    30 of 63 official EPCIS 2.0 REST operations are served, all within the roles
    claimed above. Full capability declaration:
    https://docs.closient.com/guides/epcis-conformance


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /epcis/api/2.0/eventTypes/{eventType}/events:
    get:
      tags:
        - EPCIS 2.0
      summary: Query EPCIS events of one event type
      description: >-
        ``GET /events`` restricted to one event type (GS1 EPCIS 2.0 REST
        binding, ``/eventTypes/{eventType}/events``). Takes every ``GET
        /events`` query parameter; the path's event type is ANDed onto them.
        Same ``EPCISQueryDocument`` body and ``Link`` pagination. Results are
        scoped to the caller's organization.
      operationId: epcis_event_type_events
      parameters:
        - in: query
          name: eventType
          schema:
            description: >-
              Filter by EPCIS event type. One of ``ObjectEvent``,
              ``AggregationEvent``, ``TransactionEvent``,
              ``TransformationEvent``, or ``AssociationEvent`` per GS1 EPCIS 2.0
              §7.3.
            allOf:
              - $ref: '#/components/schemas/EventTypeEnum'
          required: false
          description: >-
            Filter by EPCIS event type. One of ``ObjectEvent``,
            ``AggregationEvent``, ``TransactionEvent``, ``TransformationEvent``,
            or ``AssociationEvent`` per GS1 EPCIS 2.0 §7.3.
        - in: query
          name: GE_eventTime
          schema:
            description: >-
              Events with ``eventTime >= this value`` (inclusive lower bound).
              ISO-8601 / RFC 3339 with timezone offset per GS1 EPCIS 2.0
              §8.2.7.2.
            title: Ge Eventtime
            format: date-time
            type: string
          required: false
          description: >-
            Events with ``eventTime >= this value`` (inclusive lower bound).
            ISO-8601 / RFC 3339 with timezone offset per GS1 EPCIS 2.0 §8.2.7.2.
        - in: query
          name: LT_eventTime
          schema:
            description: >-
              Events with ``eventTime < this value`` (exclusive upper bound).
              ISO-8601 / RFC 3339 with timezone offset per GS1 EPCIS 2.0
              §8.2.7.2.
            title: Lt Eventtime
            format: date-time
            type: string
          required: false
          description: >-
            Events with ``eventTime < this value`` (exclusive upper bound).
            ISO-8601 / RFC 3339 with timezone offset per GS1 EPCIS 2.0 §8.2.7.2.
        - in: query
          name: EQ_bizStep
          schema:
            description: >-
              Filter by exact CBV business step. Accepts either the bare CBV
              token (``shipping``) or the URN-prefixed form
              (``urn:epcglobal:cbv:bizstep:shipping``); matching is exact-string
              against what was captured. The CBV 2.0 vocabulary is extensible —
              vendor-specific URNs are valid input.
            title: Eq Bizstep
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Filter by exact CBV business step. Accepts either the bare CBV token
            (``shipping``) or the URN-prefixed form
            (``urn:epcglobal:cbv:bizstep:shipping``); matching is exact-string
            against what was captured. The CBV 2.0 vocabulary is extensible —
            vendor-specific URNs are valid input.
        - in: query
          name: EQ_disposition
          schema:
            description: >-
              Filter by exact CBV disposition (state of objects after the
              event). Accepts either the bare CBV token (``in_transit``) or the
              URN-prefixed form (``urn:epcglobal:cbv:disp:in_transit``);
              matching is exact-string against what was captured. The CBV 2.0
              vocabulary is extensible — vendor-specific URNs are valid input.
            title: Eq Disposition
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Filter by exact CBV disposition (state of objects after the event).
            Accepts either the bare CBV token (``in_transit``) or the
            URN-prefixed form (``urn:epcglobal:cbv:disp:in_transit``); matching
            is exact-string against what was captured. The CBV 2.0 vocabulary is
            extensible — vendor-specific URNs are valid input.
        - in: query
          name: EQ_readPoint
          schema:
            description: >-
              Filter by exact read point URI (where the event was observed) per
              GS1 EPCIS 2.0 §7.4.2 / CBV 2.0 §10. Accepts the GS1 Digital Link
              form (``https://id.gs1.org/414/{gln}``) or the legacy SGLN URN
              (``urn:epc:id:sgln:{company}.{location}.{extension}``); matching
              is exact-string against what was captured.
            title: Eq Readpoint
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Filter by exact read point URI (where the event was observed) per
            GS1 EPCIS 2.0 §7.4.2 / CBV 2.0 §10. Accepts the GS1 Digital Link
            form (``https://id.gs1.org/414/{gln}``) or the legacy SGLN URN
            (``urn:epc:id:sgln:{company}.{location}.{extension}``); matching is
            exact-string against what was captured.
        - in: query
          name: EQ_bizLocation
          schema:
            description: >-
              Filter by exact business location URI (where the objects logically
              are after the event) per GS1 EPCIS 2.0 §7.4.2. Accepts the GS1
              Digital Link form or the legacy SGLN URN — same encoding as
              ``EQ_readPoint``. Matching is exact-string against what was
              captured.
            title: Eq Bizlocation
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Filter by exact business location URI (where the objects logically
            are after the event) per GS1 EPCIS 2.0 §7.4.2. Accepts the GS1
            Digital Link form or the legacy SGLN URN — same encoding as
            ``EQ_readPoint``. Matching is exact-string against what was
            captured.
        - in: query
          name: MATCH_epc
          schema:
            description: >-
              Filter events referencing this single EPC (per GS1 EPCIS 2.0
              §8.2.7.2 MATCH_epc). Searches ``epcList``, ``childEPCs``,
              ``inputEPCList``, and ``outputEPCList`` simultaneously. Accepts
              either GS1 Digital Link
              (``https://id.gs1.org/01/{gtin14}/10/{lot}[/21/{serial}]``) or the
              legacy SGTIN URN form.
            title: Match Epc
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Filter events referencing this single EPC (per GS1 EPCIS 2.0
            §8.2.7.2 MATCH_epc). Searches ``epcList``, ``childEPCs``,
            ``inputEPCList``, and ``outputEPCList`` simultaneously. Accepts
            either GS1 Digital Link
            (``https://id.gs1.org/01/{gtin14}/10/{lot}[/21/{serial}]``) or the
            legacy SGTIN URN form.
        - in: query
          name: MATCH_anyEPC
          schema:
            description: >-
              Comma-separated list of EPCs; matches events referencing any one
              of them (per GS1 EPCIS 2.0 §8.2.7.2 MATCH_anyEPC). Each token is
              trimmed before matching. Use ``MATCH_epc`` for a single EPC.
            title: Match Anyepc
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Comma-separated list of EPCs; matches events referencing any one of
            them (per GS1 EPCIS 2.0 §8.2.7.2 MATCH_anyEPC). Each token is
            trimmed before matching. Use ``MATCH_epc`` for a single EPC.
        - in: query
          name: EQ_action
          schema:
            description: >-
              Filter by action. Per GS1 EPCIS 2.0 §7.4.2 the only valid values
              are ``ADD``, ``OBSERVE``, or ``DELETE`` (uppercase). Blank action
              is reserved for ``TransformationEvent`` and cannot be filtered on.
            allOf:
              - $ref: '#/components/schemas/ActionEnum'
          required: false
          description: >-
            Filter by action. Per GS1 EPCIS 2.0 §7.4.2 the only valid values are
            ``ADD``, ``OBSERVE``, or ``DELETE`` (uppercase). Blank action is
            reserved for ``TransformationEvent`` and cannot be filtered on.
        - in: query
          name: perPage
          schema:
            default: 30
            description: >-
              Maximum number of events to return per page (1-100, default 30).
              When more results are available the response carries a ``Link``
              header with ``rel="next"`` — request that URL to fetch the next
              page.
            maximum: 100
            minimum: 1
            title: Perpage
            type: integer
          required: false
          description: >-
            Maximum number of events to return per page (1-100, default 30).
            When more results are available the response carries a ``Link``
            header with ``rel="next"`` — request that URL to fetch the next
            page.
        - in: query
          name: nextPageToken
          schema:
            description: >-
              Cursor for the next page. The ``Link`` header's next-page URL
              already carries it; opaque to the client — do not construct or
              modify.
            title: Nextpagetoken
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Cursor for the next page. The ``Link`` header's next-page URL
            already carries it; opaque to the client — do not construct or
            modify.
        - in: path
          name: eventType
          schema:
            description: >-
              An EPCIS event type: ``ObjectEvent``, ``AggregationEvent``,
              ``TransactionEvent``, ``TransformationEvent`` or
              ``AssociationEvent``. Any other value is ``404``.
            title: Eventtype
            type: string
          required: true
          description: >-
            An EPCIS event type: ``ObjectEvent``, ``AggregationEvent``,
            ``TransactionEvent``, ``TransformationEvent`` or
            ``AssociationEvent``. Any other value is ``404``.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EPCISQueryDocumentSchema'
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
            Link:
              schema:
                type: string
              description: >-
                URL of the next page with ``rel="next"`` (RFC 8288), carrying
                the original query plus ``nextPageToken``. Absent on the last
                page: no ``rel="next"`` means there is nothing more.
            GS1-Next-Page-Token-Expires:
              schema:
                format: date-time
                type: string
              description: >-
                Time until which the ``nextPageToken`` in ``Link`` is guaranteed
                valid. Present only alongside ``Link``. Closient cursors are
                stateless and are also honoured after it.
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '406':
          description: Error
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '500':
          description: Error
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    EventTypeEnum:
      description: |-
        EPCIS 2.0 event type discriminator (the JSON-LD ``type`` field).

        Mirrors ``EventType``. Values match the
        GS1 EPCIS 2.0 specification (ISO/IEC 19987:2024 §7.3 — Event Types)
        exactly: each event sent on the wire MUST carry one of these five
        type tokens. They are PascalCase in the spec and on the wire (the
        JSON-LD form drops the ``epcis:`` prefix used in XML).
      enum:
        - ObjectEvent
        - AggregationEvent
        - TransactionEvent
        - TransformationEvent
        - AssociationEvent
      title: EventTypeEnum
      type: string
    ActionEnum:
      description: |-
        EPCIS 2.0 ``action`` field — what the event did to its EPCs.

        Mirrors ``Action``. Per GS1 EPCIS 2.0
        §7.4.2 (Common Event Fields → action), the only valid wire values
        are the three uppercase tokens below. Blank / absent ``action`` is
        valid for ``TransformationEvent`` only (no enum represents that —
        omit the field instead).
      enum:
        - ADD
        - OBSERVE
        - DELETE
      title: ActionEnum
      type: string
    EPCISQueryDocumentSchema:
      description: '200 response body for ``GET /events``: a JSON-LD ``EPCISQueryDocument``.'
      examples:
        - '@context':
            - https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld
          epcisBody:
            queryResults:
              eventList:
                - '@context':
                    - >-
                      https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld
                  action: ADD
                  bizStep: commissioning
                  disposition: active
                  epcList:
                    - /01/00012345678906/21/SERIAL001
                  eventID: urn:uuid:f47ac10b-58cc-4372-a567-0e02b2c3d479
                  eventTime: '2026-08-25T03:40:00+00:00'
                  eventTimeZoneOffset: '+00:00'
                  recordTime: '2026-08-25T03:40:05+00:00'
                  type: ObjectEvent
          type: EPCISQueryDocument
      properties:
        '@context':
          description: JSON-LD context; the EPCIS 2.0 context.
          items:
            type: string
          title: '@Context'
          type: array
        type:
          description: Always ``EPCISQueryDocument``.
          title: Type
          type: string
        epcisBody:
          $ref: '#/components/schemas/EPCISBodySchema'
          description: Envelope holding ``queryResults.eventList``.
      required:
        - '@context'
        - type
        - epcisBody
      title: EPCISQueryDocumentSchema
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
    EPCISBodySchema:
      examples:
        - queryResults:
            eventList:
              - '@context':
                  - >-
                    https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld
                action: ADD
                bizStep: commissioning
                disposition: active
                epcList:
                  - /01/00012345678906/21/SERIAL001
                eventID: urn:uuid:f47ac10b-58cc-4372-a567-0e02b2c3d479
                eventTime: '2026-08-25T03:40:00+00:00'
                eventTimeZoneOffset: '+00:00'
                recordTime: '2026-08-25T03:40:05+00:00'
                type: ObjectEvent
      properties:
        queryResults:
          $ref: '#/components/schemas/EPCISQueryResultsSchema'
          description: The query results.
      required:
        - queryResults
      title: EPCISBodySchema
      type: object
    EPCISQueryResultsSchema:
      examples:
        - eventList:
            - '@context':
                - https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld
              action: ADD
              bizStep: commissioning
              disposition: active
              epcList:
                - /01/00012345678906/21/SERIAL001
              eventID: urn:uuid:f47ac10b-58cc-4372-a567-0e02b2c3d479
              eventTime: '2026-08-25T03:40:00+00:00'
              eventTimeZoneOffset: '+00:00'
              recordTime: '2026-08-25T03:40:05+00:00'
              type: ObjectEvent
      properties:
        eventList:
          description: Events on this page, in query order.
          items:
            $ref: '#/components/schemas/EPCISEventSchema'
          title: Eventlist
          type: array
      required:
        - eventList
      title: EPCISQueryResultsSchema
      type: object
    EPCISEventSchema:
      additionalProperties: true
      description: |-
        One EPCIS 2.0 event as ``serialize_event`` emits it.

        Declares only what the serializer can emit; nothing is declared on the
        strength of the standard alone. The always-emitted members are required,
        the rest are optional because the serializer omits them rather than
        emitting null. Unknown members are allowed: captured user extensions and
        the ``closient:`` input-reference extension ride on events.
        ``test_c6396_official_spec_shapes`` checks an event carrying every
        supported element against this schema, so a serializer change that emits
        an undeclared member fails there.
      examples:
        - '@context':
            - https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld
          action: ADD
          bizStep: commissioning
          disposition: active
          epcList:
            - /01/00012345678906/21/SERIAL001
          eventID: urn:uuid:f47ac10b-58cc-4372-a567-0e02b2c3d479
          eventTime: '2026-08-25T03:40:00+00:00'
          eventTimeZoneOffset: '+00:00'
          recordTime: '2026-08-25T03:40:05+00:00'
          type: ObjectEvent
      properties:
        '@context':
          description: >-
            JSON-LD context; the EPCIS 2.0 context, plus the Closient extension
            namespace when used.
          items:
            anyOf:
              - type: string
              - additionalProperties: true
                type: object
          title: '@Context'
          type: array
        eventID:
          description: >-
            URI identifying the event: ``urn:uuid:`` followed by the UUID
            assigned at capture time.
          format: uri
          title: Eventid
          type: string
        type:
          description: Event type, e.g. ObjectEvent.
          title: Type
          type: string
        eventTime:
          description: ISO-8601 time the event occurred.
          title: Eventtime
          type: string
        eventTimeZoneOffset:
          description: Offset of eventTime from UTC, e.g. +00:00.
          title: Eventtimezoneoffset
          type: string
        recordTime:
          description: ISO-8601 time the event was recorded.
          title: Recordtime
          type: string
        action:
          anyOf:
            - type: string
            - type: 'null'
          description: ADD, OBSERVE or DELETE; absent when not captured.
          title: Action
        bizStep:
          anyOf:
            - type: string
            - type: 'null'
          description: Business step identifier.
          title: Bizstep
        disposition:
          anyOf:
            - type: string
            - type: 'null'
          description: Disposition identifier.
          title: Disposition
        readPoint:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Read point, as an object with ``id``.
          title: Readpoint
        bizLocation:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Business location, as an object with ``id``.
          title: Bizlocation
        epcList:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: EPCs the event concerns.
          title: Epclist
        childEPCs:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Child EPCs of an aggregation or association.
          title: Childepcs
        parentID:
          anyOf:
            - type: string
            - type: 'null'
          description: Parent identifier of an aggregation or association.
          title: Parentid
        inputEPCList:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Transformation input EPCs.
          title: Inputepclist
        outputEPCList:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Transformation output EPCs.
          title: Outputepclist
        quantityList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Class-level quantities.
          title: Quantitylist
        childQuantityList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Child class-level quantities.
          title: Childquantitylist
        inputQuantityList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Transformation input quantities.
          title: Inputquantitylist
        outputQuantityList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Transformation output quantities.
          title: Outputquantitylist
        bizTransactionList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Business transactions.
          title: Biztransactionlist
        sourceList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Sources of the business transfer.
          title: Sourcelist
        destinationList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Destinations of the business transfer.
          title: Destinationlist
        errorDeclaration:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Declaration that the event was recorded in error.
          title: Errordeclaration
        sensorElementList:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Sensor metadata and reports.
          title: Sensorelementlist
      required:
        - '@context'
        - eventID
        - type
        - eventTime
        - eventTimeZoneOffset
        - recordTime
      title: EPCISEventSchema
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.