Akeneo Channels API

The Channels API from Akeneo — 1 operation(s) for channels.

OpenAPI Specification

akeneo-channels-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Akeneo PIM REST Asset Manager Channels API
  version: 1.0.0
  description: 'REST API for the Akeneo Product Information Management (PIM) platform.

    Manage products, product models, families, attributes, categories,

    channels, locales, assets, reference entities, catalogs, workflows,

    and more. Authentication uses OAuth 2.0 client credentials with

    per-tenant base URLs in the SaaS edition.

    '
  contact:
    name: Akeneo
    url: https://api.akeneo.com
  license:
    name: Documentation Terms
    url: https://api.akeneo.com
servers:
- url: https://{tenant}.cloud.akeneo.com
  description: Akeneo PIM SaaS tenant
  variables:
    tenant:
      default: demo
      description: Tenant subdomain assigned by Akeneo.
security:
- BearerAuth: []
tags:
- name: Channels
paths:
  /api/rest/v1/channels:
    get:
      tags:
      - Channels
      operationId: listChannels
      summary: List channels
      responses:
        '200':
          description: OK
    post:
      tags:
      - Channels
      operationId: createChannel
      summary: Create a channel
      responses:
        '201':
          description: Created
components:
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.cloud.akeneo.com/api/oauth/v1/token
          scopes: {}
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT