Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Connects API

7 actions 7 updates phrasing extends openapi/shopify-connects-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 7

$.info
$.paths['/admin/api/2020-01/inventory_levels/connect.json'].post
$.paths['/admin/api/2020-04/inventory_levels/connect.json'].post
$.paths['/admin/api/2020-07/inventory_levels/connect.json'].post
$.paths['/admin/api/2020-10/inventory_levels/connect.json'].post
$.paths['/admin/api/2021-01/inventory_levels/connect.json'].post
$.paths['/admin/api/unstable/inventory_levels/connect.json'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Connects API
  version: 1.0.0
extends: openapi/shopify-connects-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: 6
- target: $.paths['/admin/api/2020-01/inventory_levels/connect.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Stock an inventory item at a location (2020-01)
      effect: write
      questions:
      - How do I start tracking an inventory item at a new location on the 2020-01 API?
      - Can connecting an item to a location relocate stock from a fulfillment service location in 2020-01?
      instructions:
      - text: Connect inventory item {item} to location {location} using the 2020-01 API.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
      - text: Link item {item} to location {location} with relocate_if_necessary set to {relocate}, version 2020-01.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
          relocate: query.relocate_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/inventory_levels/connect.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Stock an inventory item at a location (2020-04)
      effect: write
      questions:
      - Which 2020-04 call creates an inventory level so an item can be stocked at a location?
      - Is connecting an inventory item to a location supported in the 2020-04 release?
      instructions:
      - text: Create an inventory level for item {item} at location {location} on 2020-04.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
      - text: Connect item {item} to location {location} and relocate if needed ({relocate}) via the 2020-04 release.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
          relocate: query.relocate_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/inventory_levels/connect.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Stock an inventory item at a location (2020-07)
      effect: write
      questions:
      - Where do I connect an inventory item to a location in version 2020-07?
      - When does the relocate option matter for connecting stock in 2020-07?
      instructions:
      - text: Attach inventory item {item} to location {location} through the 2020-07 version.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
      - text: Connect {item} at location {location}, relocate_if_necessary {relocate}, with 2020-07.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
          relocate: query.relocate_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/inventory_levels/connect.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Stock an inventory item at a location (2020-10)
      effect: write
      questions:
      - How can I make a product variant stockable at another warehouse using the 2020-10 API?
      - Does the 2020-10 Admin API let me connect an inventory item to a location?
      instructions:
      - text: Connect inventory item {item} to location {location} with the 2020-10 Admin API.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
      - text: 'Start stocking item {item} at location {location}, relocating if necessary: {relocate}, API 2020-10.'
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
          relocate: query.relocate_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/inventory_levels/connect.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Stock an inventory item at a location (2021-01)
      effect: write
      questions:
      - Can I connect an inventory item to a location using the 2021-01 release?
      - Which 2021-01 endpoint creates an inventory level for an item and location?
      instructions:
      - text: Using 2021-01, connect item {item} to location {location}.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
      - text: On the 2021-01 release, create inventory level for {item} at {location} with relocate {relocate}.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
          relocate: query.relocate_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/inventory_levels/connect.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Stock an inventory item at a location (unstable)
      effect: write
      questions:
      - Is connecting an inventory item to a location available on the unstable API?
      - How would I create an inventory level against the unstable version?
      instructions:
      - text: Connect inventory item {item} to location {location} on the unstable API.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
      - text: On the unstable version, link {item} to location {location} with relocation {relocate}.
        slots:
          item: "query.inventory_item_id\n                  required"
          location: "query.location_id\n                  required"
          relocate: query.relocate_if_necessary
      method: generated
      generated: '2026-09-24'