# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Addresses API
  version: 1.0.0
extends: openapi/shopify-addresses-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: 12
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses (API 2020-01)
      effect: read
      questions:
      - How can I see every shipping and billing address saved for a customer on the 2020-01 API?
      - Can version 2020-01 show all the addresses in one customer's address book?
      instructions:
      - text: List the addresses for customer {customer_id} using version 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Show me customer {customer_id}'s saved addresses on 2020-01.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses/set.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-change a customer's addresses (API 2020-01)
      effect: destructive
      questions:
      - Can I remove several of a customer's saved addresses in one call on the 2020-01 API?
      - Which inputs does the 2020-01 bulk address operation take?
      instructions:
      - text: Run bulk operation {operation} on addresses {address_ids} of customer {customer_id} using 2020-01.
        slots:
          operation: query.operation
          address_ids: query.address_ids[]
          customer_id: path.customer_id
      - text: On version 2020-01, apply {operation} to several addresses of customer {customer_id} at once.
        slots:
          operation: query.operation
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses (API 2020-04)
      effect: read
      questions:
      - What addresses does a customer have on file, per API version 2020-04?
      - Is there a 2020-04 call returning a customer's full address book?
      instructions:
      - text: Retrieve customer {customer_id}'s address list from the 2020-04 Admin API.
        slots:
          customer_id: path.customer_id
      - text: On 2020-04, pull every saved address for {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses/set.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-change a customer's addresses (API 2020-04)
      effect: destructive
      questions:
      - Is it possible to clean up a batch of a customer's old addresses together on 2020-04?
      - What does the 2020-04 addresses set endpoint expect for the address IDs?
      instructions:
      - text: Apply {operation} in bulk to addresses {address_ids} for {customer_id} through the 2020-04 Admin API.
        slots:
          operation: query.operation
          address_ids: query.address_ids[]
          customer_id: path.customer_id
      - text: On 2020-04, batch-process address IDs {address_ids} belonging to customer {customer_id}.
        slots:
          address_ids: query.address_ids[]
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses (API 2020-07)
      effect: read
      questions:
      - Using the 2020-07 release, where do I read all of a customer's addresses?
      - Does 2020-07 list every delivery address a shopper saved?
      instructions:
      - text: Fetch the address book of customer {customer_id} via 2020-07.
        slots:
          customer_id: path.customer_id
      - text: Enumerate {customer_id}'s addresses on the 2020-07 release.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses/set.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-change a customer's addresses (API 2020-07)
      effect: destructive
      questions:
      - Using the 2020-07 release, can I act on many customer addresses in a single request?
      - Does 2020-07 support bulk operations over a customer's address IDs?
      instructions:
      - text: Perform {operation} on customer {customer_id}'s addresses {address_ids} via 2020-07.
        slots:
          operation: query.operation
          customer_id: path.customer_id
          address_ids: query.address_ids[]
      - text: Bulk-update the address set of {customer_id} on the 2020-07 release.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses (current 2020-10)
      effect: read
      questions:
      - Which call lists a customer's addresses on the current 2020-10 version?
      - Can I get all the addresses on a customer account from the non-deprecated API?
      instructions:
      - text: List addresses for customer {customer_id} with the non-deprecated 2020-10 API.
        slots:
          customer_id: path.customer_id
      - text: Using 2020-10, show every address saved on {customer_id}'s account.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses/set.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-change a customer's addresses (current 2020-10)
      effect: destructive
      questions:
      - Which call performs a bulk operation on a customer's addresses on the current 2020-10 version?
      - Can the non-deprecated API delete a batch of a customer's stale addresses?
      instructions:
      - text: Run {operation} across addresses {address_ids} of customer {customer_id} with the non-deprecated 2020-10 API.
        slots:
          operation: query.operation
          address_ids: query.address_ids[]
          customer_id: path.customer_id
      - text: Using 2020-10, bulk-apply {operation} to customer {customer_id}'s address set.
        slots:
          operation: query.operation
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses (API 2021-01)
      effect: read
      questions:
      - Can I still list a customer's addresses on the deprecated 2021-01 version?
      - What does the 2021-01 customer address list return?
      instructions:
      - text: Return all addresses of customer {customer_id} from API version 2021-01.
        slots:
          customer_id: path.customer_id
      - text: Show {customer_id}'s address book via 2021-01.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses/set.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-change a customer's addresses (API 2021-01)
      effect: destructive
      questions:
      - Can I still run bulk address operations for a customer on the deprecated 2021-01 version?
      - What happens to a customer's addresses when I call the 2021-01 set endpoint?
      instructions:
      - text: Execute {operation} on addresses {address_ids} of {customer_id} through API version 2021-01.
        slots:
          operation: query.operation
          address_ids: query.address_ids[]
          customer_id: path.customer_id
      - text: Bulk-process customer {customer_id}'s address IDs {address_ids} via 2021-01.
        slots:
          customer_id: path.customer_id
          address_ids: query.address_ids[]
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses (unstable API)
      effect: read
      questions:
      - How can I list a customer's addresses on the unstable Admin API?
      - Is the customer address list available in the unstable version?
      instructions:
      - text: List addresses of customer {customer_id} on the unstable version.
        slots:
          customer_id: path.customer_id
      - text: Show the unstable-version address book for {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses/set.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-change a customer's addresses (unstable API)
      effect: destructive
      questions:
      - How can I bulk-modify a customer's addresses against the unstable Admin API?
      - Is the bulk address set operation supported in the unstable version?
      instructions:
      - text: Apply {operation} to addresses {address_ids} of customer {customer_id} on the unstable version.
        slots:
          operation: query.operation
          address_ids: query.address_ids[]
          customer_id: path.customer_id
      - text: Run the unstable-version bulk address operation for {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'