Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Discount API

7 actions 7 updates phrasing extends openapi/shopify-discount-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.json'].get
$.paths['/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.json'].get
$.paths['/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.json'].get
$.paths['/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.json'].get
$.paths['/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json'].get
$.paths['/admin/api/unstable/price_rules/{price_rule_id}/discount_codes.json'].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 Shopify Discount API
  version: 1.0.0
extends: openapi/shopify-discount-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price rule's discount codes (API 2020-01)
      effect: read
      questions:
      - Which discount codes belong to a price rule, on API version 2020-01?
      - Can I see every code generated under one price rule with the 2020-01 release?
      instructions:
      - text: List discount codes for price rule {price_rule_id} using 2020-01.
        slots:
          price_rule_id: path.price_rule_id
      - text: Show all codes attached to price rule {price_rule_id}, API version 2020-01.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price rule's discount codes (API 2020-04)
      effect: read
      questions:
      - What promo codes are tied to a specific price rule in release 2020-04?
      - How do I pull the discount codes of one price rule on version 2020-04?
      instructions:
      - text: Get the discount codes under price rule {price_rule_id} via 2020-04.
        slots:
          price_rule_id: path.price_rule_id
      - text: Using the 2020-04 API, fetch every code for price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price rule's discount codes (API 2020-07)
      effect: read
      questions:
      - Can the 2020-07 API list the coupon codes that a price rule issued?
      - Which codes does a single price rule have, checked with release 2020-07?
      instructions:
      - text: Retrieve price rule {price_rule_id}'s discount codes on 2020-07.
        slots:
          price_rule_id: path.price_rule_id
      - text: Pull the code list for price rule {price_rule_id} with API version 2020-07.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price rule's discount codes (API 2020-10)
      effect: read
      questions:
      - How do I list all the discount codes created for a Shopify price rule?
      - What codes exist under one price rule on the current 2020-10 API?
      instructions:
      - text: List every discount code for price rule {price_rule_id} with API 2020-10.
        slots:
          price_rule_id: path.price_rule_id
      - text: Show me the codes belonging to price rule {price_rule_id}, version 2020-10.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price rule's discount codes (API 2021-01)
      effect: read
      questions:
      - Which discount codes hang off a given price rule in the 2021-01 release?
      - Can I enumerate one price rule's coupon codes using version 2021-01?
      instructions:
      - text: Fetch discount codes of price rule {price_rule_id} through 2021-01.
        slots:
          price_rule_id: path.price_rule_id
      - text: On release 2021-01, list the codes issued by price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/price_rules/{price_rule_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price rule's discount codes (unstable API)
      effect: read
      questions:
      - Can the unstable API version list a price rule's discount codes?
      - What discount codes does one price rule have according to the unstable release?
      instructions:
      - text: List discount codes for price rule {price_rule_id} on the unstable API.
        slots:
          price_rule_id: path.price_rule_id
      - text: Using the unstable version, get all codes under price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'