Akeneo Products API

openapi: 3.1.0
info:
  title: Akeneo PIM REST Asset Manager Products 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: Products
paths:
  /api/rest/v1/products:
    get:
      tags:
      - Products
      summary: List products
      operationId: listProducts
      parameters:
      - in: query
        name: search
        schema:
          type: string
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: page
        schema:
          type: integer
      responses:
        '200':
          description: List of products.
    post:
      tags:
      - Products
      summary: Create a product
      operationId: createProduct
      responses:
        '201':
          description: Created.
    patch:
      tags:
      - Products
      summary: Update or create several products
      operationId: bulkUpsertProducts
      responses:
        '200':
          description: OK
  /api/rest/v1/products/{code}:
    parameters:
    - in: path
      name: code
      required: true
      schema:
        type: string
    get:
      tags:
      - Products
      summary: Get a product
      operationId: getProduct
      responses:
        '200':
          description: OK
    patch:
      tags:
      - Products
      summary: Update or create a product
      operationId: upsertProduct
      responses:
        '200':
          description: OK
    delete:
      tags:
      - Products
      summary: Delete a product
      operationId: deleteProduct
      responses:
        '204':
          description: No content
  /api/rest/v1/products-uuid:
    get:
      tags:
      - Products
      summary: List products by UUID
      operationId: listProductsByUuid
      responses:
        '200':
          description: OK
    post:
      tags:
      - Products
      summary: Create a product by UUID
      operationId: createProductByUuid
      responses:
        '201':
          description: Created
    patch:
      tags:
      - Products
      summary: Bulk upsert products by UUID
      operationId: bulkUpsertProductsByUuid
      responses:
        '200':
          description: OK
  /api/rest/v1/products-uuid/{uuid}:
    parameters:
    - in: path
      name: uuid
      required: true
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Products
      operationId: getProductByUuid
      summary: Get a product by UUID
      responses:
        '200':
          description: OK
    patch:
      tags:
      - Products
      operationId: upsertProductByUuid
      summary: Update or create a product by UUID
      responses:
        '200':
          description: OK
    delete:
      tags:
      - Products
      operationId: deleteProductByUuid
      summary: Delete a product by UUID
      responses:
        '204':
          description: No content
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