API reference

Events. 1 operations.

1 of them work. Each needs a bearer token with its scope. All operations.

Operations

GET/api/v1/eventsevents.listevents.read

Parameters

`after`query	stringThe cursor of the page: the next of the page before; the oldest event when left out.
`limit`query	integerThe most events in the page: 1 to 500; 100 when left out.
`types`query	stringThe event types to read, separated by commas; every type the token may read when left out.

Answer

EventsPage

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/events

Schemas 3

APIEvent

APIEvent is one change the store made.

`at`required	string (date-time)
`data`	map of string
`id`required	string
`object`required	EventObject
`type`required	string

EventObject

EventObject is what an event is about: its kind and its id. An order's id is its number, a product's its slug, a variant's its SKU, a customer's its email.

`id`required	string
`type`required	string

EventsPage

EventsPage is a page of events and where the next one starts.

`events`required	array of APIEvent
`gap`required	boolean
`more`required	boolean
`next`required	string

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.