# Changelog

## 2025-10-23

Introduced `minimumClientsVersionRequired` handling for channels.
This property allows channels to define the minimum required version of a client (e.g., JTL-Wawi)
needed for seller sign-up and channel selection.

### Added

List of minimum client versions that must be met during seller registration. New object schema
defining type (client type) and version (semantic version string). Only `type=Wawi` is supported.

- `PATCH /v1/channel`:
  - new property `minimumClientsVersionRequired` can be patched
- `GET /v1/channel`:
  - new property `channel.minimumClientsVersionRequired`


### Behavior

When a seller attempts to register with a Wawi version lower than the specified minimum, SCX rejects
the registration with error code SLR202.

Existing sellers are not revalidated automatically if the minimum version changes.

The property is visible in `GET /v1/public/channel` to inform client of version requirements
and can be modified via Channel API using `PATCH /v1/channel`.

## 2025-10-20

Added new optional properties `trackingUrl` to the Event `Seller:Order.Shipping`.
This allows Sellers to provide a direct tracking link for shipments, enabling buyers
to monitor the delivery status of their orders in real time.

### Added

- `GET /v1/channel/event` affected Event `Seller:Order.Shipping`:
  - `orderList[].shippingItems[].trackingUrl`
  - `orderList[].shippingItems[].returnTracking.trackingUrl`


## 2025-09-29

Introduced the new clientVersion property in all seller events.
This provides the Channel Integrator with the ERP client version (e.g. JTL-Wawi)
used when the event was created, allowing targeted handling of version-specific issues.

### Added

- `GET /v1/channel/event`:
  - `clientVersion`: ERP client version following the semantic versioning like scheme.


## 2025-07-03

Added an optional property `orderList[].buyer.vatId`, allowing merchants to capture the buyer’s
VAT identification.

### Added

- `POST /v1/channel/order`:
  - `requestBody`: added support for `orderList[].buyer.vatId` property
- `PUT /v1/channel/order/address-update`:
  - `requestBody`: added support for `orderList[].buyer.vatId` property


## 2025-05-26

Attributes of type `image` and `file` now accept URLs from external sources. Previously,
specifying URLs outside the EazyAuction infrastructure for attributes (such as the "Speicherort des Produktsicherheitsbildes")
resulted in an error indicating the image could not be found.

### Changed

Non-EazyAuction URLs used in image attributes are no longer verified, enabling sellers to reliably share static
content hosted on their own CDNs or other external sources without encountering validation errors.

## 2025-05-19

New Endpoint: We’ve introduced a new `PATCH /v1/channel` endpoint, enabling channel operators to
update metadata of their channel integration—such as name, website, feature flags, and supported locales—without
a full resubmission.

This addition allows for more flexible and efficient channel maintenance.

To ensure secure access, updates require verification through a Multi-Factor Authentication (MFA) mechanism.
Each request must include a valid mfaPin, sent to a predefined mfaContact email address.

### Added

- `PATCH /v1/channel`: New endpoint to partially update channel metadata
  - `mfaContact`: New property used to define the recipient of MFA PINs (required prior to using PATCH)
  - `mfaPin`: New property required in PATCH requests for authorization
- `GET /v1/channel/mfa-pin`: Supporting endpoint to generate MFA PINs
- New error codes:
  - `GHN900`: MFA PIN is missing
  - `CHN901`: MFA PIN is invalid or expired
  - `CHN910`: mfaContact is not configured for the channel


## 2025-01-15

New endpoint `GET /v1/channel/seller/list` added to list all SellerIds known by SCX-API with current status.

- `GET /v1/channel/seller/list`: New endpoint added


## 2024-07-08

Added an optional property invoiceDocumentTransfer, indicating whether invoices must be uploaded by the seller
or provided by the channel. If not set, the channel's default settings will be used.

- `POST /v1/channel/order`:
  - `requestBody`: added support for `invoiceDocumentTransfer` property


## 2024-02-26

Improved error messaging by introducing `relatedAttributeId` and `recommendedValue` properties to the
OfferListingFailedError object. These enhancements aim to provide clearer, actionable feedback to users
encountering errors, thereby improving the API's usability and integration experience.

### Added

- `POST /v1/channel/offer/listing-failed`:
  - `requestBody`: added support for `offerList`.`errorList`.`relatedAttributeId` property
  - `requestBody`: added support for `offerList`.`errorList`.`recommendedValue` property


## 2024-02-08

We've implemented an internal cleanup process that permanently removes sellers from the SCX system when they no
longer have an active subscription with JTL-Software, marked by a new permanentlyRemoved property.

### Added

- `GET /v1/channel/event`: Added property `permanentlyRemoved` to `SellerEventSellerUnlinked`


## 2024-01-16

Enhanced data customization options for orders and their items, offering more detailed
information handling in the JTL-Wawi.

### Added

- `POST /v1/channel/order`:
  - `requestBody`: added support for `orderList`.`items`.`additionalOrderData` property
  - `requestBody`: added support for `orderList`.`items`.`orderItem`.`items`.`additionalOrderItemData` property


## 2023-10-09

Transitioning from a single report submission method to a more flexible chunk-based approach,
allowing for the handling of larger report data more efficiently.

### Deprecation

- deprecate `POST` `/v1/channel/report/{reportId}` in favor of `POST` `/v1/channel/report/{reportId}/data`


### Added

- added `POST` `/v1/channel/report/{reportId}/data`
- added `POST` `/v1/channel/report/{reportId}/completed`