v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

Events

Seller Events

API Endpoint to retrieve events from registered sellers. Events are various different actions which may occur when sellers are processing channel data such as orders. After receiving a seller events response, each event in the response needs to be acknowledged using PATCH /v1/channel/event request. Unacknowledged events will be delivered again after a period of time.

get/v1/channel/event

Query parameters

createdAfterstring date-time

List seller events created after a specified time. If no createdAfter parameter is set, all unacknowledged events will be returned.

eventTypeFilterstring

Optional parameter to request only a subset of available Seller Events. We recommend requesting only events by using the eventTypeFilter parameter to process only events which can be processed by the current channel implementation.

Response

Seller events retrieved

Example response

{
  "eventList": [
    {
      "id": "5cde84164d811d00144581f8",
      "createdAt": "2019-07-01T12:43:23+00:00",
      "clientVersion": "1.11.0.6",
      "event": {
        "sellerId": "4711",
        "orderList": [
          {
            "sellerId": "4711",
            "orderId": "43523-43432-43532",
            "shippingComplete": true,
            "shippingItems": [
              {
                "carrier": "DHL",
                "trackingNumber": "23435833543343222322",
                "trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=23435833543343222322",
                "returnTracking": {
                  "carrier": "DHL",
                  "trackingNumber": "432353833232443222322",
                  "trackingUrl": "https://www.dhl.de/de/home/tracking.html?AWB=432353833232443222322"
                },
                "shippedAt": "2019-01-13T12:00:00+00:00",
                "orderItemIdList": [
                  {
                    "orderItemId": "5437233"
                  }
                ],
                "shippedFrom": {
                  "city": "Köln",
                  "country": "DE",
                  "postcode": "51107"
                }
              }
            ],
            "channel": "MYBESTDEALCOMDE"
          }
        ]
      }
    }
  ]
}