Skip to main content
GET
/
epcis
/
api
/
2.0
/
traceability
/
lots
/
{lot_id}
/
fda-export
Enqueue an FSMA 204 traceability export for one lot
curl --request GET \
  --url https://www.closient.com/epcis/api/2.0/traceability/lots/{lot_id}/fda-export \
  --header 'X-API-Key: <api-key>'
{
  "job_short_id": "<string>",
  "status": "pending",
  "lot_id": "<string>",
  "direction": "forward",
  "format": "xlsx",
  "requested_at": "<string>",
  "signed_download_url": "<string>"
}

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

Path Parameters

​
lot_id
string
required

Short ID of the ProductLot to export — 22-character shortuuid encoding of the lot's UUID primary key.

Required string length: 22

Query Parameters

​
direction
enum<string>
default:both

Traversal direction. forward (downstream) walks where the lot has been shipped; backward (upstream) walks where the lot came from; both does a full bidirectional traversal (default — matches the FSMA 204 § 1.1455(c) shape).

Available options:
forward,
backward,
both
​
format
enum<string>
default:xlsx

Output file format. Only xlsx (Excel workbook) is currently supported; matches the FDA Sortable Spreadsheet template.

Available options:
xlsx

Response

OK

202 response body for an enqueued lot traceability export.

​
job_short_id
string
required

Short ID of the TraceabilityExportJob — a 22-character shortuuid encoding of the underlying UUID primary key. Poll the same endpoint with the same lot to observe status transitions, or look it up directly on the compliance dashboard at /compliance/.

Required string length: 22
​
status
enum<string>
required

Lifecycle status of the export job. Progresses pending → processing → delivered (terminal success) or pending → processing → failed (terminal failure). A delivered job is immutable except for download_count.

Available options:
pending,
processing,
delivered,
failed
​
lot_id
string
required

Short ID of the ProductLot whose traceability chain was queued — echoed from the path parameter for client-side correlation. 22-character shortuuid encoding.

Required string length: 22
​
direction
enum<string>
required

Traversal direction. forward walks downstream CriticalTrackingEvents (where did this lot ship?); backward walks upstream CTEs (where did this lot come from?); both does a full bidirectional traversal — the default for FSMA 204 § 1.1455(c) requests.

Available options:
forward,
backward,
both
​
format
enum<string>
required

Output file format. Only xlsx (Excel workbook) is currently supported; matches the FDA Sortable Spreadsheet template format.

Available options:
xlsx
​
requested_at
string
required

ISO-8601 / RFC 3339 timestamp marking when the job was enqueued. Used by the FSMA 204 § 1.1455(c) 24-hour SLA: delivered_at - requested_at must stay under 24h for the org to remain in compliance.

​
signed_download_url
string | null

Short-lived signed S3 URL for the rendered XLSX, populated only when the job has reached status='delivered'. Always null while pending or processing, and on terminal failed status.