Skip to main content
POST
Add a custom timeline note or event to an order

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.

Path Parameters

id
string<uuid>
required

Body

application/json
event_type
string
required

Operator-defined event type label.

message
string

Optional message body.

metadata
object

Free-form caller metadata.

Response

Timeline event added

The response is of type object.