--- title: "Channel Events" method: GET path: "/v2/seller/event" tags: ["Events"] --- # Channel Events `GET /v2/seller/event` 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. ## Query parameters - `createdAfter` string, date-time - `eventTypeFilter` string - `channel` string ## Response `200` List of unacknowledged channel and system events - ChannelEventList — Paginated batch of channel and system events the seller has not yet acknowledged. - `eventList` object[] - `id` string, required - `createdAt` string, date-time, required - `type` 'System:Test' | 'System:Notification' | 'Channel:ChannelDataChanged' | 'Channel:Notification' | 'Channel:Offer.ListingInProgress' | 'Channel:Offer.ListingSuccessful' | 'Channel:Offer.ListingFailed' | 'Channel:Order' | 'Channel:Order.StatusUpdate' | 'Channel:Order.AddressUpdate' | 'Channel:Order.Cancellation.Request' | 'Channel:Order.Cancellation.Accepted' | 'Channel:Order.Cancellation.Denied' | 'Channel:Order.Invoice' | 'Channel:Order.Return' | 'Channel:Order.ReturnProcessingResult' | 'Channel:Order.RefundProcessingResult' | 'Channel:Report.ProcessingFinished' | 'Channel:Report.DataComplete' | 'Channel:Report.Data' | 'Channel:MetaDataChanged' | 'Channel:Ticket', required - `event` union, required — Event payload. The concrete shape depends on the sibling `type` field. See the listed schemas below for all supported event types. - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `message` string, required - `severity` 'INFO' | 'WARNING' | 'ERROR', required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `severity` 'INFO' | 'WARNING' | 'ERROR', required - `message` string, required - `reference` object, nullable - `type` 'OFFER' | 'CHANNELOFFER' | 'ORDERITEMID', required - `id` string, required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `offerId` integer, required — Unique Offer Id to identify an Offer on a Sales Channel. - `startedAt` string, date-time, required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `offerId` integer, required — Unique Offer Id to identify an Offer on a Sales Channel. - `channelOfferId` string — Channel defined unique Offer Id to identify an Offer on a Sales Channel. - `listedAt` string, date-time, required - `listingUrl` string, nullable - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `offerId` integer, required — Unique Offer Id to identify an Offer on a Sales Channel. - `errorList` OfferListingFailedError[], required - `code` string, required — A unique error code identifier for the specific type of error encountered. - `message` string, required — A brief description of the error, intended to be human-readable and understandable. - `longMessage` string, nullable — An optional, more detailed explanation of the error, providing additional context or information that might help in understanding or resolving the issue. - `relatedAttributeId` string, nullable — An optional identifier for the attribute related to the error, which can help in pinpointing the exact cause or location of the issue. - `recommendedValue` string, nullable — An optional recommended value or action to resolve the error, providing guidance on how to correct the issue or avoid it in future attempts. - `failedAt` string, date-time, required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderStatus` 'UNACKED' | 'CREATED' | 'ACCEPTED' | 'SHIPPED' | 'PARTIALLY_SHIPPED' | 'CANCELED_BY_SELLER' | 'CANCELED_BY_BUYER', required — The current order status. * **UNACKED**: Order is created in Marketplace but a Seller acknowledge is required. * **CREATED**: Order is created but not yet completed. * **ACCEPTED**: Order is placed and checkout process is complete but not yet shipped. * (DEPRECATED) ~~SHIPPED~~: All items in the order have been shipped * (DEPRECATED) ~~PARTIALLY_SHIPPED~~: Some items (but not all) have been shipped. * (DEPRECATED) ~~CANCELED_BY_SELLER~~: Order is canceled by seller. * (DEPRECATED) ~~CANCELED_BY_BUYER~~: Order is canceled by buyer. - `orderAcceptUntil` string, date-time — When `orderStatus` is type `UNACKED` a Seller integration must confirn a Order bevor it can be proccessed. This field provides a time until when an order can be accepted. To accept an Order a Seller integration must invoke API call `PUT /v1/seller/order/accept`. - `paymentMethod` string - `paymentReference` string — Payment reference can be used to reference or identify a payment transaction - `orderId` string, required - `purchasedAt` string, date-time, required - `lastChangedAt` string, date-time, required - `currency` string, required - `orderItem` OrderItem[], required — List of Order Positions such as Order Items, Shipping or Payment. There must be at least on Item of Type ITEM and at least on Item of Type SHIPPING. - union - object - … - object - … - object - … - `billingAddress` Address - `firstName` string - `lastName` string, required - `gender` 'male' | 'female' | 'diverse' - `companyName` string - `street` string, required - `houseNumber` string - `addition` string - `postcode` string - `city` string, required - `phone` string - `country` string, required - `state` string, nullable - `shippingAddress` Address - `firstName` string - `lastName` string, required - `gender` 'male' | 'female' | 'diverse' - `companyName` string - `street` string, required - `houseNumber` string - `addition` string - `postcode` string - `city` string, required - `phone` string - `country` string, required - `state` string, nullable - `note` string — A optional note - `buyer` OrderBuyer - `email` string, email - `vatId` string - `weeePickup` boolean, nullable — This Order require a electrical and electronic equipment disposal service (WEEE) - `language` string, nullable — The language of the order as a ISO 639-1 language code - `invoiceDocumentTransfer` 'not-set' | 'from-seller' | 'from-channel', nullable — This field indicates whether the channel provides the invoice document or the seller has to upload it. This overwrites the default setting of the channel. Possible values are: - `from-seller`: Seller has to upload the invoice document - `from-channel`: Channel provides the invoice document - `not-set` (Default): Use the default setting of the channel or indicates that invoice transfer is not supported - `additionalOrderData` AdditionalOrderDataGroup[] — Additional order data is a list of key value pairs. The key is a string and the value is a string or a number. The key must be unique in the list. - `group` string — The group name is used to group the additional order data. The group name must be unique in the list. - `values` AdditionalOrderDataGroupValues[] - `key` string — The key is used to identify the additional order data. The key can be used multiple times in the list and we recommend to use a human readable key. - `value` string — The value is used to store the additional order data and must be always a string. - `fbc` boolean, nullable — Fulfillment by Channel - indicates if the order is fulfilled by the channel - `b2b` boolean, nullable — Business to Business - indicates if this is a B2B order - `salesChannelName` string, nullable — Sales channel name (Verkaufskanalname) - identifies the specific sales channel - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderId` string, required - `orderStatus` 'UNACKED' | 'CREATED' | 'ACCEPTED' | 'SHIPPED' | 'PARTIALLY_SHIPPED' | 'CANCELED_BY_SELLER' | 'CANCELED_BY_BUYER', required — The current order status. * **UNACKED**: Order is created in Marketplace but a Seller acknowledge is required. * **CREATED**: Order is created but not yet completed. * **ACCEPTED**: Order is placed and checkout process is complete but not yet shipped. * (DEPRECATED) ~~SHIPPED~~: All items in the order have been shipped * (DEPRECATED) ~~PARTIALLY_SHIPPED~~: Some items (but not all) have been shipped. * (DEPRECATED) ~~CANCELED_BY_SELLER~~: Order is canceled by seller. * (DEPRECATED) ~~CANCELED_BY_BUYER~~: Order is canceled by buyer. - `orderItems` object[] - `orderItemId` string, string, required — A unique identifier to identify a order item. This ID is provided by the Channel itself an should be used to identify a order item id. - `itemStatus` 'UNSHIPPED' | 'SHIPPED' | 'CANCELED_BY_SELLER' | 'CANCELED_BY_BUYER' | 'RETURNED' | 'REFUNDED', required — The current for order item. * **UNSHIPPED**: Item is ready for shipping * **SHIPPED**: Item is sent to buyer * **CANCELED_BY_SELLER**: Order is canceled by seller. * **CANCELED_BY_BUYER**: Order is canceled by buyer. * **RETURNED**: Item is returned to Seller. * **REFUNDED**: Item was returned and refunded. - `paymentStatus` 'PENDING' | 'PAID', required — The current payment status * **PENDING**: Order Item is not yet paid. * **PAID**: Order Item is complete paid. - `shipFromCountry` string, nullable — Ship from country (Versandland) - ISO 3 letter country code indicating the country from which the item is shipped - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderId` string, required - `billingAddress` Address - `firstName` string - `lastName` string, required - `gender` 'male' | 'female' | 'diverse' - `companyName` string - `street` string, required - `houseNumber` string - `addition` string - `postcode` string - `city` string, required - `phone` string - `country` string, required - `state` string, nullable - `shippingAddress` Address - `firstName` string - `lastName` string, required - `gender` 'male' | 'female' | 'diverse' - `companyName` string - `street` string, required - `houseNumber` string - `addition` string - `postcode` string - `city` string, required - `phone` string - `country` string, required - `state` string, nullable - `buyer` OrderBuyer - `email` string, email - `vatId` string - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - object - `channel` string, required — This is the unique Channel name. - `sellerId` string — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `reportId` string — A system wide unique Id to identify and download a report - `reportType` 'SELLER_INVENTORY' - `data` ReportSellerInventory[] - SellerInventoryItem[] - `offerId` integer — Unique Offer Id to identify an Offer on a Sales Channel. - `channelOfferId` string — Channel defined unique Offer Id to identify an Offer on a Sales Channel. - `sku` string — Stock keeping unit is a unique Id used to identify one product. - `ean` string - `quantity` string - `priceList` PriceContainer[] - … - `title` string - `channelCategoryId` string - `channelAttributeList` ChannelAttribute[] - … - `checkSum` string — A checksum for the data. The checksum is used to verify the integrity and the amount of the received data. - object — This event marks the end of a Report Data Event stream. Once this event is received, it signifies that the event data is complete and no further data will be transmitted for this report. - `channel` string, required — This is the unique Channel name. - `sellerId` string — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `reportId` string — A system wide unique Id to identify and download a report - `reportType` 'SELLER_INVENTORY' - `receivedChecksumList` string[] — A list of checksums for the received data. The checksums are used to verify the integrity and the amount the former received data. - object - `channel` string, required — This is the unique Channel name. - `type` 'CATEGORY' | 'GLOBAL_ATTRIBUTES' | 'SELLER_ATTRIBUTES' | 'PRICE_TYPES' | 'SHIPPING_RULES' | 'PAYMENT_RULES' - `resource` string - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderCancellationRequestId` string, uuid, required — A unique identifier for the order cancellation request. This ID should by used by Seller to identify the cancellation response from the Channel. - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderCancellationRequestId` string, uuid, required — A unique identifier for the order cancellation request. This ID should by used by Seller to identify the cancellation response from the Channel. - `reason` string, required - object - `channel` string, required — This is the unique Channel name. - `orderCancellationRequestId` string, uuid, required — A unique identifier for the order cancellation request. This ID should by used by Seller to identify the cancellation response from the Channel. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderId` string, required - `orderItem` object[], nullable, required - `orderItemId` string, string, required — A unique identifier to identify a order item. This ID is provided by the Channel itself an should be used to identify a order item id. - `quantity` string - `cancelReason` 'BUYER_CANCELLED' | 'UNDELIVERABLE_TO_SHIPPING_ADDRESS' | 'UNDELIVERABLE_BY_CARRIER' | 'OUT_OF_STOCK' | 'DELAYED_INVENTORY' | 'PRICING_ERROR' | 'OTHER' — * BUYER_CANCELLED: the buyer cancelled the order. * UNDELIVERABLE_TO_SHIPPING_ADDRESS: Could not deliver to the address given by the buyer. * UNDELIVERABLE_BY_CARRIER: Carrier do not ship to the buyerss location. * OUT_OF_STOCK: The item is out of stock, for example because you are temporarily or permenantly sold out. * DELAYED_INVENTORY: The item is not in your inventory and there is a delay in delivery by the supplier. * PRICING_ERROR: The price on the connected marketplace was incorrect. * OTHER: Well, objvoiusly there is some reason missing in this list. - `message` string - object - `type` 'INVOICE' | 'CREDITNOTE', required - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderId` string, required - `invoiceNumber` string, required - `originalInvoiceNumber` string, nullable — A original Invoice Number is required when type is CREDITNOTE - `transactionDate` string, date-time, required — Date when the Invoice document was issued. - `taxCalculationDate` string, date-time, required — Date when the tax in the Invoice document was calculated. - `transactionDetails` string, nullable - `shipmentDate` string, date-time - `taxAddressRole` 'shipFrom' | 'shipTo' - `exportOutsideEu` boolean - `currency` string, required - `billingAddress` Address, required - `firstName` string - `lastName` string, required - `gender` 'male' | 'female' | 'diverse' - `companyName` string - `street` string, required - `houseNumber` string - `addition` string - `postcode` string - `city` string, required - `phone` string - `country` string, required - `state` string, nullable - `sellerVatNumber` string, nullable - `buyerVatNumber` string, nullable - `orderList` OrderInvoice[] — List of orders that are part of the invoice document. There must be at least one order on a document. If the invoice document type is INVOICE, the shipping address is required and can not be empty or null. - `orderId` string, required - `purchasedAt` string, date-time, required - `shippingAddress` Address - `firstName` string - `lastName` string, required - `gender` 'male' | 'female' | 'diverse' - `companyName` string - `street` string, required - `houseNumber` string - `addition` string - `postcode` string - `city` string, required - `phone` string - `country` string, required - `state` string, nullable - `transactionItemList` OrderInvoiceTransactionItem[] - `orderItemId` string, required - `orderItemType` 'ITEM' | 'SHIPPING' | 'PAYMENT', required - `sku` string - `title` string - `quantity` number, float - `totalGrossPriceWithDiscounts` number, float, required - `totalNetPriceWithDiscounts` number, float, required - `totalVatAmountWithDiscounts` number, float, required - `vatRate` number, float, required - `discounts` OrderInvoiceTransactionItemDiscounts[], nullable - … - `channel` string, required — This is the unique Channel name. - `documentId` string, required - `documentExpiresAt` string, date-time, required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `orderId` string, required - `orderItem` ReturnAnnouncementOrderItem[] — Details about what will be to returned to Seller. If the orderItem list is empty as Seller must expect that the whole order is returned. - `orderItemId` string, string, required — A unique identifier to identify a order item. This ID is provided by the Channel itself an should be used to identify a order item id. - `quantity` string, required - `returnReason` 'NO_REASON' | 'DEFECT' | 'WRONG_ITEM' | 'WRONG_SIZE' | 'TOO_LATE' | 'BAD_QUALITY', required - `note` string - `channelReturnId` string, required — Id used to identify an order return on Marketplace. - `returnTracking` object — Optional information about return tracking. - `carrier` string, required - `trackingNumber` string, required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `sellerReturnId` string, required — Id used to identify an order return on Seller side. - `isAccepted` boolean, required - `processingErrorList` ReturnProcessingError[] - `code` string - `message` string, required - object - `channel` string, required — This is the unique Channel name. - `refundId` string, required — Seller created unique Id to identify the processing Result of a Refund processing from a Channel. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `isAccepted` boolean, required - `processingErrorList` RefundProcessingError[] - `code` string - `message` string, required - object - `channel` string, required — This is the unique Channel name. - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process. - `ticketId` string, required — Unique identifcation for Ticket Id - `topic` 'QUESTION' | 'FEEDBACK' | 'DELIVERY' | 'RETURN' | 'REFUND' | 'INCIDENT', required - `reference` TicketReference, nullable - `type` 'OFFER' | 'CHANNELOFFER' | 'ORDERID' | 'ORDERITEMID', required - `id` string, required - `replyRequested` boolean - `createdAt` string, date-time, required - `from` TicketFrom, required - `role` 'BUYER' | 'SELLER' | 'CHANNEL', required - `name` string - `subject` string, required - `message` string, required - `attachment` TicketAttachment[] - `filename` string, required - `contentType` string, required - object - `channel` string, required — This is the unique Channel name. ## Other responses - `401` — Access forbidden, invalid or unknown Token was used. - `429` — User has send to many requests - `500` — Unexpected Server Error --- [API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/revisions/f979b1ea6951/schema)