v1

latestSwagger 2.02026-07-13137761.0 MB

Channel

Update/create a channel

This endpoint allows you to update a given channel. Know more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no channel exists for the given code, it creates it.

patch/api/rest/v1/channels/{code}

Path parameters

codestring required

Code of the resource

Request body

codestring required

Channel code

localesstring[] required

Codes of activated locales for the channel

currenciesstring[] required

Codes of activated currencies for the channel

category_treestring required

Code of the category tree linked to the channel

Example request

{
  "code": "ecommerce",
  "currencies": [
    "USD",
    "EUR"
  ],
  "locales": [
    "de_DE",
    "en_US",
    "fr_FR"
  ],
  "category_tree": "master",
  "conversion_units": {
    "weight": "KILOGRAM"
  },
  "labels": {
    "en_US": "Ecommerce",
    "de_DE": "Ecommerce",
    "fr_FR": "Ecommerce"
  }
}

Response

Created