Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Customer Addresses API

3 actions 3 updates phrasing extends openapi/shopify-customer-addresses-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 3

$.info

$.paths['/customers/{customer_id}/addresses.json'].get

$.paths['/customers/{customer_id}/addresses.json'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Admin REST Customer Addresses API
  version: 1.0.0
extends: openapi/shopify-customer-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: 2
- target: $.paths['/customers/{customer_id}/addresses.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's saved addresses
      effect: read
      questions:
      - What addresses does a customer have saved on their account?
      - Can I cap how many of a customer's addresses come back in one response?
      - How do I pull every mailing address stored for one shopper?
      instructions:
      - text: List the addresses for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show up to {limit} saved addresses for customer {customer_id}.
        slots:
          limit: query.limit
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new address to a customer
      effect: write
      questions:
      - Can I add another mailing address to an existing customer?
      - What's needed to save a new shipping address on a customer's account in Shopify?
      instructions:
      - text: Add the address {address} to customer {customer_id}.
        slots:
          address: requestBody.address
          customer_id: path.customer_id
      - text: Save a new mailing address {address} on customer {customer_id}'s account.
        slots:
          address: requestBody.address
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'