EPCIS

Query the EPCIS 2.0 event store.

Search your captured supply-chain events using EPCIS 2.0 query parameters, returned as an EPCISQueryDocument.

Eight parameters are supported: EQ_bizStep, EQ_disposition, EQ_eventType, MATCH_epc, EQ_bizLocation, EQ_readPoint, GE_eventTime and LT_eventTime. EQ_bizStep, EQ_disposition and MATCH_epc accept |-separated values to match any of several; the other parameters take a single value. Matching is exact against the value as captured (a short-form shipping does not match the CBV URI form, and vice versa). Any other parameter returns 400 epcis_query_invalid rather than being silently ignored, so a typo fails loudly instead of widening your result set.

Results are newest-first and only ever include events your own workspace captured and approved. A response caps at 1000 events; if there were more, X-TracePass-Result-Truncated: true is set — narrow the window with GE_eventTime / LT_eventTime to page through.

A workspace with the epcisCaptureEnabled flag turned off gets 403 epcis_query_not_available. Where query is not provisioned for the deployment the response is 503 epcis_query_node_unavailable. Counts as one read.

get/api/v1/epcis/events

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/epcis/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.tracepass.eu/api/oauth/authorize, token URL https://app.tracepass.eu/api/oauth/token, scopes: passports:read)

Query parameters

EQ_bizStepstring

Match events with this bizStep. |-separate to match any of several, e.g. shipping|receiving.

GE_eventTimestring date-time

Match events at or after this time.

MATCH_epcstring

Match events referencing this EPC.

Response

EPCIS query result.

Changes

No recorded changes to this operation across all 1 revision of this API.