v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
Events

Channel Events

Retrieve ChannelEvents from all subscriped Channels. Channel Events are various different actions which occure on the channel side.

Such as

  • New Orders
  • Order status changes
  • Order Address changes
  • Changes in listing process

These API route will deliver a list of unacknolaged events in a FIFO order. Each event is delivered At-Least-Once. There is no garantee about uniquness. You may see Events with an identical payload multiply time.

After retrieving a list of Events by GET /v2/seller/event you have to acknowlage these Events using the id property of each single event with DELETE /v2/seller/event. Unacknolaged events are getting invisible for 5 minutes. After these time a unacknowlaged event is getting visible again.

get/v2/seller/event

Query parameters

createdAfterstring date-time

List all Events chreated after a specified time. If no createdAfter parameter all unacknolaged events are returned.

eventTypeFilterstring

Will only return results matching events given in eventTypeFilter Parameter. Use a comma separated list to filter for multiply events.

channelstring

Will only return results matching given channel.

Response

List of unacknowledged channel and system events

Example response

{
  "eventList": [
    {
      "id": "5cde84164d811d00144581f8",
      "createdAt": "2019-07-01T12:43:23+00:00",
      "event": {
        "channel": "MYBESTDEALCOMDE",
        "sellerId": "4711",
        "message": "More beer available"
      }
    }
  ]
}