Shopify Inventory Items API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Inventory Items API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Inventory Items
  description: Manage inventory item records
paths:
  /inventory_items.json:
    get:
      operationId: listInventoryItems
      summary: Shopify Retrieve a list of inventory items
      description: Retrieves a list of inventory items. Items must be fetched by IDs.
      tags:
      - Inventory Items
      parameters:
      - name: ids
        in: query
        required: true
        description: Comma-separated list of inventory item IDs
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results (max 250, default 50)
        schema:
          type: integer
          default: 50
          maximum: 250
      responses:
        '200':
          description: A list of inventory items
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryItem'
  /inventory_items/{inventory_item_id}.json:
    get:
      operationId: getInventoryItem
      summary: Shopify Retrieve a single inventory item
      description: Retrieves a single inventory item by ID.
      tags:
      - Inventory Items
      parameters:
      - name: inventory_item_id
        in: path
        required: true
        description: The ID of the inventory item
        schema:
          type: integer
      responses:
        '200':
          description: The requested inventory item
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_item:
                    $ref: '#/components/schemas/InventoryItem'
    put:
      operationId: updateInventoryItem
      summary: Shopify Update an inventory item
      description: Updates an existing inventory item.
      tags:
      - Inventory Items
      parameters:
      - name: inventory_item_id
        in: path
        required: true
        description: The ID of the inventory item
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - inventory_item
              properties:
                inventory_item:
                  type: object
                  properties:
                    cost:
                      type: string
                      description: Unit cost of the item
                    tracked:
                      type: boolean
                      description: Whether inventory is tracked
      responses:
        '200':
          description: The updated inventory item
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_item:
                    $ref: '#/components/schemas/InventoryItem'
components:
  schemas:
    InventoryItem:
      type: object
      description: An inventory item representing a physical product
      properties:
        id:
          type: integer
        sku:
          type:
          - string
          - 'null'
        cost:
          type:
          - string
          - 'null'
          description: Unit cost of the item
        tracked:
          type: boolean
          description: Whether inventory is tracked
        requires_shipping:
          type: boolean
        country_code_of_origin:
          type:
          - string
          - 'null'
          description: Two-letter ISO country code
        province_code_of_origin:
          type:
          - string
          - 'null'
        harmonized_system_code:
          type:
          - string
          - 'null'
          description: Harmonized System code for customs
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        admin_graphql_api_id:
          type: string
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth