Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Customer REST endpoints - All inclusive…

2 actions 2 updates phrasing extends openapi/adobe-suite-carts-guest-carts-cartid-checkgiftcard-giftcardcode-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 2

$.info

$.paths['/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Commerce Customer REST endpoints - All inclusive…
  version: 1.0.0
extends: openapi/adobe-suite-carts-guest-carts-cartid-checkgiftcard-giftcardcode-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: 1
- target: $.paths['/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a gift card balance on a guest cart
      effect: read
      questions:
      - How much balance is left on a gift card a guest added to their cart?
      - Can a guest shopper check a gift card's remaining value before checkout?
      instructions:
      - text: Check the balance of gift card {code} on guest cart {cart}.
        slots:
          code: path.giftCardCode
          cart: path.cartId
      - text: Tell me what gift card {code} is worth in cart {cart}.
        slots:
          code: path.giftCardCode
          cart: path.cartId
      method: generated
      generated: '2026-09-26'