API Evangelist conversational phrasing for Shopify Code API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Code API
  version: 1.0.0
extends: openapi/shopify-code-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: 48
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a discount code to a price rule (2020-01)
      effect: write
      questions:
      - How do I add a new discount code to a price rule on the 2020-01 API?
      - Can I create a single discount code under an existing price rule with version 2020-01?
      instructions:
      - text: Create a discount code under price rule {price_rule_id} using API version 2020-01.
        slots:
          price_rule_id: path.price_rule_id
      - text: On 2020-01, add one new code to price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one discount code by ID (2020-01)
      effect: read
      questions:
      - Can I fetch a single discount code by its ID on API version 2020-01?
      - What details does the 2020-01 endpoint return for one discount code of a price rule?
      instructions:
      - text: Retrieve discount code {discount_code_id} from price rule {price_rule_id} via 2020-01.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Show me code {discount_code_id} belonging to price rule {price_rule_id}, version 2020-01.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing discount code (2020-01)
      effect: write
      questions:
      - How can I edit a discount code that already exists, using the 2020-01 version?
      - Can I modify a discount code I already created under a price rule in 2020-01?
      instructions:
      - text: Update discount code {discount_code_id} on price rule {price_rule_id} with API version 2020-01.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Edit existing code {discount_code_id} in price rule {price_rule_id} (2020-01).
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a discount code (2020-01)
      effect: destructive
      questions:
      - How do I permanently remove a discount code from a price rule in 2020-01?
      - Can a discount code be deleted through the 2020-01 API version?
      instructions:
      - text: Delete discount code {discount_code_id} from price rule {price_rule_id} using 2020-01.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Remove code {discount_code_id} under price rule {price_rule_id} on version 2020-01.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/discount_codes/lookup.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Find where a discount code lives by its code (2020-01)
      effect: read
      questions:
      - Given only the text a shopper typed, where does that discount code live according to the 2020-01 lookup?
      - Can I locate a discount code by its code string with the 2020-01 lookup?
      instructions:
      - text: Look up the location of discount code {code} using the 2020-01 lookup.
        slots:
          code: query.code
      - text: Find where the code {code} is stored (API 2020-01).
        slots:
          code: query.code
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/batch.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk discount code creation job (2020-01)
      effect: write
      questions:
      - How can I create many discount codes at once for a price rule on 2020-01?
      - Is there a batch job for generating discount codes in bulk in the 2020-01 version?
      instructions:
      - text: Start a discount code creation job for price rule {price_rule_id} on 2020-01.
        slots:
          price_rule_id: path.price_rule_id
      - text: Queue a batch of new codes under price rule {price_rule_id} with API version 2020-01.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a discount code creation job (2020-01)
      effect: read
      questions:
      - What is the status of my bulk discount code job on 2020-01?
      - Has my batch discount code creation job finished, on the 2020-01 API?
      instructions:
      - text: Get creation job {batch_id} for price rule {price_rule_id} via 2020-01.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Check progress of batch {batch_id} on price rule {price_rule_id}, version 2020-01.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List codes produced by a creation job (2020-01)
      effect: read
      questions:
      - Which discount codes did my batch creation job produce, using 2020-01?
      - Can I list every code a discount code creation job generated with the 2020-01 API?
      instructions:
      - text: List the discount codes created by job {batch_id} for price rule {price_rule_id} on 2020-01.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Show codes from batch {batch_id} under price rule {price_rule_id} (2020-01).
        slots:
          batch_id: path.batch_id
          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'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a discount code for a price rule (2020-04)
      effect: write
      questions:
      - Can I generate one new discount code for an existing price rule through version 2020-04?
      - What does the 2020-04 release need to create a discount code under a price rule?
      instructions:
      - text: Using version 2020-04, make a new discount code for price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      - text: Add a single code to price rule {price_rule_id} through the 2020-04 endpoint.
        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/{discount_code_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single discount code (2020-04)
      effect: read
      questions:
      - Where can I read back one discount code's details with the 2020-04 release?
      - Can the 2020-04 version fetch a discount code if I know its ID and price rule?
      instructions:
      - text: Fetch discount code {discount_code_id} of price rule {price_rule_id} with the 2020-04 release.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Pull up the 2020-04 record for code {discount_code_id} in price rule {price_rule_id}.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing discount code (2020-04)
      effect: write
      questions:
      - Can I change a discount code after creating it, using release 2020-04?
      - What's the 2020-04 call for modifying a discount code already attached to a price rule?
      instructions:
      - text: Modify discount code {discount_code_id} in price rule {price_rule_id} through release 2020-04.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: With 2020-04, save changes to code {discount_code_id} of price rule {price_rule_id}.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a discount code (2020-04)
      effect: destructive
      questions:
      - Can I delete a discount code shoppers should no longer use, with release 2020-04?
      - Which 2020-04 call removes a discount code from its price rule for good?
      instructions:
      - text: Using release 2020-04, delete code {discount_code_id} from price rule {price_rule_id}.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Permanently drop discount code {discount_code_id} of price rule {price_rule_id} in 2020-04.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/discount_codes/lookup.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Locate a discount code by its code text (2020-04)
      effect: read
      questions:
      - If I only know the discount code a customer entered, can 2020-04 tell me where it lives?
      - Which 2020-04 endpoint resolves a code string to its discount code record?
      instructions:
      - text: Resolve the discount code {code} to its location with release 2020-04.
        slots:
          code: query.code
      - text: Using 2020-04, find where code {code} is stored.
        slots:
          code: query.code
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/price_rules/{price_rule_id}/batch.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a bulk discount code creation job (2020-04)
      effect: write
      questions:
      - Can I generate discount codes in bulk for one price rule with the 2020-04 release?
      - What's the 2020-04 way to kick off a batch of new discount codes?
      instructions:
      - text: Kick off a bulk code creation job on price rule {price_rule_id} through 2020-04.
        slots:
          price_rule_id: path.price_rule_id
      - text: Create a discount code batch for price rule {price_rule_id} using release 2020-04.
        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}/batch/{batch_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a discount code creation job's status (2020-04)
      effect: read
      questions:
      - Can I poll a bulk discount code job for completion on release 2020-04?
      - Where do I see whether a 2020-04 discount code batch is still running?
      instructions:
      - text: Poll batch job {batch_id} on price rule {price_rule_id} with release 2020-04.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Using 2020-04, report the state of creation job {batch_id} for price rule {price_rule_id}.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List discount codes from a creation job (2020-04)
      effect: read
      questions:
      - After a bulk job finishes, how can I get its discount codes on release 2020-04?
      - Can 2020-04 list the codes that belong to one creation job?
      instructions:
      - text: Using release 2020-04, list codes generated by batch {batch_id} on price rule {price_rule_id}.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Fetch the discount codes from creation job {batch_id}, price rule {price_rule_id}, in 2020-04.
        slots:
          batch_id: path.batch_id
          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'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a new discount code on a price rule (2020-07)
      effect: write
      questions:
      - How would I issue a fresh discount code for a promotion's price rule on 2020-07?
      - Does the 2020-07 API let me attach a new code to a price rule I already set up?
      instructions:
      - text: Issue a new discount code on price rule {price_rule_id} (API 2020-07).
        slots:
          price_rule_id: path.price_rule_id
      - text: For the 2020-07 API, create one code tied to 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/{discount_code_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one discount code's details (2020-07)
      effect: read
      questions:
      - What information comes back for a single discount code on the 2020-07 API?
      - Can I look at one specific code under a price rule with 2020-07?
      instructions:
      - text: Get the details of code {discount_code_id} under price rule {price_rule_id} from API 2020-07.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Read discount code {discount_code_id} for price rule {price_rule_id} on the 2020-07 API.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a discount code (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API allow editing a discount code that shoppers already use?
      - Can I adjust an existing code on a price rule through 2020-07?
      instructions:
      - text: Apply changes to discount code {discount_code_id} on price rule {price_rule_id}, API 2020-07.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Edit code {discount_code_id} belonging to price rule {price_rule_id} with the 2020-07 API.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a discount code from a price rule (2020-07)
      effect: destructive
      questions:
      - How can I retire a discount code by deleting it on the 2020-07 API?
      - Is deleting a single code under a price rule supported in 2020-07?
      instructions:
      - text: Retire discount code {discount_code_id} by deleting it from price rule {price_rule_id} (API 2020-07).
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Delete code {discount_code_id} on price rule {price_rule_id} with the 2020-07 API.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/discount_codes/lookup.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a discount code by its code (2020-07)
      effect: read
      questions:
      - A customer gave me a promo code; can the 2020-07 API show me where that discount code lives?
      - Is there a 2020-07 lookup that searches discount codes by their code value?
      instructions:
      - text: Look up promo code {code} with the 2020-07 API.
        slots:
          code: query.code
      - text: Find the discount code record for {code} on API 2020-07.
        slots:
          code: query.code
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/price_rules/{price_rule_id}/batch.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-create discount codes for a price rule (2020-07)
      effect: write
      questions:
      - Is bulk generation of discount codes for a single price rule available on 2020-07?
      - What's involved in creating a large set of codes in one job with the 2020-07 API?
      instructions:
      - text: Bulk-create discount codes for price rule {price_rule_id} on the 2020-07 API.
        slots:
          price_rule_id: path.price_rule_id
      - text: Start a 2020-07 creation job that adds codes to 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}/batch/{batch_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a discount code creation job (2020-07)
      effect: read
      questions:
      - Can the 2020-07 API tell me if a discount code creation job is done?
      - What status does a bulk code job report on 2020-07?
      instructions:
      - text: Retrieve creation job {batch_id} of price rule {price_rule_id} from the 2020-07 API.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Check whether batch {batch_id} on price rule {price_rule_id} has finished, using 2020-07.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the codes a creation job produced (2020-07)
      effect: read
      questions:
      - What codes came out of my 2020-07 bulk discount job?
      - Can I pull the full set of codes from one creation job on API 2020-07?
      instructions:
      - text: Get the codes produced by creation job {batch_id} for price rule {price_rule_id} (API 2020-07).
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: List batch {batch_id}'s discount codes on price rule {price_rule_id} via the 2020-07 API.
        slots:
          batch_id: path.batch_id
          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'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a discount code (2020-10, current version)
      effect: write
      questions:
      - How do I create a discount code for a price rule on the current 2020-10 version?
      - What's needed to add a code to a price rule in 2020-10?
      instructions:
      - text: Create a new discount code for price rule {price_rule_id} on 2020-10.
        slots:
          price_rule_id: path.price_rule_id
      - text: Add a discount code to my price rule {price_rule_id} using the non-deprecated 2020-10 API.
        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/{discount_code_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a discount code (2020-10)
      effect: read
      questions:
      - Can I retrieve one discount code by ID with the non-deprecated 2020-10 API?
      - Which details of a single price rule code does 2020-10 return?
      instructions:
      - text: Retrieve discount code {discount_code_id} for price rule {price_rule_id} on 2020-10.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Show discount code {discount_code_id} from price rule {price_rule_id}, current 2020-10 version.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a discount code (2020-10)
      effect: write
      questions:
      - What's the way to update an existing discount code with the current 2020-10 version?
      - Can a code already on a price rule be changed via 2020-10?
      instructions:
      - text: Update discount code {discount_code_id} under price rule {price_rule_id} on 2020-10.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Change existing code {discount_code_id} for price rule {price_rule_id} with the 2020-10 API.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a discount code (2020-10)
      effect: destructive
      questions:
      - Can I delete a discount code with the non-deprecated 2020-10 API?
      - Which 2020-10 call removes one code from a price rule?
      instructions:
      - text: Delete discount code {discount_code_id} from price rule {price_rule_id} on 2020-10.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Remove code {discount_code_id} for price rule {price_rule_id} using the current 2020-10 version.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/discount_codes/lookup.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a discount code by its code value (2020-10)
      effect: read
      questions:
      - How can I find a discount code's location from its code text on 2020-10?
      - Does the current 2020-10 API have a lookup by discount code value?
      instructions:
      - text: Find the location of discount code {code} using the 2020-10 lookup.
        slots:
          code: query.code
      - text: Look up code {code} with the current 2020-10 version.
        slots:
          code: query.code
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/price_rules/{price_rule_id}/batch.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a discount code creation job (2020-10)
      effect: write
      questions:
      - Can I create discount codes in bulk on the current 2020-10 version?
      - What does a 2020-10 batch job for new discount codes need?
      instructions:
      - text: Create a discount code creation job for price rule {price_rule_id} on 2020-10.
        slots:
          price_rule_id: path.price_rule_id
      - text: Generate codes in bulk for price rule {price_rule_id} with the non-deprecated 2020-10 API.
        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}/batch/{batch_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a discount code creation job (2020-10)
      effect: read
      questions:
      - How do I check whether a 2020-10 discount code batch has completed?
      - Can I retrieve one creation job by ID on the current 2020-10 API?
      instructions:
      - text: Retrieve creation job {batch_id} for price rule {price_rule_id} on 2020-10.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Check the status of batch {batch_id} under price rule {price_rule_id} using the current 2020-10 version.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a creation job's discount codes (2020-10)
      effect: read
      questions:
      - Which codes did a discount code creation job produce, on the current 2020-10 API?
      - Can 2020-10 list all discount codes from one bulk job?
      instructions:
      - text: List discount codes created by batch {batch_id} for price rule {price_rule_id} on 2020-10.
        slots:
          batch_id: path.batch_id
          price_rule_id: path.price_rule_id
      - text: Show the codes job {batch_id} generated for price rule {price_rule_id}, current 2020-10 version.
        slots:
          batch_id: path.batch_id
          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'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a discount code on a price rule (2021-01)
      effect: write
      questions:
      - Is creating a discount code under a price rule possible with version 2021-01?
      - What's the 2021-01 endpoint for adding one code to a price rule?
      instructions:
      - text: With version 2021-01, create a discount code under price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      - text: Set up one new code on price rule {price_rule_id} via the 2021-01 version.
        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/{discount_code_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a single discount code (2021-01)
      effect: read
      questions:
      - Can version 2021-01 return a single discount code by its ID?
      - What does one price rule code look like when fetched through 2021-01?
      instructions:
      - text: With version 2021-01, fetch discount code {discount_code_id} on price rule {price_rule_id}.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Display code {discount_code_id} of price rule {price_rule_id} from the 2021-01 version.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a discount code (2021-01)
      effect: write
      questions:
      - Can I modify a price rule's existing discount code in version 2021-01?
      - Which 2021-01 call updates a code that already exists?
      instructions:
      - text: With version 2021-01, update code {discount_code_id} on price rule {price_rule_id}.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Revise discount code {discount_code_id} in price rule {price_rule_id} through the 2021-01 version.
        slots:
          discount_code_id: path.discount_code_id
          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/{discount_code_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a discount code (2021-01)
      effect: destructive
      questions:
      - Is it possible to delete one discount code through version 2021-01?
      - Which 2021-01 endpoint deletes a code under a price rule?
      instructions:
      - text: With version 2021-01, delete discount code {discount_code_id} on price rule {price_rule_id}.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      - text: Get rid of code {discount_code_id} from price rule {price_rule_id} via the 2021-01 version.
        slots:
          discount_code_id: path.discount_code_id
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/discount_codes/lookup.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Locate a discount code by code string (2021-01)
      effect: read
      questions:
      - Can version 2021-01 locate a discount code when all I have is its code?
      - Which 2021-01 endpoint turns a code string into its discount code location?
      instructions:
      - text: With version 2021-01, locate discount code {code}.
        slots:
          code: query.code
      - text: Get the location for the code {code} through the 2021-01 version.
        slots:
          code: query.code
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/price_rules/{price_rule_id}/batch.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk discount code job (2021-01)
      effect: write
      questions:
      - Can version 2021-01 create discount codes for a price rule in one batch job?
      - Which 2021-01 call launches bulk code generation?
      instructions:
      - text: With version 2021-01, start a bulk creation job for price rule {price_rule_id}.
        slots:
          price_rule_id: path.price_rule_id
      - text: Launch a batch of discount codes on price rule {price_rule_id} through the 2021-01 version.
        slots:
          price_rule_id: path.price_rule_id
      method: generated
      generated: '2026-09-24'


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/overlays/shopify-code-api-phrasing-overlay.yaml