Update Channel

Update Channel information. This endpoint is protected by MFA (2FA). A valid MFA PIN must be included in the request. The PIN can be generated using the GET /v1/channel/mfa-pin endpoint and will be sent to the channel's mfaContact email address.

Request body

mfaPinstring required

Multi-Factor Authentication (MFA) PIN required for updating channel details. The PIN must be generated using the GET /v1/channel/mfa-pin endpoint and will be sent to the channel's mfaContact email address.

displayNamestring

Channel Name

currencystring

Currency which are supported by the Channel. According to ISO-4217.

marketplaceListstring[]

Country ISO code or a list of ISO codes which geografic market is supported.

websitestring uri

mfaContactstring email nullable

Email address used for Multi-Factor Authentication (MFA). MFA PINs for channel updates will be sent to this email address.

vendorstring

signUpUrlstring

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.

updateUrlstring

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

Example request

{
  "mfaPin": "12345670",
  "displayName": "MyBestDeals.com",
  "currency": "EUR",
  "marketplaceList": [
    "DE"
  ],
  "website": "https://mybestdeals.de/sell-with-jtl",
  "mfaContact": "security@mybestdeals.de",
  "vendor": "JTL-Software",
  "signUpUrl": "https://mysqlbestdeals.com/signup-for-scx?session={SESSION}",
  "updateUrl": "https://mysqlbestdeals.com/signup-for-scx?session={SESSION}",
  "minimumClientsVersionRequired": [
    {
      "type": "Wawi",
      "version": "1.11.0.3"
    }
  ]
}

Response

Channel Updated