API Evangelist conversational phrasing for Shopify Customers 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 Customers API
  version: 1.0.0
extends: openapi/shopify-customers-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: 49
- target: $.paths['/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers
      effect: read
      questions:
      - How do I pull a list of my Shopify customers, up to 250 at a time?
      - Which customers signed up between two dates?
      - Can I get only the customers whose records changed since last week?
      instructions:
      - text: List my customers created between {created_at_min} and {created_at_max}.
        slots:
          created_at_min: query.created_at_min
          created_at_max: query.created_at_max
      - text: Show customers updated after {updated_at_min}, at most {limit} of them.
        slots:
          updated_at_min: query.updated_at_min
          limit: query.limit
      - text: Fetch just the customers with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer
      effect: write
      questions:
      - Can I add a new customer record and have a welcome email sent to them?
      - What does it take to register a shopper as a customer from my app?
      instructions:
      - text: Create a new customer from {customer}.
        slots:
          customer: requestBody.customer
      - text: Add customer {customer} to the store and send the welcome email.
        slots:
          customer: requestBody.customer
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customers
      effect: read
      questions:
      - How many customers does my store have in total?
      - Is there a quick way to get just the customer total without paging through records?
      instructions:
      - text: Tell me the total number of customers in my store.
      - text: Count all customer records.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers by name, email or phone
      effect: read
      questions:
      - Can I find a customer by typing part of their email address or phone number?
      - What's the fastest way to look up a shopper by name?
      instructions:
      - text: Search customers for {query}.
        slots:
          query: query.query
      - text: Find up to {limit} customers matching {query}, returning only {fields}.
        slots:
          limit: query.limit
          query: query.query
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers/{customer_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer
      effect: read
      questions:
      - What details are stored for one particular customer ID?
      - Can I fetch a single customer and keep only a few fields in the response?
      instructions:
      - text: Show me customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Get only {fields} for customer {customer_id}.
        slots:
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers/{customer_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer
      effect: write
      questions:
      - How can I change a customer's details after their record already exists?
      - Can my app edit an existing shopper's profile?
      instructions:
      - text: Update customer {customer_id} with {customer}.
        slots:
          customer_id: path.customer_id
          customer: requestBody.customer
      - text: Save these profile changes {customer} to existing customer {customer_id}.
        slots:
          customer: requestBody.customer
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders
      effect: read
      questions:
      - What has a specific customer ordered from my shop?
      - Can I filter one shopper's order history by status?
      instructions:
      - text: List every order placed by customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s orders with status {status}.
        slots:
          customer_id: path.customer_id
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers (API 2020-01)
      effect: read
      questions:
      - Where is the customer list endpoint in the 2020-01 Admin API?
      - Can I page customers with since_id on API version 2020-01?
      instructions:
      - text: Using version 2020-01, list customers after ID {since_id}.
        slots:
          since_id: query.since_id
      - text: With the 2020-01 API, get customers created from {created_at_min}.
        slots:
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers (API 2020-01)
      effect: read
      questions:
      - Which 2020-01 endpoint searches customers by a text query?
      - Can results from the 2020-01 customer search be sorted?
      instructions:
      - text: Search customers matching {query} via the 2020-01 API.
        slots:
          query: query.query
      - text: On version 2020-01, find customers for {query} sorted by {order}.
        slots:
          query: query.query
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns the store's customers?
      - Is filtering the customer list by update date supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch customers changed before {updated_at_max}.
        slots:
          updated_at_max: query.updated_at_max
      - text: Return {limit} customers with the April 2020 endpoint.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers (API 2020-04)
      effect: read
      questions:
      - What April 2020 (2020-04) call looks up customers matching a query?
      - Is ordering customer search results possible in the 2020-04 release?
      instructions:
      - text: Look up customers for {query} on the 2020-04 release.
        slots:
          query: query.query
      - text: With the April 2020 endpoint, search {query} and order results by {order}.
        slots:
          query: query.query
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers (API 2020-07)
      effect: read
      questions:
      - My app is pinned to 2020-07; what lists customers there?
      - Can the July 2020 API return customers by a set of IDs?
      instructions:
      - text: Pull customers {ids} using July 2020 (2020-07).
        slots:
          ids: query.ids
      - text: With API 2020-07, list shoppers created until {created_at_max}.
        slots:
          created_at_max: query.created_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers (API 2020-07)
      effect: read
      questions:
      - My app targets 2020-07; what searches customers there?
      - Can the July 2020 API search shoppers and cap the result count?
      instructions:
      - text: Search shoppers for {query} using July 2020 (2020-07).
        slots:
          query: query.query
      - text: With API 2020-07, return at most {limit} customer matches for {query}.
        slots:
          limit: query.limit
          query: query.query
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for listing customers?
      - Does the October 2020 API filter customers by when they were updated?
      instructions:
      - text: List customers updated since {updated_at_min} on the October 2020 version.
        slots:
          updated_at_min: query.updated_at_min
      - text: Get the 2020-10 customer list, showing only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for a customer search?
      - Does the October 2020 customer search let me choose the sort order?
      instructions:
      - text: Run a customer search for {query} on the October 2020 version.
        slots:
          query: query.query
      - text: Search 2020-10 customers by {query}, ordered by {order}.
        slots:
          query: query.query
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I list customers?
      - Can I page through customers with the January 2021 API version?
      instructions:
      - text: Page customers after {since_id} through API version 2021-01.
        slots:
          since_id: query.since_id
      - text: List {limit} customers against January 2021.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I search customers?
      - Can I query customers by email with the January 2021 API version?
      instructions:
      - text: Query customers for {query} through API version 2021-01.
        slots:
          query: query.query
      - text: Search customers matching {query} against January 2021, fields {fields} only.
        slots:
          query: query.query
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for listing customers?
      - Can I test the customer list against the unstable API version?
      instructions:
      - text: List customers on the unstable API.
      - text: Against the unstable version, test listing customers created after {created_at_min}.
        slots:
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for searching customers?
      - Can I try customer search queries against the unstable API version?
      instructions:
      - text: Search customers for {query} on the unstable API.
        slots:
          query: query.query
      - text: Against the unstable version, try a customer query {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer saved searches (API 2020-01)
      effect: read
      questions:
      - Where do I list the saved customer searches (segments) on the 2020-01 API?
      - Can I page saved customer searches with since_id on version 2020-01?
      instructions:
      - text: List customer saved searches via the 2020-01 API.
      - text: Using version 2020-01, show saved customer searches after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer saved search (API 2020-01)
      effect: write
      questions:
      - Can I save a customer search for reuse with the 2020-01 API?
      - Which 2020-01 endpoint creates a new customer saved search?
      instructions:
      - text: Create a customer saved search via the 2020-01 API.
      - text: Using version 2020-01, save a new customer segment search.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer saved search (API 2020-01)
      effect: read
      questions:
      - How can I read one saved customer search by ID on the 2020-01 API?
      - What does a single customer saved search contain in version 2020-01?
      instructions:
      - text: Get customer saved search {customer_saved_search_id} via the 2020-01 API.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Using version 2020-01, show fields {fields} of saved search {customer_saved_search_id}.
        slots:
          fields: query.fields
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer saved search (API 2020-01)
      effect: write
      questions:
      - Can I edit an existing customer saved search using the 2020-01 API?
      - Which 2020-01 endpoint changes a saved customer segment?
      instructions:
      - text: Update customer saved search {customer_saved_search_id} via the 2020-01 API.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Using version 2020-01, edit saved segment {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer saved search (API 2020-01)
      effect: destructive
      questions:
      - Can I remove a customer saved search I no longer use, on the 2020-01 API?
      - Which 2020-01 endpoint deletes a saved customer segment?
      instructions:
      - text: Delete customer saved search {customer_saved_search_id} via the 2020-01 API.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Using version 2020-01, remove saved segment {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer saved searches (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns all customer saved searches?
      - Is limiting the number of saved searches returned supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch the store's customer saved searches.
      - text: Return {limit} saved customer searches with the April 2020 endpoint.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer saved search (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint adds a customer saved search?
      - Is creating saved customer segments supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, add a customer saved search.
      - text: Store a new saved customer segment with the April 2020 endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer saved search (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns one customer saved search?
      - Is fetching a saved customer segment by ID supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Pull customer segment {customer_saved_search_id} with the April 2020 endpoint.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer saved search (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint modifies a customer saved search?
      - Is editing a saved customer segment supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, modify saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Apply changes to customer segment {customer_saved_search_id} with the April 2020 endpoint.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer saved search (API 2020-04)
      effect: destructive
      questions:
      - Which April 2020 (2020-04) endpoint deletes a customer saved search?
      - Is removing a saved customer segment supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, delete saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Remove customer segment {customer_saved_search_id} with the April 2020 endpoint.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer saved searches (API 2020-07)
      effect: read
      questions:
      - My app targets 2020-07; what lists customer saved searches there?
      - Can the July 2020 API show every saved customer segment in my store?
      instructions:
      - text: Show every saved customer segment using July 2020 (2020-07).
      - text: With API 2020-07, list saved searches returning only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer saved search (API 2020-07)
      effect: write
      questions:
      - My app targets 2020-07; what creates a customer saved search there?
      - Can the July 2020 API save a customer filter as a reusable segment?
      instructions:
      - text: Save a customer filter as a reusable segment using July 2020 (2020-07).
      - text: With API 2020-07, create a new customer saved search.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer saved search (API 2020-07)
      effect: read
      questions:
      - My app targets 2020-07; what reads one customer saved search there?
      - Can the July 2020 API show the query behind a saved customer segment?
      instructions:
      - text: Show the query behind saved segment {customer_saved_search_id} using July 2020 (2020-07).
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: With API 2020-07, read customer saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer saved search (API 2020-07)
      effect: write
      questions:
      - My app targets 2020-07; what updates a customer saved search there?
      - Can the July 2020 API revise a saved customer segment?
      instructions:
      - text: Revise saved customer segment {customer_saved_search_id} using July 2020 (2020-07).
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: With API 2020-07, write updates to saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer saved search (API 2020-07)
      effect: destructive
      questions:
      - My app targets 2020-07; what deletes a customer saved search there?
      - Can the July 2020 API get rid of an outdated customer segment?
      instructions:
      - text: Get rid of outdated segment {customer_saved_search_id} using July 2020 (2020-07).
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: With API 2020-07, delete customer saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer saved searches (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for listing customer saved searches?
      - Does the October 2020 API page saved customer segments by since_id?
      instructions:
      - text: List saved customer segments after {since_id} on the October 2020 version.
        slots:
          since_id: query.since_id
      - text: Get all 2020-10 customer saved searches.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer saved search (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for creating a customer saved search?
      - Does the October 2020 API let me define a new saved customer segment?
      instructions:
      - text: Define a new saved customer segment on the October 2020 version.
      - text: Create a 2020-10 customer saved search.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer saved search (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for retrieving one customer saved search?
      - Does the October 2020 API return a single saved customer segment by ID?
      instructions:
      - text: Return saved customer segment {customer_saved_search_id} on the October 2020 version.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Retrieve the 2020-10 customer saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer saved search (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for updating a customer saved search?
      - Does the October 2020 API let me change a saved customer segment?
      instructions:
      - text: Change saved customer segment {customer_saved_search_id} on the October 2020 version.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Update the 2020-10 customer saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer saved search (API 2020-10)
      effect: destructive
      questions:
      - What is the 2020-10 call for deleting a customer saved search?
      - Does the October 2020 API let me drop a saved customer segment?
      instructions:
      - text: Drop saved customer segment {customer_saved_search_id} on the October 2020 version.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Delete the 2020-10 customer saved search {customer_saved_search_id}.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer saved searches (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I list customer saved searches?
      - Can I cap how many saved customer segments come back with the January 2021 API?
      instructions:
      - text: List customer saved searches through API version 2021-01.
      - text: Return up to {limit} saved customer segments against January 2021.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer saved search (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 API, where do I create a customer saved search?
      - Can I add a saved customer segment with the January 2021 API version?
      instructions:
      - text: Create a customer saved search through API version 2021-01.
      - text: Add a saved customer segment against January 2021.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer saved search (API 2021-01)
      effect: read
      questions:
      - My integration runs on 2021-01; what returns a single customer saved search by its ID?
      - Can the January 2021 API show me what filter one saved segment uses?
      instructions:
      - text: Inspect customer saved search {customer_saved_search_id} through API version 2021-01.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Show saved segment {customer_saved_search_id} against January 2021, fields {fields} only.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer saved search (API 2021-01)
      effect: write
      questions:
      - Is there a 2021-01 endpoint to change the query of an existing saved customer search?
      - Can January 2021 apps rewrite a segment they already saved?
      instructions:
      - text: Amend customer saved search {customer_saved_search_id} through API version 2021-01.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Push an update for saved segment {customer_saved_search_id} against January 2021.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer saved search (API 2021-01)
      effect: destructive
      questions:
      - Which 2021-01 call permanently removes a customer saved search?
      - Will the January 2021 API let me clean out segments nobody uses anymore?
      instructions:
      - text: Delete customer saved search {customer_saved_search_id} through API version 2021-01.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      - text: Erase saved segment {customer_saved_search_id} against January 2021.
        slots:
          customer_saved_search_id: path.customer_saved_search_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customer_saved_searches.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer saved searches (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for listing customer saved searches?
      - Can I test listing saved customer segments against the unstable API version?
      instructions:
      - text: List customer saved searches on the unstable API.
      - text: Against the unstable version, test listing saved segments after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customer_saved_searches.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer saved search (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for creating a customer saved search?
      - Can I test creating saved customer segments against the unstable API version?
      instructions:
      - text: Create a customer saved search on the unstable API.
      - text: Against the unstable version, test saving a new customer segment.
      method: generated
      generated: '2026-09-24'


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