Shopify API — Inventory

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Inventory
  description: 'Shopify  API — Inventory. 55 operations. Lead operation: Shopify Retrieves A List Of Inventory Items. Self-contained
    Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Inventory
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-inventory
    baseUri: ''
    description: Shopify  API — Inventory business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-inventory_items.json
      path: /admin/api/2020-01/inventory_items.json
      operations:
      - name: deprecated202001getinventoryitems
        method: GET
        description: Shopify Retrieves A List Of Inventory Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "ids\n                  required"
          in: query
          type: string
          description: Show only inventory items specified by a comma-separated list of IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: ids
          in: query
          type: integer
          description: ids
    - name: admin-api-2020-01-inventory_items-inventory_item_id}.json
      path: /admin/api/2020-01/inventory_items/{inventory_item_id}.json
      operations:
      - name: deprecated202001getinventoryitemsparaminventoryitemid
        method: GET
        description: Shopify Retrieves A Single Inventory Item By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
      - name: deprecated202001updateinventoryitemsparaminventoryitemid
        method: PUT
        description: Shopify Updates An Existing Inventory Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-inventory_levels.json
      path: /admin/api/2020-01/inventory_levels.json
      operations:
      - name: deprecated202001getinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_ids
          in: query
          type: string
          description: A comma-separated list of inventory item IDs.
        - name: location_ids
          in: query
          type: string
          description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).'
      - name: deprecated202001deleteinventorylevels
        method: DELETE
        description: Shopify Deletes An Inventory Level Of An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: inventory_item_id
          in: query
          type: integer
          description: inventory_item_id
        - name: location_id
          in: query
          type: integer
          description: location_id
    - name: admin-api-2020-01-inventory_levels-adjust.json
      path: /admin/api/2020-01/inventory_levels/adjust.json
      operations:
      - name: deprecated202001createinventorylevelsadjust
        method: POST
        description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available_adjustment\n                  required"
          in: query
          type: string
          description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current
            available quantity. For example, "available_adjustment"
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-inventory_levels-connect.json
      path: /admin/api/2020-01/inventory_levels/connect.json
      operations:
      - name: deprecated202001createinventorylevelsconnect
        method: POST
        description: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: relocate_if_necessary
          in: query
          type: string
          description: 'Whether inventory for any previously connected locations will be relocated. This property is ignored
            when no fulfillment service location is involved. For more '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-inventory_levels-set.json
      path: /admin/api/2020-01/inventory_levels/set.json
      operations:
      - name: deprecated202001createinventorylevelsset
        method: POST
        description: Shopify Sets The Inventory Level For An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available\n                  required"
          in: query
          type: string
          description: Sets the available inventory quantity.
        - name: disconnect_if_necessary
          in: query
          type: string
          description: 'Whether inventory for any previously connected locations will be set to 0 and the locations disconnected.
            This property is ignored when no fulfillment service  '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-locations-location_id-inventory_levels.json
      path: /admin/api/2020-01/locations/{location_id}/inventory_levels.json
      operations:
      - name: deprecated202001getlocationsparamlocationidinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels For A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: location_id
          in: path
          type: string
          description: location_id
          required: true
    - name: admin-api-2020-04-inventory_items.json
      path: /admin/api/2020-04/inventory_items.json
      operations:
      - name: deprecated202004getinventoryitems
        method: GET
        description: Shopify Retrieves A List Of Inventory Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "ids\n                  required"
          in: query
          type: string
          description: Show only inventory items specified by a comma-separated list of IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: ids
          in: query
          type: integer
          description: ids
    - name: admin-api-2020-04-inventory_items-inventory_item_id}.json
      path: /admin/api/2020-04/inventory_items/{inventory_item_id}.json
      operations:
      - name: deprecated202004getinventoryitemsparaminventoryitemid
        method: GET
        description: Shopify Retrieves A Single Inventory Item By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
      - name: deprecated202004updateinventoryitemsparaminventoryitemid
        method: PUT
        description: Shopify Updates An Existing Inventory Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-inventory_levels.json
      path: /admin/api/2020-04/inventory_levels.json
      operations:
      - name: deprecated202004getinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_ids
          in: query
          type: string
          description: A comma-separated list of inventory item IDs.
        - name: location_ids
          in: query
          type: string
          description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).'
      - name: deprecated202004deleteinventorylevels
        method: DELETE
        description: Shopify Deletes An Inventory Level Of An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: inventory_item_id
          in: query
          type: integer
          description: inventory_item_id
        - name: location_id
          in: query
          type: integer
          description: location_id
    - name: admin-api-2020-04-inventory_levels-adjust.json
      path: /admin/api/2020-04/inventory_levels/adjust.json
      operations:
      - name: deprecated202004createinventorylevelsadjust
        method: POST
        description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available_adjustment\n                  required"
          in: query
          type: string
          description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current
            available quantity. For example, "available_adjustment"
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-inventory_levels-connect.json
      path: /admin/api/2020-04/inventory_levels/connect.json
      operations:
      - name: deprecated202004createinventorylevelsconnect
        method: POST
        description: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: relocate_if_necessary
          in: query
          type: string
          description: 'Whether inventory for any previously connected locations will be relocated. This property is ignored
            when no fulfillment service location is involved. For more '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-inventory_levels-set.json
      path: /admin/api/2020-04/inventory_levels/set.json
      operations:
      - name: deprecated202004createinventorylevelsset
        method: POST
        description: Shopify Sets The Inventory Level For An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available\n                  required"
          in: query
          type: string
          description: Sets the available inventory quantity.
        - name: disconnect_if_necessary
          in: query
          type: string
          description: 'Whether inventory for any previously connected locations will be set to 0 and the locations disconnected.
            This property is ignored when no fulfillment service  '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-locations-location_id-inventory_levels.json
      path: /admin/api/2020-04/locations/{location_id}/inventory_levels.json
      operations:
      - name: deprecated202004getlocationsparamlocationidinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels For A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: location_id
          in: path
          type: string
          description: location_id
          required: true
    - name: admin-api-2020-07-inventory_items.json
      path: /admin/api/2020-07/inventory_items.json
      operations:
      - name: deprecated202007getinventoryitems
        method: GET
        description: Shopify Retrieves A List Of Inventory Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "ids\n                  required"
          in: query
          type: string
          description: Show only inventory items specified by a comma-separated list of IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: ids
          in: query
          type: integer
          description: ids
    - name: admin-api-2020-07-inventory_items-inventory_item_id}.json
      path: /admin/api/2020-07/inventory_items/{inventory_item_id}.json
      operations:
      - name: deprecated202007getinventoryitemsparaminventoryitemid
        method: GET
        description: Shopify Retrieves A Single Inventory Item By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
      - name: deprecated202007updateinventoryitemsparaminventoryitemid
        method: PUT
        description: Shopify Updates An Existing Inventory Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-inventory_levels.json
      path: /admin/api/2020-07/inventory_levels.json
      operations:
      - name: deprecated202007getinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_ids
          in: query
          type: string
          description: A comma-separated list of inventory item IDs.
        - name: location_ids
          in: query
          type: string
          description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).'
      - name: deprecated202007deleteinventorylevels
        method: DELETE
        description: Shopify Deletes An Inventory Level Of An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: inventory_item_id
          in: query
          type: integer
          description: inventory_item_id
        - name: location_id
          in: query
          type: integer
          description: location_id
    - name: admin-api-2020-07-inventory_levels-adjust.json
      path: /admin/api/2020-07/inventory_levels/adjust.json
      operations:
      - name: deprecated202007createinventorylevelsadjust
        method: POST
        description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available_adjustment\n                  required"
          in: query
          type: string
          description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current
            available quantity. For example, "available_adjustment"
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-inventory_levels-connect.json
      path: /admin/api/2020-07/inventory_levels/connect.json
      operations:
      - name: deprecated202007createinventorylevelsconnect
        method: POST
        description: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: relocate_if_necessary
          in: query
          type: string
          description: 'Whether inventory for any previously connected locations will be relocated. This property is ignored
            when no fulfillment service location is involved. For more '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-inventory_levels-set.json
      path: /admin/api/2020-07/inventory_levels/set.json
      operations:
      - name: deprecated202007createinventorylevelsset
        method: POST
        description: Shopify Sets The Inventory Level For An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available\n                  required"
          in: query
          type: string
          description: Sets the available inventory quantity.
        - name: disconnect_if_necessary
          in: query
          type: string
          description: 'Whether inventory for any previously connected locations will be set to 0 and the locations disconnected.
            This property is ignored when no fulfillment service  '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-locations-location_id-inventory_levels.json
      path: /admin/api/2020-07/locations/{location_id}/inventory_levels.json
      operations:
      - name: deprecated202007getlocationsparamlocationidinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels For A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: location_id
          in: path
          type: string
          description: location_id
          required: true
    - name: admin-api-2020-10-inventory_items.json
      path: /admin/api/2020-10/inventory_items.json
      operations:
      - name: getinventoryitems
        method: GET
        description: Shopify Retrieves A List Of Inventory Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "ids\n                  required"
          in: query
          type: string
          description: Show only inventory items specified by a comma-separated list of IDs.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: ids
          in: query
          type: integer
          description: ids
    - name: admin-api-2020-10-inventory_items-inventory_item_id}.json
      path: /admin/api/2020-10/inventory_items/{inventory_item_id}.json
      operations:
      - name: getinventoryitemsparaminventoryitemid
        method: GET
        description: Shopify Retrieves A Single Inventory Item By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
      - name: updateinventoryitemsparaminventoryitemid
        method: PUT
        description: Shopify Updates An Existing Inventory Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_id
          in: path
          type: string
          description: inventory_item_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-inventory_levels.json
      path: /admin/api/2020-10/inventory_levels.json
      operations:
      - name: getinventorylevels
        method: GET
        description: Shopify Retrieves A List Of Inventory Levels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_ids
          in: query
          type: string
          description: A comma-separated list of inventory item IDs.
        - name: location_ids
          in: query
          type: string
          description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).'
      - name: deleteinventorylevels
        method: DELETE
        description: Shopify Deletes An Inventory Level Of An Inventory Item At A Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID for the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: inventory_item_id
          in: query
          type: integer
          description: inventory_item_id
        - name: location_id
          in: query
          type: integer
          description: location_id
    - name: admin-api-2020-10-inventory_levels-adjust.json
      path: /admin/api/2020-10/inventory_levels/adjust.json
      operations:
      - name: createinventorylevelsadjust
        method: POST
        description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - name: "available_adjustment\n                  required"
          in: query
          type: string
          description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current
            available quantity. For example, "available_adjustment"
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-inventory_levels-connect.json
      path: /admin/api/2020-10/inventory_levels/connect.json
      operations:
      - name: createinventorylevelsconnect
        method: POST
        description: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: "inventory_item_id\n                  required"
          in: query
          type: string
          description: The ID of the inventory item.
        - name: "location_id\n                  required"
          in: query
          type: string
          description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the
            Location resource.
        - n

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/capabilities/shopify-inventory.yaml