Skip to main content
POST
Record customer acknowledgment of a revised order or invoice

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json

The body is of type object.

Response

Acknowledgment recorded (or already up-to-date). Returns { acknowledged: true, revision_count: N, customer_acknowledged_revision: N } on first acknowledgment, or { already_acknowledged: true, revision_count: N, customer_acknowledged_revision: N } if the revision was already acknowledged.

acknowledged
boolean

True when this call recorded the acknowledgment. Absent (see already_acknowledged) when the revision was already up-to-date.

already_acknowledged
boolean

True when customer_acknowledged_revision already equaled revision_count before this call (idempotent success).

revision_count
integer

Current value of orders.revision_count.

customer_acknowledged_revision
integer

Value of orders.customer_acknowledged_revision after this call.