Update/create a channel

PATCH

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

Channel

This endpoint allows you to update a given channel. Know more about Update behavior. Note that if no channel exists for the given code, it creates it.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/channels/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "category_tree": "master",
    "code": "ecommerce",
    "conversion_units": {
        "weight": "KILOGRAM"
    },
    "currencies": [
        "USD",
        "EUR"
    ],
    "labels": {
        "de_DE": "Ecommerce",
        "en_US": "Ecommerce",
        "fr_FR": "Ecommerce"
    },
    "locales": [
        "de_DE",
        "en_US",
        "fr_FR"
    ]
}'

Response Example

201 - Example 1

{}

Request

Path Params

code

string

required

Code of the resource

Body Params application/json

category_tree

string

required

Code of the category tree linked to the channel

code

string

required

Channel code

conversion_units

object

optional

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

attributeCode

string

optional

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

currencies

array[string]

required

Codes of activated currencies for the channel

labels

object

optional

Channel labels for each locale

Default:

{}

localeCode

string

optional

Channel label for the locale localeCode

locales

array[string]

required

Codes of activated locales for the channel

Examples

Responses

🟢201Created

application/json

Body

object {0}

🟢204No content to return

🟠400Bad request

🟠401Authentication required

🟠403Access forbidden

🟠415Unsupported Media type

🟠422Unprocessable entity

Modified at 2023-08-15 05:53:55

Get a channel

Get a list of currencies