Shopify Connects API

openapi: 3.1.0
info:
  title: Shopify Admin REST About Connects 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: Connects
paths:
  /admin/api/2020-01/inventory_levels/connect.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connect an inventory item to a location
              example2:
                value:
                  location_id: 123
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a non-existent location fails and returns an error
              example3:
                value:
                  location_id: 48752903
                  inventory_item_id: 808950810
                summary: 'Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error'
              example4:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error
      summary: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
      description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-01
      parameters:
      - in: query
        name: "inventory_item_id\n                  required"
        description: The ID of the inventory item.
        schema: {}
        required: false
      - in: query
        name: "location_id\n                  required"
        description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
        schema: {}
        required: false
      - in: query
        name: relocate_if_necessary
        description: "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Connects
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_inventory_levels_connect
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/inventory_levels/connect.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connect an inventory item to a location
              example2:
                value:
                  location_id: 123
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a non-existent location fails and returns an error
              example3:
                value:
                  location_id: 48752903
                  inventory_item_id: 808950810
                summary: 'Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error'
              example4:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error
      summary: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
      description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-04
      parameters:
      - in: query
        name: "inventory_item_id\n                  required"
        description: The ID of the inventory item.
        schema: {}
        required: false
      - in: query
        name: "location_id\n                  required"
        description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
        schema: {}
        required: false
      - in: query
        name: relocate_if_necessary
        description: "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Connects
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_inventory_levels_connect
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/inventory_levels/connect.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connect an inventory item to a location
              example2:
                value:
                  location_id: 123
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a non-existent location fails and returns an error
              example3:
                value:
                  location_id: 48752903
                  inventory_item_id: 808950810
                summary: 'Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error'
              example4:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error
      summary: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
      description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-07
      parameters:
      - in: query
        name: "inventory_item_id\n                  required"
        description: The ID of the inventory item.
        schema: {}
        required: false
      - in: query
        name: "location_id\n                  required"
        description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
        schema: {}
        required: false
      - in: query
        name: relocate_if_necessary
        description: "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Connects
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_inventory_levels_connect
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/inventory_levels/connect.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connect an inventory item to a location
              example2:
                value:
                  location_id: 123
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a non-existent location fails and returns an error
              example3:
                value:
                  location_id: 48752903
                  inventory_item_id: 808950810
                summary: 'Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error'
              example4:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error
      summary: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
      description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-10
      parameters:
      - in: query
        name: "inventory_item_id\n                  required"
        description: The ID of the inventory item.
        schema: {}
        required: false
      - in: query
        name: "location_id\n                  required"
        description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
        schema: {}
        required: false
      - in: query
        name: relocate_if_necessary
        description: "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Connects
      responses:
        '200':
          description: ''
      operationId: create_inventory_levels_connect
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/inventory_levels/connect.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connect an inventory item to a location
              example2:
                value:
                  location_id: 123
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a non-existent location fails and returns an error
              example3:
                value:
                  location_id: 48752903
                  inventory_item_id: 808950810
                summary: 'Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error'
              example4:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error
      summary: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
      description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2021-01
      parameters:
      - in: query
        name: "inventory_item_id\n                  required"
        description: The ID of the inventory item.
        schema: {}
        required: false
      - in: query
        name: "location_id\n                  required"
        description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
        schema: {}
        required: false
      - in: query
        name: relocate_if_necessary
        description: "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Connects
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_inventory_levels_connect
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/inventory_levels/connect.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connect an inventory item to a location
              example2:
                value:
                  location_id: 123
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a non-existent location fails and returns an error
              example3:
                value:
                  location_id: 48752903
                  inventory_item_id: 808950810
                summary: 'Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error'
              example4:
                value:
                  location_id: 192722535
                  inventory_item_id: 457924702
                summary: Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error
      summary: Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location
      description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-unstable
      parameters:
      - in: query
        name: "inventory_item_id\n                  required"
        description: The ID of the inventory item.
        schema: {}
        required: false
      - in: query
        name: "location_id\n                  required"
        description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
        schema: {}
        required: false
      - in: query
        name: relocate_if_necessary
        description: "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Connects
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_inventory_levels_connect
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth