---
title: "Seller Events"
method: GET
path: "/v1/channel/event"
tags: ["Events"]
---

# Seller Events

`GET /v1/channel/event`

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.

## Query parameters

- `createdAfter` string, date-time
- `eventTypeFilter` string

## Response `200`

Seller events retrieved

- SellerEventList — Paginated list of events relevant to a seller (e.g. listing failed, order received) emitted by the channel.
  - `eventList` object[]
    - `id` string, required
    - `createdAt` string, date-time, required
    - `clientVersion` string — ERP-Client Version.
    - `type` 'System:Test' | 'System:Notification' | 'Seller:Order.Confirmed' | 'Seller:Order.Shipping' | 'Seller:Order.Payment' | 'Seller:Order.Cancellation.Request' | 'Seller:Order.Cancellation.Accepted' | 'Seller:Order.Cancellation.Denied' | 'Seller:Order.Refund' | 'Seller:Order.Invoice' | 'Seller:Order.ReturnReceived' | 'Seller:Offer.New' | 'Seller:Offer.Update' | 'Seller:Offer.End' | 'Seller:Offer.StockUpdate' | 'Seller:Offer.PriceUpdate' | 'Seller:Report.Request' | 'Seller:Channel.Unlinked' | 'Seller:Meta.SellerAttributesUpdateRequest' | 'Seller:Ticket.Reply', required
    - `event` union, required
      - object — Batch of shipping notifications for marketplace orders (carrier, tracking number, ship date).
        - `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.
        - `orderList` object[]
          - `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
          - `shippingComplete` boolean, required — When shipping is completed set to "true".
          - `shippingItems` object[], required
            - `carrier` string, required
            - `trackingNumber` string — Optional URL provided by the merchant that allows customers/buyers to track their shipment. This tracking URL enables customers to monitor the delivery status and location of their order during the shipping process.
            - `trackingUrl` string
            - `returnTracking` object, nullable — The return tracking number and carrier for the return process. Each orderItemId may have its own return tracking.
              - …
            - `shippedAt` string, date-time
            - `orderItemIdList` object[], nullable — Container to describe what items are included.
              - …
            - `shippedFrom` object, nullable — The adress from where the shipment is sent.
              - …
          - `channel` string, required — This is the unique Channel name.
      - object
        - `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
        - `paymentComplete` boolean, required
        - `paidAt` string, date-time, required
      - object
        - `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.
      - object — List Offer on Channel. If your current channel implementation process listing in asychronous manner it is recommended to call `/channel/offer/received` afterwards to mark wating Offers as in-progress. If a channel process an Offer directly you do not need to mark a Offer as `in-progress`. But it is important to mark an Offer as `successful` listed. If there are any errors during the listing process it is importand to mark a offer as `failed`.
        - `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.
        - `parentOfferId` integer, nullable — In case the current offer has an reference to a parent offer. This ParentOfferId must be used to identify the Parent Offer. The ParentOfferId is conditionally mandatory for variation Offers in case you add a new Item to a existing Variation Offer Listing.
        - `channelOfferId` string — Channel defined unique Offer Id to identify an Offer on a Sales Channel.
        - `channelCategoryId` string
        - `quantity` string — Offer Quantity
        - `taxPercent` string
        - `priceList` PriceContainer[], required
          - `id` string, required
          - `quantityPriceList` QuantityPrice[], required
            - `amount` string, required
            - `currency` string, required
            - `quantity` string, nullable
        - `title` string — Title used for this specific SalesChannel. If no title is provided, the product title should be used.
        - `subTitle` string — Subtitle used for this specific SalesChannel. If no subtitle is provided, the product description should be used.
        - `description` string — Description used for this specific SalesChannel. If no description is provided, the product description should be used.
        - `mainPicture` string
        - `pictureList` string[]
        - `channelAttributeList` ChannelAttribute[] — A List of SalesChannel related attributes. Typically all required attributes need to be passed through this objects. Required (and also optional) attributes can be requested using the /meta Data API endpoints.
          - `attributeId` string, required
          - `value` string, required
          - `group` string, nullable
        - `variationList` Variation[]
          - `offerId` integer, required — Unique Offer Id to identify an Offer on a Sales Channel.
          - `sku` string, required — Stock keeping unit is a unique Id used to identify one product.
          - `gtin` string
          - `variationDimensionList` ChannelAttribute[], required — A List of SalesChannel related attributes. These attributes are used to define variation dimensions. You can use up to 10 dimensions to build a multi-variation listing.
            - `attributeId` string, required
            - `value` string, required
            - `group` string, nullable
          - `quantity` string, required — Offer Quantity
          - `priceList` PriceContainer[], required
            - `id` string, required
            - `quantityPriceList` QuantityPrice[], required
              - …
          - `taxPercent` string
          - `pictureList` string[]
          - `title` string — Title used for this variation listing on SalesChannel. If no title is provided, the SalesChannelOffer title should be used.
          - `subTitle` string — Subtitle used for this variation listing on SalesChannel. If no subtitle is provided, the SalesChannelOffer Subtitel should be used.
          - `description` string — Description used for this variation listing on SalesChannel. If no description is provided, the SalesChannelOffer description should be used.
          - `channelAttributeList` ChannelAttribute[] — A List of SalesChannel related attributes. Typically all required attributes need to be passed through this objects. Required (and also optional) attributes can be requested using the /meta Data API endpoints. A Channel should merge the SalesChannelOffer channelAttributeList with this Attribute List. This List extends the Attributes from the SalesChannelOffer channelAttributeList property and should be overwrite existing Attributes.
            - `attributeId` string, required
            - `value` string, required
            - `group` string, nullable
        - `sku` string, required — Stock keeping unit is a unique Id used to identify one product.
        - `gtin` string
        - `mpn` string
        - `isbn` string
        - `brand` string
        - `srp` Price
          - `amount` string, required
          - `currency` string, required
        - `productAttributeList` ProductAttribute[]
          - `name` string, required
          - `value` string, required
      - object — Update existing Offer. If your current channel implementation process listing in asychronous manner it is recommended to call `/channel/offer/received` afterwards to mark wating Offers as in-progress. If a channel process an Offer directly you do not need to mark a Offer as `in-progress`. But it is important to mark an Offer as `successful` listed. If there are any errors during the listing process it is importand to mark a offer as `failed`.
        - `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.
        - `parentOfferId` integer, nullable — In case the current offer has an reference to a parent offer. This ParentOfferId must be used to identify the Parent Offer. The ParentOfferId is conditionally mandatory for variation Offers in case you add a new Item to a existing Variation Offer Listing.
        - `channelOfferId` string — Channel defined unique Offer Id to identify an Offer on a Sales Channel.
        - `channelCategoryId` string
        - `quantity` string — Offer Quantity
        - `taxPercent` string
        - `priceList` PriceContainer[], required
          - `id` string, required
          - `quantityPriceList` QuantityPrice[], required
            - `amount` string, required
            - `currency` string, required
            - `quantity` string, nullable
        - `title` string — Title used for this specific SalesChannel. If no title is provided, the product title should be used.
        - `subTitle` string — Subtitle used for this specific SalesChannel. If no subtitle is provided, the product description should be used.
        - `description` string — Description used for this specific SalesChannel. If no description is provided, the product description should be used.
        - `mainPicture` string
        - `pictureList` string[]
        - `channelAttributeList` ChannelAttribute[] — A List of SalesChannel related attributes. Typically all required attributes need to be passed through this objects. Required (and also optional) attributes can be requested using the /meta Data API endpoints.
          - `attributeId` string, required
          - `value` string, required
          - `group` string, nullable
        - `variationList` Variation[]
          - `offerId` integer, required — Unique Offer Id to identify an Offer on a Sales Channel.
          - `sku` string, required — Stock keeping unit is a unique Id used to identify one product.
          - `gtin` string
          - `variationDimensionList` ChannelAttribute[], required — A List of SalesChannel related attributes. These attributes are used to define variation dimensions. You can use up to 10 dimensions to build a multi-variation listing.
            - `attributeId` string, required
            - `value` string, required
            - `group` string, nullable
          - `quantity` string, required — Offer Quantity
          - `priceList` PriceContainer[], required
            - `id` string, required
            - `quantityPriceList` QuantityPrice[], required
              - …
          - `taxPercent` string
          - `pictureList` string[]
          - `title` string — Title used for this variation listing on SalesChannel. If no title is provided, the SalesChannelOffer title should be used.
          - `subTitle` string — Subtitle used for this variation listing on SalesChannel. If no subtitle is provided, the SalesChannelOffer Subtitel should be used.
          - `description` string — Description used for this variation listing on SalesChannel. If no description is provided, the SalesChannelOffer description should be used.
          - `channelAttributeList` ChannelAttribute[] — A List of SalesChannel related attributes. Typically all required attributes need to be passed through this objects. Required (and also optional) attributes can be requested using the /meta Data API endpoints. A Channel should merge the SalesChannelOffer channelAttributeList with this Attribute List. This List extends the Attributes from the SalesChannelOffer channelAttributeList property and should be overwrite existing Attributes.
            - `attributeId` string, required
            - `value` string, required
            - `group` string, nullable
        - `sku` string, required — Stock keeping unit is a unique Id used to identify one product.
        - `gtin` string
        - `mpn` string
        - `isbn` string
        - `brand` string
        - `srp` Price
          - `amount` string, required
          - `currency` string, required
        - `productAttributeList` ProductAttribute[]
          - `name` string, required
          - `value` string, required
      - object — Update stock for a list of existing Offers
        - `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.
        - `quantity` string, required
      - object — Update price for a list of existing Offers
        - `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.
        - `priceList` PriceContainer[], required
          - `id` string, required
          - `quantityPriceList` QuantityPrice[], required
            - `amount` string, required
            - `currency` string, required
            - `quantity` string, nullable
      - object
        - `channel` string — 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.
      - object
        - `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.
        - `reportType` 'SELLER_INVENTORY', required
        - `options` object
          - `ResultsAsChannelEvent` boolean — If true, the report will be generated as a channel event. This means that the report will be sent to the seller via the channel event system. If false, the report will be generated as a file. This means that the report will be available for download via the report endpoint.
        - `startDate` string, date, nullable
        - `endDate` string, date, nullable
        - `reportId` string, required — A system wide unique Id to identify and download a report
      - 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
        - `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.
        - `reason` string, required — Specifies the reason for the SellerId being removed or marked as inactive. This field can contain predefined values such as 'DEACTIVATED_BY_ACCOUNT', which indicates that the deactivation was initiated by the account holder. This information is crucial for understanding the context of the SellerId's status change and for taking appropriate actions based on the reason provided.
        - `unlinkedAt` string, date-time, required — Records the exact date and time when the SellerId was either removed from the system or flagged as inactive. The timestamp follows the ISO 8601 format, providing both date and time
        - `permanentlyRemoved` boolean — Indicates whether the SellerId has been permanently removed from the JTL-Account. If set to true, the SellerId is considered invalid within the SCX System. Consequently, Channel Connections must either delete the SellerId or flag it as inactive in their systems. Any attempt to use a permanently removed SellerId will result in an error (GEN700 - Seller {sellerId} does not exist on channel {channel}), indicating that the SellerId is no longer valid for transactions on the specified channel.
      - object
        - `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.
      - OrderCancellationRequest
        - `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
      - CancellationAccept
        - `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.
      - CancellationDenied
        - `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
        - `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
        - `orderAccepted` boolean
        - `reason` '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.
      - 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
        - `documentId` string, required
        - `documentExpiresAt` string, date-time, required
      - ReturnReceived
        - `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
        - `sellerReturnId` string, required — Id used to identify an order return on Seller side.
        - `channelReturnId` string — Id used to identify an order return on Marketplace.
        - `orderItem` ReturnReceivedOrderItem[], 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, required
          - `returnReason` 'NO_REASON' | 'DEFECT' | 'WRONG_ITEM' | 'WRONG_SIZE' | 'TOO_LATE' | 'BAD_QUALITY', required
          - `note` string
          - `condition` 'ORIGINAL_PACKAGING' | 'MINT_CONDITION' | 'SLIGHTLY_USED' | 'HEAVILY_USED' | 'DAMAGED' | 'INCOMPLETE_DELIVERY' | 'FRAUD', required
          - `acceptReturn` boolean, required
          - `requireReturnShipping` boolean, required
      - Refund
        - `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.
        - `orderId` string, required
        - `orderItem` RefundOrderItem[], 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, required
          - `reason` 'NO_REASON' | 'DEFECT' | 'WRONG_ITEM' | 'WRONG_SIZE' | 'TOO_LATE' | 'BAD_QUALITY' | 'OTHER', required
          - `refund` string, required
          - `refundCurrency` string, required
      - TicketReply
        - `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
        - `replyRequested` boolean
        - `createdAt` string, date-time, required
        - `from` TicketFrom, required
          - `role` 'BUYER' | 'SELLER' | 'CHANNEL', required
          - `name` string
        - `message` string, required
        - `attachment` TicketAttachment[]
          - `filename` string, required
          - `contentType` string, required

## Other responses

- `401` — Access forbidden, invalid or unknown Token was used.
- `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)