v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Order

Add custom event to order

Add a custom event to an order's event timeline. Rate limited to 3 requests per second per order with a max payload of 1KB.

post/v1/order/{id}/events

Path parameters

idstring required

Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

Example:ord_1234567890

Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

Request body

namestring required
timestampstring nullable

The event time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'.

payloadobject nullable

Response

OK