Field-level diff between two guide versions.

Guide diff

GET /v1/partners/{id}/guide/diff

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/partners/{id}/guide/diff' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

{
  "changes": [
    {
      "after": {},
      "before": {},
      "change": "string",
      "path": "string"
    }
  ],
  "from_version": 1,
  "to_version": 1
}

Path parameters

id · string · required

Partner ID

Query parameters

from · integer (int32) · required

Base version

to · integer (int32) · required

Target version

Response

GuideDiff

changes · DiffEntry[] · required

Show DiffEntry

after · object

before · object

change · string · required

added, removed, or changed.

path · string · required

Dotted path, e.g. validation.rules[0].mandatory.

from_version · integer (int32) · required

Minimum: 0.

to_version · integer (int32) · required

Minimum: 0.

Status codes

Code	Meaning
200	Guide diff
404	Unknown version

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

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/partners/{id}/guide/diff' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

{
  "changes": [
    {
      "after": {},
      "before": {},
      "change": "string",
      "path": "string"
    }
  ],
  "from_version": 1,
  "to_version": 1
}