Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Customer Addresses API

6 actions 6 updates phrasing extends openapi/lightspeed-customer-addresses-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lightspeed Commerce's API. It is a proposal applied on top of the contract, not a document Lightspeed Commerce publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

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

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

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

$.paths['/customers/{customer_id}/addresses/{address_id}'].put

$.paths['/customers/{customer_id}/addresses/{address_id}'].delete

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 2026-07 Customer Addresses API
  version: 1.0.0
extends: openapi/lightspeed-customer-addresses-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/customers/{customer_id}/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's addresses
      effect: read
      questions:
      - What shipping and billing addresses does a customer have on file?
      - Can I see every address saved for one customer?
      instructions:
      - text: List addresses for customer {customer}.
        slots:
          customer: path.customer_id
      - text: Show all saved addresses of customer {customer}.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}/addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer
      effect: write
      questions:
      - How do I save a new delivery address for a customer?
      - Which address fields are required, like state code for US customers?
      instructions:
      - text: 'Add a {type} address for customer {customer}: {line1}, {city} {postcode}, {country}.'
        slots:
          type: requestBody.type
          customer: path.customer_id
          line1: requestBody.address_line_1
          city: requestBody.city
          postcode: requestBody.postcode
          country: requestBody.country_code
      - text: Save address {line1}, {city}, {state} {postcode}, {country} as a {type} address for customer {customer}.
        slots:
          line1: requestBody.address_line_1
          city: requestBody.city
          state: requestBody.state_code
          postcode: requestBody.postcode
          country: requestBody.country_code
          type: requestBody.type
          customer: path.customer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}/addresses/{address_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one customer address
      effect: read
      questions:
      - Can I fetch a single address for a customer?
      - What details are stored on a specific customer address?
      instructions:
      - text: Get address {address} for customer {customer}.
        slots:
          address: path.address_id
          customer: path.customer_id
      - text: Show customer {customer}'s address {address}.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}/addresses/{address_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer address
      effect: write
      questions:
      - How do I correct a customer's saved address?
      - Can I change the postcode or city on an existing address?
      instructions:
      - text: Update address {address} of customer {customer} to {line1}, {city} {postcode}, {country} as {type}.
        slots:
          address: path.address_id
          customer: path.customer_id
          line1: requestBody.address_line_1
          city: requestBody.city
          postcode: requestBody.postcode
          country: requestBody.country_code
          type: requestBody.type
      - text: Change the postcode on customer {customer}'s address {address} to {postcode}.
        slots:
          customer: path.customer_id
          address: path.address_id
          postcode: requestBody.postcode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}/addresses/{address_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer address
      effect: destructive
      questions:
      - Can I remove an old address from a customer's profile?
      - What does deleting a customer address do?
      instructions:
      - text: Delete address {address} from customer {customer}.
        slots:
          address: path.address_id
          customer: path.customer_id
      - text: Remove customer {customer}'s saved address {address}.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-26'