---
title: "Status"
method: GET
path: "/v1/channel"
tags: ["Channel"]
---

# Status

`GET /v1/channel`

Read Channel information

## Response `200`

Channel status retrieved

- ChannelStatus — Operational status of the channel including whether it is currently active and its master data.
  - `isActive` boolean
  - `channel` SalesChannelData
    - `group` string, nullable
    - `currency` string — Currency which are supported by the Channel. According to ISO-4217.
    - `marketplaceList` string[], required — Country ISO code or a list of ISO codes which geografic market is supported.
    - `supportedLanguages` string[] — Laguage ISO code or a list of ISO codes which languages ars supported. According to ISO 639-1.
    - `displayName` string, required — Channel Name
    - `website` string, uri, required
    - `pricing` string, uri, nullable
    - `channelType` 'MARKETPLACE' | 'OTHER'
    - `supportContact` string, email, required
    - `vendor` string, required
    - `signUpUrl` string, required — The SignUp URL ist required for register new Sellers with the SCX Channel API. SCX will create a Sign-Up ID to link a seller with SCX.
    - `updateUrl` string — The Update URL ist required for updating a existing Sellers with the SCX Channel API. If this URL is not set it will use the signUpUrl as a fallback
    - `logo` string, nullable — URL of a Channel logo
    - `description` string, nullable — Description text of a channel
    - `appId` string, nullable — AppId of a channel. Wawi use this to create Links to the Channel-Documentation
    - `featureList` ChannelFeatureList, required
      - `invoiceDocumentTransfer` 'not-supported' | 'from-channel' | 'from-seller' — Indicates if Invoice can be shared between Channel and Seller Implementation. If this flag is set to `from-seller` a connected client implementation (such as JTL-Wawi) can upload invoice documents using `POST /v1/seller/order/invoice`. When flag is set to `from-channel` a connected client can receive invoice from a Channel by `Channel:Order.Invoice` Event. A value `not-supported` indicates that no invoices can be transmitted between Seller and Channel.
      - `priceUpdatesSupported` boolean — Indicates whether the channel is able to process events of type Seller:Offer.PriceUpdate
      - `quantityPriceSupported` boolean — Does the channel support quantity price for quantity greater than 1. In SCX all offer prices are represented by a quantity price data structure. In case there is no support for quantity prices on a certain channel only the price for quantity 1 is taken into account. All other price settings may be ignored by the connected channel.
      - `remainingQuanitySupported` boolean — Indicates if a channel is able to support a remaing quanity with each Order. The feature can be used by a connected client implementation (such as JTL-Wawi) to manage quanity updates on an channel.
      - `variationsSupported` boolean — Does the channel supports listing of variation offers. Variations are multiple similar (but not identical) items in a offer listing. For example, a single offer could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price.
      - `returnTrackingRequired` boolean — Indicates if a channel requires a return tracking code for an order item shipping update.
      - `allowCombineOrders` boolean — Indicates if a channel allows the combination of multiple separate orders into one.
      - `stockUpdateWithoutEventSupported` boolean — Indicates if a channel will fetch Stock updates per Route without need of SellerEventOfferStockUpdate.
    - `minimumClientsVersionRequired` MinimumClientsVersionRequired[], nullable — Must be a list of supported Clients. If at least one item is defined SCX will validate the Client version during sign up process. If the list is empty or null, no client restrictions is in place.
      - `type` string, required — Type of Client. Set to `Wawi` for JTL-Wawi.
      - `version` string, required — Minimum Client Version required for channel selection and sign up. Must be a semantic version (e.g., 1.11.0.3).
    - `isPlatform` boolean — Defines whether a channel is a platform channel. Is the property is set to true the channel is considered as a platform channel. The platform property must be null - true = Platform Channel - false = Marketplace or normal Channel
    - `platform` string — Belonging to a platform. If set, it is a marketplace channel. If isPlatform = true, this property must not be set.
    - `marketplaceChannelList` unknown[] — Only set for Platform Channel, and contains all Marketplace Channel names that have been assigned to the platform.
      - unknown
    - `stockSyncGroup` string, nullable — Groups Marketplace Channels for stock synchronization. Rules: - May ONLY be set when `platform` != null (Marketplace Channel). - Must be null when `isPlatform` = true (Platform Channel). Semantics: - All Channels with the same `stockSyncGroup` expect only ONE stock update per SKU (ERP sends to exactly one Channel of the group).

## 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)
