Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Partner Customer Accounts API

7 actions 7 updates phrasing extends openapi/adobe-suite-customer-accounts-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 7

$.info
$.paths['/v2/customers'].post
$.paths['/v2/customers/{customer-id}'].get
$.paths['/v2/customers/{customer-id}'].patch
$.paths['/v3/customers'].post
$.paths['/v3/customers/{customer-id}'].get
$.paths['/v3/customers/{customer-id}'].patch

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 Commerce Partner Customer Accounts API
  version: 1.0.0
extends: openapi/adobe-suite-customer-accounts-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: 6
- target: $.paths['/v2/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reseller customer account (v2)
      effect: write
      questions:
      - How does a reseller create a customer account before placing an order, on the v2 API?
      - What company profile details does the v2 create customer call require?
      instructions:
      - text: Create a v2 customer account with company profile {companyProfile}.
        slots:
          companyProfile: requestBody.companyProfile
      - text: Using v2, create a customer for reseller {resellerId} with profile {companyProfile}.
        slots:
          resellerId: requestBody.resellerId
          companyProfile: requestBody.companyProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customers/{customer-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get customer account details (v2)
      effect: read
      questions:
      - How do I look up a customer account by ID on the v2 endpoint?
      - What does the v2 customer account detail include?
      instructions:
      - text: Get v2 customer account {customer-id}.
        slots:
          customer-id: path.customer-id
      - text: Show the v2 details for customer {customer-id}.
        slots:
          customer-id: path.customer-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customers/{customer-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's address and contacts (v2)
      effect: write
      questions:
      - How do I change a customer's address or contact info with the v2 API?
      - Which customer fields can the v2 update call modify?
      instructions:
      - text: Update v2 customer {customer-id} with company profile {companyProfile}.
        slots:
          customer-id: path.customer-id
          companyProfile: requestBody.companyProfile
      - text: Via v2, change the address and contacts of customer {customer-id} to {companyProfile}.
        slots:
          customer-id: path.customer-id
          companyProfile: requestBody.companyProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reseller customer account (v3)
      effect: write
      questions:
      - How does a reseller create a customer account on the current v3 API?
      - Can I set an external reference ID when creating a v3 customer?
      instructions:
      - text: Create a v3 customer account with company profile {companyProfile}.
        slots:
          companyProfile: requestBody.companyProfile
      - text: Using v3, create customer {companyProfile} with external reference {externalReferenceId}.
        slots:
          companyProfile: requestBody.companyProfile
          externalReferenceId: requestBody.externalReferenceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/customers/{customer-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get customer account details (v3)
      effect: read
      questions:
      - Where do I fetch a customer's account record through the current v3 customers endpoint?
      - What does the v3 customer account detail return?
      instructions:
      - text: Get v3 customer account {customer-id}.
        slots:
          customer-id: path.customer-id
      - text: Show the v3 details for customer {customer-id}.
        slots:
          customer-id: path.customer-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/customers/{customer-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's address and contacts (v3)
      effect: write
      questions:
      - Can the newer v3 API edit an end customer's mailing address and contacts?
      - Which customer fields can the v3 update call modify?
      instructions:
      - text: Update v3 customer {customer-id} with company profile {companyProfile}.
        slots:
          customer-id: path.customer-id
          companyProfile: requestBody.companyProfile
      - text: Via v3, change the address and contacts of customer {customer-id} to {companyProfile}.
        slots:
          customer-id: path.customer-id
          companyProfile: requestBody.companyProfile
      method: generated
      generated: '2026-09-26'