Sign in

v1

latestSwagger 2.02026-07-13137761.0 MB
Channel

Get a list of channels

This endpoint allows you to get a list of channels. Channels are paginated and sorted by code.

get/api/rest/v1/channels

Query parameters

pageinteger

Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section

limitinteger

Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section

with_countboolean

Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Response

Return channels paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "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"
        }
      }
    ]
  }
}