Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Data Ingestion Prices API

4 actions 4 updates phrasing extends openapi/adobe-suite-prices-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/catalog/products/prices'].post
$.paths['/v1/catalog/products/prices'].patch
$.paths['/v1/catalog/products/prices/delete'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Catalog Data Ingestion Prices API
  version: 1.0.0
extends: openapi/adobe-suite-prices-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: 3
- target: $.paths['/v1/catalog/products/prices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or replace product prices
      effect: write
      questions:
      - How do I load regular prices for my catalog SKUs into Adobe Commerce?
      - Can I set tiered pricing and discounts when creating prices?
      - Will sending prices for a SKU that already has one overwrite it?
      instructions:
      - text: Create prices for these SKUs with their regular price and discounts.
      - text: Replace the catalog prices for my products with this gzip-compressed payload encoded as {encoding}.
        slots:
          encoding: header.Content-Encoding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/products/prices'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update existing product prices
      effect: write
      questions:
      - Can I change just the discount on a price without resending everything?
      - What merge rules apply when I partially update product prices?
      instructions:
      - text: Update the existing prices for these SKUs with my changes.
      - text: Patch tiered pricing on my existing price records, compressed as {encoding}.
        slots:
          encoding: header.Content-Encoding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/products/prices/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete product prices
      effect: destructive
      questions:
      - How do I remove prices for SKUs I no longer sell?
      - Can I delete prices for several products in one request?
      instructions:
      - text: Delete the prices for these SKUs.
      - text: Remove price records for my discontinued products, sent as {encoding}.
        slots:
          encoding: header.Content-Encoding
      method: generated
      generated: '2026-09-26'