Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Ecommerce API

9 actions 9 updates phrasing extends openapi/mapp-ecommerce-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mapp Marketing Cloud's API. It is a proposal applied on top of the contract, not a document Mapp Marketing Cloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/ecommerce/createWishlistItem'].post
$.paths['/ecommerce/createAbandonedBrowseItem'].post
$.paths['/ecommerce/createAbandonedCartItem'].post
$.paths['/ecommerce/removeTransaction'].delete
$.paths['/ecommerce/removeWishlistItem'].delete
$.paths['/ecommerce/removeAbandonedBrowseItem'].delete
$.paths['/ecommerce/removeAbandonedCartItem'].delete
$.paths['/ecommerce/registerTransaction'].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 Mapp Engage public Ecommerce API
  version: 1.0.0
extends: openapi/mapp-ecommerce-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: 8
- target: $.paths['/ecommerce/createWishlistItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a wish list item for a customer
      effect: write
      questions:
      - Can I record a product a shopper added to their wish list?
      - What product details go into a wish list item, like SKU, price and size?
      instructions:
      - text: Add wish list item {wishlistItem} for {userEmail}.
        slots:
          wishlistItem: query.wishlistItem
          userEmail: query.userEmail
      - text: Save product SKU 2022-01-13-2 to {userEmail}'s wish list as {wishlistItem}.
        slots:
          userEmail: query.userEmail
          wishlistItem: query.wishlistItem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/createAbandonedBrowseItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an abandoned browse item
      effect: write
      questions:
      - How do I log a product a shopper viewed but didn't buy?
      - Can abandoned browsing be tracked per customer email?
      instructions:
      - text: Record abandoned browse item {wishlistItem} for {userEmail}.
        slots:
          wishlistItem: query.wishlistItem
          userEmail: query.userEmail
      - text: Log that {userEmail} browsed product {wishlistItem} and left.
        slots:
          userEmail: query.userEmail
          wishlistItem: query.wishlistItem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/createAbandonedCartItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an abandoned cart item
      effect: write
      questions:
      - Can I record a product left in a shopper's cart to drive recovery emails?
      - What's needed to log an abandoned cart item for a customer?
      instructions:
      - text: Record abandoned cart item {wishlistItem} for {userEmail}.
        slots:
          wishlistItem: query.wishlistItem
          userEmail: query.userEmail
      - text: Log that {userEmail} left {wishlistItem} in their cart.
        slots:
          userEmail: query.userEmail
          wishlistItem: query.wishlistItem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/removeTransaction'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer's transaction
      effect: destructive
      questions:
      - How do I delete an order I registered for a customer by mistake?
      - Can a transaction be removed by order ID?
      instructions:
      - text: Delete transaction {orderId} for {userEmail}.
        slots:
          orderId: query.orderId
          userEmail: query.userEmail
      - text: Remove order {orderId} from {userEmail}'s purchase history.
        slots:
          orderId: query.orderId
          userEmail: query.userEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/removeWishlistItem'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a wish list item
      effect: destructive
      questions:
      - How do I take a product off a customer's wish list?
      - Can wish list items be deleted by SKU?
      instructions:
      - text: Remove {productSKU} from {userEmail}'s wish list.
        slots:
          productSKU: query.productSKU
          userEmail: query.userEmail
      - text: Delete wish list product {productSKU} for {userEmail}.
        slots:
          productSKU: query.productSKU
          userEmail: query.userEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/removeAbandonedBrowseItem'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an abandoned browse item
      effect: destructive
      questions:
      - Can I clear a browsed product from a shopper's abandoned browse list?
      - Which call deletes an abandoned browse record by SKU?
      instructions:
      - text: Remove abandoned browse item {productSKU} for {userEmail}.
        slots:
          productSKU: query.productSKU
          userEmail: query.userEmail
      - text: Clear {productSKU} from {userEmail}'s browse abandonment.
        slots:
          productSKU: query.productSKU
          userEmail: query.userEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/removeAbandonedCartItem'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an abandoned cart item
      effect: destructive
      questions:
      - How do I drop a product from a shopper's abandoned cart once they buy it?
      - Can abandoned cart items be deleted by SKU?
      instructions:
      - text: Remove abandoned cart item {productSKU} for {userEmail}.
        slots:
          productSKU: query.productSKU
          userEmail: query.userEmail
      - text: Clear {productSKU} from {userEmail}'s abandoned cart.
        slots:
          productSKU: query.productSKU
          userEmail: query.userEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/registerTransaction'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an ecommerce purchase
      effect: write
      questions:
      - Can I send completed orders into Mapp Engage with line items and custom columns?
      - What order details can a registered transaction carry, like brand and store?
      instructions:
      - text: Register transaction {transaction} for {userEmail}.
        slots:
          transaction: query.transaction
          userEmail: query.userEmail
      - text: Record the purchase {transaction} made by {userEmail}.
        slots:
          transaction: query.transaction
          userEmail: query.userEmail
      method: generated
      generated: '2026-09-26'