openapi: 3.1.0
info:
  title: Shopify Admin REST Collections Inventory API
  description: 'The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. It provides access to products, customers, orders, inventory, fulfillment, shipping, and store configuration. All requests require a valid Shopify access token. Note: Shopify is deprecating the REST Admin API in favor of GraphQL. New development should use the GraphQL Admin API.'
  version: 2024-10
  termsOfService: https://www.shopify.com/legal/api-terms
  contact:
    name: Shopify Developer Support
    url: https://shopify.dev/docs/api/admin-rest
  license:
    name: API Terms of Service
    url: https://www.shopify.com/legal/api-terms
servers:
- url: https://{store_name}.myshopify.com/admin/api/2024-10
  description: Shopify Admin REST API
  variables:
    store_name:
      description: The name of the Shopify store
      default: mystore
security:
- AccessToken: []
tags:
- name: Inventory
paths:
  /inventory_items.json:
    get:
      operationId: listInventoryItems
      summary: List Inventory Items
      description: Retrieves a list of inventory items.
      tags:
      - Inventory
      parameters:
      - name: ids
        in: query
        required: true
        description: Show only inventory items specified by a comma-separated list of IDs
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to show
        schema:
          type: integer
          minimum: 1
          maximum: 250
          default: 50
      responses:
        '200':
          description: Successful response with list of inventory items
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryItem'
  /inventory_levels.json:
    get:
      operationId: listInventoryLevels
      summary: List Inventory Levels
      description: Retrieves a list of inventory levels for specified inventory items or locations.
      tags:
      - Inventory
      parameters:
      - name: inventory_item_ids
        in: query
        description: Comma-separated list of inventory item IDs
        schema:
          type: string
      - name: location_ids
        in: query
        description: Comma-separated list of location IDs
        schema:
          type: string
      responses:
        '200':
          description: Successful response with inventory levels
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_levels:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryLevel'
components:
  schemas:
    InventoryItem:
      type: object
      properties:
        id:
          type: integer
          format: int64
        sku:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        requires_shipping:
          type: boolean
        tracked:
          type: boolean
        cost:
          type: string
          nullable: true
    InventoryLevel:
      type: object
      properties:
        inventory_item_id:
          type: integer
          format: int64
        location_id:
          type: integer
          format: int64
        available:
          type: integer
          nullable: true
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: X-Shopify-Access-Token
      description: Shopify access token for authentication