Events
Two important components of SCX are seller and channel events. Seller events are emitted by a seller integration such as JTL-Wawi, while channel events are emitted by a channel integration. Such events are actions created by an actor (either a seller or a channel) and may be handled by connected integrations.
A channel integration needs to handle the various seller events provided by GET /v1/channel/events in order to create new listings, and mark orders as paid or shipped.
We recommend calling the seller event endpoint at regular intervals (such as once a minute) and consuming all events available.
When an event is consumed, it must be acknowledged by calling DELETE /v1/channel/events. Otherwise, the event will be transmitted again after a timeout.
An event will be transmitted a maximum of 10 times. Afterwards it will be marked as a dead-letter and will not be transmitted again.
Examples
Receive Seller events
// GET /v1/channel/event
{
"eventList": [
{
"id": "63623b997d2c89a4e3e9f3c7",
"event": {
"channel": "WAWIDEV001",
"sellerId": "EA4590MitName"
},
"createdAt": "2022-11-02T09:42:49+00:00",
"type": "Seller:Meta.SellerAttributesUpdateRequest"
},
{
"id": "636280fd498628e9f0b28984",
"event": {
"sellerId": "1",
"offerId": 822,
"channelCategoryId": "CAT7",
"quantity": "0",
"taxPercent": "19",
"priceList": [
{
"id": "B2C",
"quantityPriceList": [
{
"quantity": "1",
"amount": "19.99",
"currency": "EUR"
}
]
}
],
"title": "Fahrrad Halterung",
"channelAttributeList": [
{
"attributeId": "WAWI-61427_number_category",
"value": "954",
"group": "0"
}
],
"sku": "843609"
},
"createdAt": "2022-11-02T14:38:53+00:00",
"type": "Seller:Offer.New"
}
]
}Acknowledge events
Acknowledge previous received events.
// DELETE /v1/channel/event
{
"eventIdList": [
"63623b997d2c89a4e3e9f3c7",
"636280fd65a66c4430ec0d67"
]
}