Patch Channel By Code

Update/create a channel

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

Use it in a workflow

Add a step and choose the Akeneo connector.
Pick the Patch Channel By Code action (under Channel).
Fill in the fields below, then reference the result from later steps as {{patchChannelByCode.response.data}}.

Request

Path parameters

codestringrequired

This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the code is correctly formatted and corresponds to an existing entity in the system.

Request body

Enter the body as JSON in the step's Body field.

codestring

Channel code

localesarray<string>

Codes of activated locales for the channel

currenciesarray<string>

Codes of activated currencies for the channel

category_treestring

Code of the category tree linked to the channel

conversion_unitsobject

Units to which the given metric attributes should be converted when exporting products

attributeCodestring

Conversion unit code used to convert the values of the attribute `attributeCode` when exporting via the channel

pim_config_family_rulesobject | null

Per-locale conversion rules keyed by measurement family code, then locale code. Each cell is either a unit code string or an object carrying the unit and optional decimal-precision settings.

pim_config_attribute_locale_rulesobject | null

Per-locale conversion rules keyed by attribute code, then locale code. Each cell is either a unit code string or an object carrying the unit and optional decimal-precision settings.

labelsobject

Channel labels for each locale

Default {}

json

{
  "code": "ecommerce",
  "locales": [
    "de_DE",
    "en_US",
    "fr_FR"
  ],
  "currencies": [
    "USD",
    "EUR"
  ],
  "category_tree": "master",
  "conversion_units": {
    "weight": "KILOGRAM",
    "pim_config_family_rules": {
      "Power": {
        "en_US": "KILOWATT",
        "fr_FR": {
          "unit": "WATT",
          "decimal_places_strategy": "round",
          "decimal_places": 2
        }
      }
    },
    "pim_config_attribute_locale_rules": {
      "weight": {
        "en_US": "KILOGRAM"
      }
    }
  },
  "labels": {
    "en_US": "Ecommerce",
    "de_DE": "Ecommerce",
    "fr_FR": "Ecommerce"
  }
}

Response

Returns 201 with a any. Read it in later steps with {{patchChannelByCode.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.

Was this page helpful?