API Evangelist conversational phrasing for Shopify Customer 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 Customer API
  version: 1.0.0
extends: openapi/shopify-customer-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: 24
- target: $.paths['/admin/api/2020-01/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new customer to the store (2020-01)
      effect: write
      questions:
      - How do I add a new customer record to my store with API version 2020-01?
      - Can my app create customers through the 2020-01 version?
      instructions:
      - text: Create a new customer using API version 2020-01.
      - text: Add a customer record to the store on the 2020-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one customer (2020-01)
      effect: read
      questions:
      - Can I look up a single customer by ID on API version 2020-01?
      - Is it possible to fetch only certain fields of a customer with 2020-01?
      instructions:
      - text: Retrieve customer {customer_id} using API version 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Get just the {fields} fields for customer {customer_id} on the 2020-01 version.
        slots:
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer (2020-01)
      effect: write
      questions:
      - Can I change an existing customer's record through API version 2020-01?
      - Which 2020-01 call edits a customer I already have?
      instructions:
      - text: Update customer {customer_id} using API version 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Edit the record of customer {customer_id} on the 2020-01 version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer (2020-01)
      effect: destructive
      questions:
      - How do I permanently remove a customer from my store on 2020-01?
      - Can a customer be deleted through the 2020-01 API version?
      instructions:
      - text: Delete customer {customer_id} using API version 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Remove customer {customer_id} from the store on the 2020-01 version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer (2020-04)
      effect: write
      questions:
      - Can I sign up a new customer programmatically with the 2020-04 release?
      - Which 2020-04 endpoint creates a customer?
      instructions:
      - text: Make a new customer with the 2020-04 release.
      - text: Using release 2020-04, register a customer in my store.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's details (2020-04)
      effect: read
      questions:
      - Where do I read one customer's details on the 2020-04 release?
      - Can release 2020-04 limit a customer lookup to specific fields?
      instructions:
      - text: Fetch customer {customer_id} with the 2020-04 release.
        slots:
          customer_id: path.customer_id
      - text: Using release 2020-04, return only {fields} for customer {customer_id}.
        slots:
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a customer (2020-04)
      effect: write
      questions:
      - Can release 2020-04 modify a customer after they sign up?
      - What's the 2020-04 call to save changes to a customer?
      instructions:
      - text: Modify customer {customer_id} through release 2020-04.
        slots:
          customer_id: path.customer_id
      - text: Using release 2020-04, save changes to customer {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer (2020-04)
      effect: destructive
      questions:
      - Which 2020-04 call deletes a customer for good?
      - Can I erase a customer record with release 2020-04?
      instructions:
      - text: Erase customer {customer_id} with release 2020-04.
        slots:
          customer_id: path.customer_id
      - text: Using release 2020-04, permanently delete customer {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new customer (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API let my app add customers?
      - What's involved in creating a customer on the 2020-07 API?
      instructions:
      - text: Register one new customer on the 2020-07 API.
      - text: For the 2020-07 API, create a customer in my store.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a customer (2020-07)
      effect: read
      questions:
      - What information comes back for a single customer on the 2020-07 API?
      - Can I choose which customer fields come back on 2020-07?
      instructions:
      - text: Get the details of customer {customer_id} from API 2020-07.
        slots:
          customer_id: path.customer_id
      - text: Look up customer {customer_id} on the 2020-07 API, returning only {fields}.
        slots:
          customer_id: path.customer_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API allow editing a customer that already exists?
      - Can I adjust a customer's record through 2020-07?
      instructions:
      - text: Apply changes to customer {customer_id}, API 2020-07.
        slots:
          customer_id: path.customer_id
      - text: Edit customer {customer_id} with the 2020-07 API.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer (2020-07)
      effect: destructive
      questions:
      - Is deleting a customer supported on the 2020-07 API?
      - How would I purge a customer from my store on 2020-07?
      instructions:
      - text: Purge customer {customer_id} from my store on the 2020-07 API.
        slots:
          customer_id: path.customer_id
      - text: Delete customer {customer_id} (API 2020-07).
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer (2020-10, current version)
      effect: write
      questions:
      - How do I create a customer on the current 2020-10 version?
      - Can the non-deprecated 2020-10 API add a customer to my store?
      instructions:
      - text: Create a customer on 2020-10.
      - text: Add a new customer using the non-deprecated 2020-10 API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer (2020-10)
      effect: read
      questions:
      - Can I retrieve a customer by ID with the non-deprecated 2020-10 API?
      - Which customer fields can I restrict the response to on the current 2020-10 version?
      instructions:
      - text: Retrieve customer {customer_id} on 2020-10.
        slots:
          customer_id: path.customer_id
      - text: Show only {fields} for customer {customer_id}, current 2020-10 version.
        slots:
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer (2020-10)
      effect: write
      questions:
      - What's the way to update an existing customer with the current 2020-10 version?
      - Can a customer's details be changed via 2020-10?
      instructions:
      - text: Update customer {customer_id} on 2020-10.
        slots:
          customer_id: path.customer_id
      - text: Change customer {customer_id} with the non-deprecated 2020-10 API.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer (2020-10)
      effect: destructive
      questions:
      - Can I delete a customer with the non-deprecated 2020-10 API?
      - Which 2020-10 call removes a customer from the store?
      instructions:
      - text: Delete customer {customer_id} on 2020-10.
        slots:
          customer_id: path.customer_id
      - text: Remove customer {customer_id} from my store using the current 2020-10 version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer (2021-01)
      effect: write
      questions:
      - Is creating a customer possible with version 2021-01?
      - What's the 2021-01 endpoint for adding a new customer?
      instructions:
      - text: With version 2021-01, create a customer.
      - text: Set up a new customer via the 2021-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a customer (2021-01)
      effect: read
      questions:
      - Can version 2021-01 return a single customer by ID?
      - Does 2021-01 let me pick which fields of a customer to fetch?
      instructions:
      - text: With version 2021-01, fetch customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Display the {fields} of customer {customer_id} from the 2021-01 version.
        slots:
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a customer (2021-01)
      effect: write
      questions:
      - Can I modify an existing customer in version 2021-01?
      - Which 2021-01 call updates a customer record?
      instructions:
      - text: With version 2021-01, update customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Revise customer {customer_id} through the 2021-01 version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer (2021-01)
      effect: destructive
      questions:
      - Is it possible to delete a customer through version 2021-01?
      - Which 2021-01 endpoint removes a customer?
      instructions:
      - text: With version 2021-01, delete customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Get rid of customer {customer_id} via the 2021-01 version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer (unstable version)
      effect: write
      questions:
      - Can I test creating a customer against the unstable API version?
      - What does the unstable version expect when adding a customer?
      instructions:
      - text: On the unstable API version, create a customer.
      - text: Try adding a customer using the unstable version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer (unstable version)
      effect: read
      questions:
      - Can I read a single customer from the unstable API version?
      - Does the unstable version support trimming a customer response to chosen fields?
      instructions:
      - text: On the unstable API version, retrieve customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Try fetching only {fields} of customer {customer_id} with the unstable version.
        slots:
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer (unstable version)
      effect: write
      questions:
      - Can I update an existing customer against the unstable API version?
      - How does the unstable version handle edits to a customer?
      instructions:
      - text: On the unstable API version, update customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Try editing customer {customer_id} using the unstable version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer (unstable version)
      effect: destructive
      questions:
      - Can I delete a customer through the unstable API version?
      - Does the unstable version support removing a customer?
      instructions:
      - text: On the unstable API version, delete customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Try removing customer {customer_id} with the unstable version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'