API Evangelist conversational phrasing for Squarespace Inventory API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Squarespace Inventory API
  version: 1.0.0
extends: openapi/squarespace-inventory-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/1.0/commerce/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels via the 1.0 inventory endpoint
      effect: read
      questions:
      - How do I pull current stock levels for every variant using the versioned 1.0 inventory API?
      - Can the 1.0 inventory listing page through more than 50 variants with a cursor?
      instructions:
      - text: List all inventory items from the 1.0 inventory endpoint.
      - text: Get the next page of 1.0 inventory items after cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/commerce/inventory/adjustments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add, subtract, set or unlimit stock (1.0)
      effect: write
      questions:
      - How do I set an exact stock count for a variant rather than adjusting it up or down?
      - Can I mark a product variant as having unlimited stock?
      - Why does the 1.0 stock adjustment require an idempotency key?
      instructions:
      - text: Set exact stock quantities with {setFiniteOperations} using idempotency key {idempotencyKey}.
        slots:
          setFiniteOperations: requestBody.setFiniteOperations
          idempotencyKey: header.Idempotency-Key
      - text: Mark inventory items {setUnlimitedOperations} as unlimited stock, idempotency key {idempotencyKey}.
        slots:
          setUnlimitedOperations: requestBody.setUnlimitedOperations
          idempotencyKey: header.Idempotency-Key
      - text: Subtract stock with {decrementOperations} via the 1.0 adjustments endpoint, key {idempotencyKey}.
        slots:
          decrementOperations: requestBody.decrementOperations
          idempotencyKey: header.Idempotency-Key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/commerce/inventory/{variantIdCsvs}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stock for specific variants (1.0)
      effect: read
      questions:
      - How do I check stock for just a few variant IDs on the versioned 1.0 endpoint?
      - How many inventory items can I request at once by ID in version 1.0?
      instructions:
      - text: Get 1.0 inventory items for variants {variantIdCsvs}.
        slots:
          variantIdCsvs: path.variantIdCsvs
      - text: Check current stock of variants {variantIdCsvs} using the 1.0 API.
        slots:
          variantIdCsvs: path.variantIdCsvs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock for all variants (unversioned)
      effect: read
      questions:
      - What stock does every product variant in my shop have right now, via the unversioned inventory path?
      - Is there an unversioned inventory listing that pages 50 items at a time?
      instructions:
      - text: Retrieve all inventory using the unversioned commerce/inventory endpoint.
      - text: Continue the unversioned inventory listing from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/inventory/{variantIds}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stock for specific variants (unversioned)
      effect: read
      questions:
      - Can I check stock for up to 50 variants without paging, via the unversioned path?
      - What's the stock level of a specific variant using the unversioned inventory endpoint?
      instructions:
      - text: Retrieve unversioned inventory for variant IDs {variantIds}.
        slots:
          variantIds: path.variantIds
      - text: Show stock levels for variants {variantIds} without the 1.0 prefix.
        slots:
          variantIds: path.variantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/inventory/adjustments'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply relative stock increments (unversioned)
      effect: write
      questions:
      - How do I bump stock up or down by a relative amount for several variants at once?
      - Can I submit bulk positive and negative stock changes in one unversioned request?
      instructions:
      - text: Apply relative stock increments {increments} through the unversioned adjustments endpoint.
        slots:
          increments: requestBody.increments
      - text: Bulk-adjust variant stock by the relative amounts in {increments}.
        slots:
          increments: requestBody.increments
      method: generated
      generated: '2026-10-01'