Document detail

Document drill-down detail

GET /v1/documents/{id}

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/documents/{id}' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "acknowledgment": "string",
  "document": {
    "control_number": "string",
    "correlation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "direction": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "processed_at": "2026-08-31T14:22:05Z",
    "reference": "ORD-10042",
    "status": "pending",
    "transaction_set": "string"
  },
  "parsed": null,
  "raw": "string",
  "segments": [
    {}
  ],
  "validation_error": "string",
  "validation_issues": []
}

Path parameters

id · string · required

Document audit ID

Response

DocumentDetail

acknowledgment · string

Generated 997 / TA1 / CONTRL acknowledgment for inbound documents.

document · DocumentRecord · required

Show DocumentRecord

control_number · string · required

correlation_id · string

Ties this record to the request’s logs (and, for outbound, its delivery). Defaulted for log lines written before correlation tracking existed.

direction · string · required

inbound or outbound.

id · string · required

partner_id · string · required

processed_at · string (date-time) · required

reference · string · required

Human-readable handle: PO number, shipment ID, invoice number.

status · string · required

accepted, rejected, or sent.

transaction_set · string · required

Transaction set ID, e.g. 850.

parsed · object

Canonical parsed payload returned by the transaction parser.

raw · string · required

Full raw interchange or outbound wire that produced this record.

segments · object[]

X12 segment list when available. Empty for EDIFACT until message-level segment rendering is promoted into the EDIFACT crate API.

validation_error · string

Partner-guide or parser failure when the document was rejected.

validation_issues · crate.partners.ValidationIssue[]

Structured guide violations behind validation_error, with 999-grade segment/element positions — everything a partner needs to fix the file.

Status codes

Code	Meaning
200	Document drill-down detail
403	Admin credential required
404	Unknown document

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/documents/{id}' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "acknowledgment": "string",
  "document": {
    "control_number": "string",
    "correlation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "direction": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "processed_at": "2026-08-31T14:22:05Z",
    "reference": "ORD-10042",
    "status": "pending",
    "transaction_set": "string"
  },
  "parsed": null,
  "raw": "string",
  "segments": [
    {}
  ],
  "validation_error": "string",
  "validation_issues": []
}