# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mirakl Products API
  version: 1.0.0
extends: openapi/mirakl-products-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/api/mcm/products/sources/status/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export source product data sheet statuses
      effect: read
      questions:
      - How do I get a delta of product data sheet statuses changed since my last sync?
      - Can I filter source product statuses by provider identifier or status?
      instructions:
      - text: Export source product statuses updated since {updated_since}.
        slots:
          updated_since: query.updated_since
      - text: Export product data sheet statuses with status {status} between {updated_since} and {updated_to}.
        slots:
          status: query.status
          updated_since: query.updated_since
          updated_to: query.updated_to
      - text: Get the data sheet status for product {unique_identifier}.
        slots:
          unique_identifier: query.unique_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hierarchies'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog categories in a hierarchy
      effect: read
      questions:
      - What are the child categories under a given catalog category?
      - Can I limit how many levels of the category tree come back?
      instructions:
      - text: List catalog categories under {hierarchy}.
        slots:
          hierarchy: query.hierarchy
      - text: Show the category tree below {hierarchy} down to {max_level} levels.
        slots:
          hierarchy: query.hierarchy
          max_level: query.max_level
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports'].get
  update:
    x-apievangelist-phrasing:
      intent: List product import statuses
      effect: read
      questions:
      - How do I see the status of all my product imports?
      - Can I list only product imports that have a transformed file?
      instructions:
      - text: List product imports since {last_request_date}.
        slots:
          last_request_date: query.last_request_date
      - text: List product imports with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a product file
      effect: write
      questions:
      - How do I upload a product catalog file to the marketplace?
      - Can I have my product file converted to the operator format during import?
      instructions:
      - text: Import products from {file}.
        slots:
          file: requestBody.file
      - text: Import {file} with conversion type {conversion_type}.
        slots:
          file: requestBody.file
          conversion_type: requestBody.conversion_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports/{import}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of one product import
      effect: read
      questions:
      - Has my product import finished processing?
      - What is the current status of a specific product import?
      instructions:
      - text: Get the status of product import {import}.
        slots:
          import: path.import
      - text: Check whether product import {import} is complete.
        slots:
          import: path.import
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports/{import}/error_report'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the non-integrated products report
      effect: read
      questions:
      - Which products from my import were not integrated, and why?
      - Where do I get the error report for a product import?
      instructions:
      - text: Download the error report for product import {import}.
        slots:
          import: path.import
      - text: Get the non-integrated products report of import {import}.
        slots:
          import: path.import
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports/{import}/new_product_report'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the added products report
      effect: read
      questions:
      - Which products were successfully added by my import?
      - Can I get a report of new products created from a product import?
      instructions:
      - text: Download the added products report for import {import}.
        slots:
          import: path.import
      - text: Get the new product integration report of import {import}.
        slots:
          import: path.import
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports/{import}/transformed_file'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a product import in operator format
      effect: read
      questions:
      - Can I see my product file after it was converted into the operator format?
      - Where is the transformed CSV for a product import?
      instructions:
      - text: Download the transformed file for product import {import}.
        slots:
          import: path.import
      - text: Get the operator-format CSV of import {import}.
        slots:
          import: path.import
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/imports/{import}/transformation_error_report'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the source file error report
      effect: read
      questions:
      - What errors were found while transforming my source product file?
      - Is there a report of source file transformation errors for a product import?
      instructions:
      - text: Download the transformation error report for import {import}.
        slots:
          import: path.import
      - text: Get the source file error report of product import {import}.
        slots:
          import: path.import
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product attribute configuration
      effect: read
      questions:
      - Which product attributes are required for a category?
      - Can I include every operator attribute along with their roles?
      instructions:
      - text: Get the product attributes for category {hierarchy}.
        slots:
          hierarchy: query.hierarchy
      - text: Show all operator attributes with roles ({with_roles}) for {hierarchy}.
        slots:
          with_roles: query.with_roles
          hierarchy: query.hierarchy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/values_lists'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the operator's value lists
      effect: read
      questions:
      - What allowed values exist in the operator's value lists?
      - Can I look up a single value list by its code?
      instructions:
      - text: Get value list {code}.
        slots:
          code: query.code
      - text: List all operator value lists.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/products'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up products by reference
      effect: read
      questions:
      - How do I find products by EAN or other product references?
      - What is the maximum number of products returned when looking up by reference?
      instructions:
      - text: Get products for references {product_references}.
        slots:
          product_references: query.product_references
      - text: Look up the product with reference {product_references}.
        slots:
          product_references: query.product_references
      method: generated
      generated: '2026-09-26'