Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Partner Transfers API

7 actions 7 updates phrasing extends openapi/adobe-suite-transfers-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/memberships/{membership-id}/offers'].get
$.paths['/v2/memberships/{membership-id}/transfers'].post
$.paths['/v2/memberships/{membership-id}/transfers/{transfer-id}'].get
$.paths['/v3/memberships/{membership-id}/offers'].get
$.paths['/v3/memberships/{membership-id}/transfers'].post
$.paths['/v3/memberships/{membership-id}/transfers/{transfer-id}'].get

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 Transfers API
  version: 1.0.0
extends: openapi/adobe-suite-transfers-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/memberships/{membership-id}/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview transfer offers for a membership (v2)
      effect: read
      questions:
      - Which offers would carry over if I transfer a membership using the v2 API?
      - Can the v2 transfer preview ignore order returns?
      instructions:
      - text: Preview v2 transfer offers for membership {membership-id}.
        slots:
          membership-id: path.membership-id
      - text: Using v2, preview offers for membership {membership-id} with ignore-order-return {ignore-order-return}.
        slots:
          membership-id: path.membership-id
          ignore-order-return: query.ignore-order-return
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/memberships/{membership-id}/transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer subscriptions for a membership (v2)
      effect: write
      questions:
      - How do I transfer a customer's VIP subscriptions to a reseller with the v2 endpoint?
      - What does a v2 subscription transfer need besides the membership ID?
      instructions:
      - text: Transfer the subscriptions on membership {membership-id} using v2.
        slots:
          membership-id: path.membership-id
      - text: Via v2, transfer membership {membership-id} to reseller {resellerId} for customer {customerId}.
        slots:
          membership-id: path.membership-id
          resellerId: requestBody.resellerId
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/memberships/{membership-id}/transfers/{transfer-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription transfer's details (v2)
      effect: read
      questions:
      - How do I check the status of a transfer through the v2 API?
      - Can I read v2 transfer details by membership and transfer ID?
      instructions:
      - text: Get v2 transfer {transfer-id} for membership {membership-id}.
        slots:
          transfer-id: path.transfer-id
          membership-id: path.membership-id
      - text: Check the v2 status of transfer {transfer-id} on membership {membership-id}.
        slots:
          transfer-id: path.transfer-id
          membership-id: path.membership-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/memberships/{membership-id}/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview transfer offers for a membership (v3)
      effect: read
      questions:
      - Which offers would move over in a membership transfer on the v3 API?
      - Does the v3 offer preview let me skip order returns?
      instructions:
      - text: Preview v3 transfer offers for membership {membership-id}.
        slots:
          membership-id: path.membership-id
      - text: With v3, preview membership {membership-id} offers setting ignore-order-return to {ignore-order-return}.
        slots:
          membership-id: path.membership-id
          ignore-order-return: query.ignore-order-return
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/memberships/{membership-id}/transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer subscriptions for a membership (v3)
      effect: write
      questions:
      - How do I transfer subscriptions for a membership using the v3 endpoint?
      - Can I record a reason on a v3 subscription transfer?
      instructions:
      - text: Transfer the subscriptions on membership {membership-id} using v3.
        slots:
          membership-id: path.membership-id
      - text: Via v3, transfer membership {membership-id} to reseller {resellerId} with reason {reason}.
        slots:
          membership-id: path.membership-id
          resellerId: requestBody.resellerId
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/memberships/{membership-id}/transfers/{transfer-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription transfer's details (v3)
      effect: read
      questions:
      - Where do I check a transfer's details on the v3 API?
      - Can I look up a v3 transfer by its transfer ID?
      instructions:
      - text: Get v3 transfer {transfer-id} for membership {membership-id}.
        slots:
          transfer-id: path.transfer-id
          membership-id: path.membership-id
      - text: Show the v3 details of transfer {transfer-id} under membership {membership-id}.
        slots:
          transfer-id: path.transfer-id
          membership-id: path.membership-id
      method: generated
      generated: '2026-09-26'