Skip to main content
POST
/
epcis
/
api
/
2.0
/
capture
Capture EPCIS events
curl --request POST \
  --url https://www.closient.com/epcis/api/2.0/capture \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "epcisBody": {}
}
'
{
  "captureID": "<string>",
  "createdEvents": 2
}

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.

Authorizations

X-API-Key
string
header
required

Body

application/json

EPCIS 2.0 Capture request body (GS1 EPCIS 2.0 §6.2 — EPCISDocument).

The wire format is a JSON-LD EPCISDocument whose epcisBody carries an eventList array of one or more events. The example below is a minimal ObjectEvent shipping a single SGTIN — production payloads typically include bizTransactionList, sourceList, destinationList, and (for FSMA 204 captures) ilmd KDEs in the cbvmda: namespace.

epcisBody
Epcisbody · object
required

EPCIS 2.0 document body containing an eventList array of one or more events (per GS1 EPCIS 2.0 §6.2). At least one event is required. Each event must include type, eventTime, eventTimeZoneOffset, and the per-type required fields specified in §7.3.

Response

Created

Response returned after a successful capture (HTTP 201).

captureID
string
required

Unique identifier for this capture batch (UUIDv4). Mirrors the captureID concept from GS1 EPCIS 2.0 §8.2.1 — useful for client-side correlation and idempotency tracking, though duplicate-event rejection uses the per-event hash from §8.4 rather than this batch ID.

createdEvents
integer
required

Number of events successfully created. Returned only on the all-or-nothing 201 path; equals the length of the submitted eventList. If any event fails validation or hits the duplicate-hash guard, the endpoint returns the appropriate 400 / 409 error instead — note that events earlier in the batch may already be committed (each event captures in its own atomic transaction).

Required range: x >= 1