curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.edi.stateset.com/v1/adapters/plan' \
--header "Authorization: Bearer $EDI_API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_type": "string",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_type": "string",
"occurred_at": "2026-08-31T14:22:05Z",
"payload": {},
"signature": "sha256:9f86d081884c7d659a2feaa0c55ad015"
}'
[
{
"adapter": "string",
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_type": "string",
"event_type": "string",
"operation": "string",
"target_system": "string"
}
]
Plans the back-end actions a canonical event would trigger across every…
Planned back-end actions
POST
/
v1
/
adapters
/
plan
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.edi.stateset.com/v1/adapters/plan' \
--header "Authorization: Bearer $EDI_API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_type": "string",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_type": "string",
"occurred_at": "2026-08-31T14:22:05Z",
"payload": {},
"signature": "sha256:9f86d081884c7d659a2feaa0c55ad015"
}'
[
{
"adapter": "string",
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_type": "string",
"event_type": "string",
"operation": "string",
"target_system": "string"
}
]
Request body
EdiEvent
string
required
string
required
string
required
string
required
string (date-time)
required
object
required
string,null
Ed25519 signature (hex) over the canonical event message. Absent when signing is disabled. See [
crate::signing].Response
AdapterAction[] — each element:
string
required
string
required
string
required
string
required
string
required
Human-readable operation, e.g.
create sales order.string
required
Status codes
| Code | Meaning |
|---|---|
200 | Planned back-end actions |
422 | Unparseable event |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.edi.stateset.com/v1/adapters/plan' \
--header "Authorization: Bearer $EDI_API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_type": "string",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_type": "string",
"occurred_at": "2026-08-31T14:22:05Z",
"payload": {},
"signature": "sha256:9f86d081884c7d659a2feaa0c55ad015"
}'
[
{
"adapter": "string",
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_type": "string",
"event_type": "string",
"operation": "string",
"target_system": "string"
}
]
Last modified on October 20, 2026