GET /v1/delivery/jobs/{ref}/events
GET /v1/delivery/jobs/{ref}/events
| Scope | Idempotency-Key | Operation ID |
|---|---|---|
delivery.read | — | listJobEvents |
Customer-safe event history, ordered by sequence.
One entry per change of customer-facing status; steps that do not change what a
customer sees (offers, relay handoffs) are left out. event_type is the catalogue
type where there is one.
Request
Signed with your API credential: see Authentication.
| Parameter | In | Required | Description |
|---|---|---|---|
ref | path | Yes | Public reference of a delivery job or Bulk child. Pattern ^DX-[0-9A-HJKMNP-TV-Z]{8}$. |
Responses
200
The history.
| Field | Type | Required | Description |
|---|---|---|---|
delivery_reference | string | Yes | Public reference of a delivery job or Bulk child. Pattern ^DX-[0-9A-HJKMNP-TV-Z]{8}$. |
items | array of object | Yes | |
items[].sequence | integer | Yes | |
items[].event_type | string or null | Yes | |
items[].customer_status | string | Yes | |
items[].occurred_at | string, date-time | Yes |
401
Unknown, revoked or wrong-environment credential, bad signature, or expired session.
The error envelope: code, message, detail, request_id.
403
Tenant access denied (existence is not disclosed), insufficient scope, MFA/step-up required, partner blocked or module disabled.
The error envelope: code, message, detail, request_id.
429
Rate limit reached; honour Retry-After.
The error envelope: code, message, detail, request_id.
500
Unexpected failure. Only code and request_id are returned.
The error envelope: code, message, detail, request_id.