> ## 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. # 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. ## OpenAPI ````yaml /openapi/openapi-epcis.json post /epcis/api/2.0/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. 61 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__ ``` 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 | Those windows are per key. Your plan also caps each organization per hour, across every key, login and session acting for it: 100 requests on Free (or while a subscription is lapsed), 10,000 on Business. While a subscription is lapsed, any method other than `GET`, `HEAD` and `OPTIONS` returns `403`. 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). ## Versioning and Deprecation Every response from an operation in this document carries `Closient-API-Version` (its `info.version`). An operation marked `deprecated` answers with `Deprecation: @` ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)), `Sunset: ` once a retirement date is set ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)), and `Link` entries for `rel="deprecation"`, `rel="sunset"` and `rel="successor-version"`. After its sunset it answers `410 Gone` naming the replacement. Policy: https://docs.closient.com/api-versioning 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/events: post: tags: - EPCIS 2.0 summary: Capture one EPCIS event description: >- 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. operationId: epcis_capture_single_event parameters: [] requestBody: required: true description: A single EPCIS event, with its own ``@context``. content: application/json: schema: oneOf: - type: object title: ObjectEvent properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - ObjectEvent epcList: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string action: type: string enum: - ADD - OBSERVE - DELETE required: - '@context' - type - eventTime - eventTimeZoneOffset - epcList - action - type: object title: TransactionEvent properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - TransactionEvent epcList: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string action: type: string enum: - ADD - OBSERVE - DELETE required: - '@context' - type - eventTime - eventTimeZoneOffset - epcList - action - type: object title: AggregationEvent properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - AggregationEvent parentID: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string childEPCs: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string action: type: string enum: - ADD - OBSERVE - DELETE required: - '@context' - type - eventTime - eventTimeZoneOffset - action anyOf: - required: - parentID - required: - childEPCs - type: object title: AssociationEventAdd properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - AssociationEvent parentID: type: string maxLength: 255 pattern: ^[^\x00]{0,255}$ minLength: 1 childEPCs: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string minItems: 1 action: type: string enum: - ADD required: - '@context' - type - eventTime - eventTimeZoneOffset - parentID - childEPCs - action - type: object title: AssociationEventDelete properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - AssociationEvent parentID: type: string maxLength: 255 pattern: ^[^\x00]{0,255}$ minLength: 1 childEPCs: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string action: type: string enum: - DELETE required: - '@context' - type - eventTime - eventTimeZoneOffset - parentID - action - type: object title: AssociationEventObserve properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - AssociationEvent parentID: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string childEPCs: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string minItems: 1 action: type: string enum: - OBSERVE required: - '@context' - type - eventTime - eventTimeZoneOffset - childEPCs - action - type: object title: TransformationEvent properties: '@context': description: >- The JSON-LD context: a URI, an array of them or inline definitions, or an object. oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: array minItems: 1 items: oneOf: - type: string minLength: 1 pattern: ^[^\x00]{1,}$ - type: object - type: object minProperties: 1 eventTime: format: date-time type: string eventTimeZoneOffset: type: string minLength: 1 maxLength: 6 pattern: ^[^\x00]{1,6}$ examples: - '+00:00' bizStep: type: string enum: - '' - 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 description: >- 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. disposition: type: string enum: - '' - 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 description: >- 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. type: type: string enum: - TransformationEvent inputEPCList: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string outputEPCList: type: array items: maxLength: 255 pattern: ^[^\x00]{0,255}$ type: string required: - '@context' - type - eventTime - eventTimeZoneOffset anyOf: - required: - inputEPCList - required: - outputEPCList responses: '201': description: OK 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. Location: schema: type: string format: uri description: URL of the newly captured event. content: application/json: schema: type: object '400': 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. '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: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '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' '409': 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. '413': 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. '415': 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. '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: 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 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.