Capture one EPCIS event
curl --request POST \
--url https://www.closient.com/epcis/api/2.0/events \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"@context": "<string>",
"eventTime": "2023-11-07T05:31:56Z",
"eventTimeZoneOffset": "+00:00",
"type": "ObjectEvent",
"epcList": [
"<string>"
]
}
'import requests
url = "https://www.closient.com/epcis/api/2.0/events"
payload = {
"@context": "<string>",
"eventTime": "2023-11-07T05:31:56Z",
"eventTimeZoneOffset": "+00:00",
"type": "ObjectEvent",
"epcList": ["<string>"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
'@context': '<string>',
eventTime: '2023-11-07T05:31:56Z',
eventTimeZoneOffset: '+00:00',
type: 'ObjectEvent',
epcList: ['<string>']
})
};
fetch('https://www.closient.com/epcis/api/2.0/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/epcis/api/2.0/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'@context' => '<string>',
'eventTime' => '2023-11-07T05:31:56Z',
'eventTimeZoneOffset' => '+00:00',
'type' => 'ObjectEvent',
'epcList' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/epcis/api/2.0/events"
payload := strings.NewReader("{\n \"@context\": \"<string>\",\n \"eventTime\": \"2023-11-07T05:31:56Z\",\n \"eventTimeZoneOffset\": \"+00:00\",\n \"type\": \"ObjectEvent\",\n \"epcList\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/epcis/api/2.0/events")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"@context\": \"<string>\",\n \"eventTime\": \"2023-11-07T05:31:56Z\",\n \"eventTimeZoneOffset\": \"+00:00\",\n \"type\": \"ObjectEvent\",\n \"epcList\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/epcis/api/2.0/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"@context\": \"<string>\",\n \"eventTime\": \"2023-11-07T05:31:56Z\",\n \"eventTimeZoneOffset\": \"+00:00\",\n \"type\": \"ObjectEvent\",\n \"epcList\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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"
}EPCIS 2.0
Capture one EPCIS event
Synchronous capture of a single EPCIS 2.0 event (GS1 EPCIS 2.0 REST binding, POST /events). The body is one event object carrying its own @context. It goes through the same capture pipeline as POST /capture — validation, duplicate detection, indexing, webhooks — and answers 201 Created with a Location header naming the stored event and the event as stored.
400 for a body that is not JSON, lacks @context, or is an invalid event; 409 when the organization already captured the same event; 413 (with GS1-EPCIS-Capture-File-Size-Limit) for a body over 1048576 bytes; 415 for a Content-Type other than application/json or application/ld+json; 403 when the organization has used its capture allowance.
Caller must hold an OWNER or MANAGER membership on the target organization.
POST
/
epcis
/
api
/
2.0
/
events
Capture one EPCIS event
curl --request POST \
--url https://www.closient.com/epcis/api/2.0/events \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"@context": "<string>",
"eventTime": "2023-11-07T05:31:56Z",
"eventTimeZoneOffset": "+00:00",
"type": "ObjectEvent",
"epcList": [
"<string>"
]
}
'import requests
url = "https://www.closient.com/epcis/api/2.0/events"
payload = {
"@context": "<string>",
"eventTime": "2023-11-07T05:31:56Z",
"eventTimeZoneOffset": "+00:00",
"type": "ObjectEvent",
"epcList": ["<string>"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
'@context': '<string>',
eventTime: '2023-11-07T05:31:56Z',
eventTimeZoneOffset: '+00:00',
type: 'ObjectEvent',
epcList: ['<string>']
})
};
fetch('https://www.closient.com/epcis/api/2.0/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/epcis/api/2.0/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'@context' => '<string>',
'eventTime' => '2023-11-07T05:31:56Z',
'eventTimeZoneOffset' => '+00:00',
'type' => 'ObjectEvent',
'epcList' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/epcis/api/2.0/events"
payload := strings.NewReader("{\n \"@context\": \"<string>\",\n \"eventTime\": \"2023-11-07T05:31:56Z\",\n \"eventTimeZoneOffset\": \"+00:00\",\n \"type\": \"ObjectEvent\",\n \"epcList\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/epcis/api/2.0/events")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"@context\": \"<string>\",\n \"eventTime\": \"2023-11-07T05:31:56Z\",\n \"eventTimeZoneOffset\": \"+00:00\",\n \"type\": \"ObjectEvent\",\n \"epcList\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/epcis/api/2.0/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"@context\": \"<string>\",\n \"eventTime\": \"2023-11-07T05:31:56Z\",\n \"eventTimeZoneOffset\": \"+00:00\",\n \"type\": \"ObjectEvent\",\n \"epcList\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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"
}Authorizations
APIKeyHeaderAuthOAuthTokenAuthCookieGatedSessionAuth
Body
application/json
A single EPCIS event, with its own @context.
- ObjectEvent
- TransactionEvent
- AggregationEvent
- AggregationEvent
- AssociationEventAdd
- AssociationEventDelete
- AssociationEventObserve
- TransformationEvent
- TransformationEvent
The JSON-LD context: a URI, an array of them or inline definitions, or an object.
Minimum string length:
1Pattern:
^[^\x00]{1,}$Required string length:
1 - 6Pattern:
^[^\x00]{1,6}$Example:
"+00:00"
Available options:
ObjectEvent Maximum string length:
255Pattern:
^[^\x00]{0,255}$Available options:
ADD, OBSERVE, DELETE A bare CBV 2.0 business step. A namespaced extension term (example:myStep or a full URI) is also accepted; it is left out of this enum.
Available options:
accepting, arriving, assembling, collecting, commissioning, consigning, cooling, creating_class_instance, cycle_counting, decommissioning, departing, destroying, disassembling, dispensing, encoding, entering_exiting, harvesting, holding, inspecting, installing, killing, loading, other, packing, picking, receiving, removing, repackaging, repairing, replacing, reserving, retail_selling, sampling, sensor_reporting, shipping, staging_outbound, stock_taking, stocking, storing, transporting, unloading, unpacking, void_shipping A bare CBV 2.0 disposition. A namespaced extension term (example:myDisposition or a full URI) is also accepted; it is left out of this enum.
Available options:
active, available, completeness_inferred, completeness_verified, conformant, container_closed, container_open, damaged, destroyed, dispensed, disposed, encoded, expired, in_progress, in_transit, inactive, mismatch_class, mismatch_instance, mismatch_quantity, needs_replacement, no_pedigree_match, non_conformant, non_sellable_other, partially_dispensed, recalled, reserved, retail_sold, returned, sellable_accessible, sellable_not_accessible, stolen, unavailable, unknown Response
OK
The response is of type object.