Inventory

There is a 1:1 relationship between a product variant and an inventory item. Each product variant includes the ID of its related inventory item. You can use the inventory item ID to query the InventoryLevel resource to retrieve the location and quantity for an inventory item.

Use the InventoryItem resource together with the InventoryLevel and Location resources to manage a store’s inventory across multiple locations. An inventory level represents the quantities of an inventory item for a location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item can be stocked, there’s an inventory level that represents the inventory item’s quantities relating to that location.

An inventory location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. You can use the Location resource to track sales, manage inventory, and configure the tax rates to apply at checkout.

Representations

All representations are JSON objects submitted or received as payload to API requests or responses.

admin_graphql_api_id - string

cost - number - The unit cost of the inventory item. The shop’s default currency is used.

country_code_of_origin - string - The country code (ISO 3166-1 alpha-2) of where the item came from.

country_harmonized_system_codes - string - An array of country-specific Harmonized System (HS) codes for the item. Used to determine duties when shipping the inventory item to certain countries.

created_at - DateTime

deleted - boolean - To mark item as deleted from inventory.

harmonized_system_code - string - The general Harmonized System (HS) code for the inventory item. Used if a country-specific HS code (countryHarmonizedSystemCode) is not available.

id - string - The ID of the inventory item.

province_code_of_origin - string- The province code (ISO 3166-2 alpha-2) of where the item came from. The province code is only used if the shipping provider for the inventory item is Canada Post.

requires_shipping - boolean - To enable shipping requirement status.

sku - string - The unique SKU (stock keeping unit) of the inventory item.

tracked - boolean - Whether inventory levels are tracked for the item. If true, then the inventory quantity changes are tracked.

updated_at - The date and time when the inventory item was last modified.

Location

active - boolean - Whether the location is active. If true, then the location can be used to sell products, stock inventory, and fulfill orders. Deactivated locations don’t contribute to the shop’s location limit.

address1 - string - The location’s street address.

address2 - string - The optional second line of the location’s street address.

admin_graphql_api_id - string

city - string - The city the location is in.

country - string - The country the location is in.

country_code - string - The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in.

country_name - string

created_at - The date and time (ISO 8601 format) when the location was created.

id - string -The ID of the location.

legacy - boolean - Whether this is a fulfillment service location. If true, then the location is a fulfillment service location. If false, then the location was created by the merchant and isn’t tied to a fulfillment service.

localized_country_name - string - The localized name of the location’s country.

localized_province_name -string - The localized name of the location’s region. Typically a province, state, or district.

name - string - The name of the location.

phone - string - The phone number of the location. This value can contain special characters, such as - or +.

province - string - The province, state, or district of the location.

province_code - string -The province, state, or district code (ISO 3166-2 alpha-2 format) of the location.

updated_at - The date and time (ISO 8601 format) when the location was last updated.

zip - string - The zip or postal code.

Inventory Level

admin_graphql_api_id - string

available - integer - The available quantity of an inventory item at the inventory level’s associated location. Returns null if the inventory item is not tracked.

created_at - The date and time (ISO 8601 format) when the location was created.

inventory_item_id - string - The ID of the inventory item associated with the inventory level. To find the ID of an inventory item, use the Inventory Item resource.

location_id - string -The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.

updated_at - The date and time (ISO 8601 format) when the inventory level was last modified.

REST Endpoints

Create an inventory item

Method: POST

Endpoint: ​/api​/inventoryitem

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
 {
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T12:27:57.620Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T12:27:57.620Z"
}
Response - 201 (Created) 
 {
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T12:27:57.640Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T12:27:57.640Z"
}

HTTP Status Code:

- 200 OK
- 201 Created
- 400 Bad request 
- 401 Unauthorized,
- 403 Forbidden 
- 404 Not Found
- 405 Invalid input

Update an inventory level

Method: PUT

Endpoint: /api​/inventoryitem​

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
 {
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T12:34:54.073Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T12:34:54.073Z"
}
Response - 200 (OK inventory item created) 
 {
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T12:34:54.092Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T12:34:54.092Z"
}

HTTP Status Code:

- 200 OK
- 201 Created
- 400 Bad request 
- 401 Unauthorized,
- 403 Forbidden 
- 404 Not Found
- 405 Invalid input

Find Inventory Item by Ref

Method: GET

Endpoint: /api​/inventoryitem​/{inventoryRef}

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Path Variable Response - 200 (OK Found InventoryItem) 
{
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T12:55:48.436Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T12:55:48.436Z"
}

HTTP Status Code:

- 200 OK Found InventoryItem
- 400 Bad request unable to create InventoryItem
- 401 Unauthorized
- 403 Forbidden 
- 404 InventoryItem with provided id not found
- 405 Invalid input

Upload multiple inventory levels

Method: POST

Endpoint: /api​/inventoryitem​s

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
  [
  {
    "admin_graphql_api_id": "string",
    "cost": 0,
    "country_code_of_origin": "string",
    "country_harmonized_system_codes": [
      {
        "country_code": "string",
        "harmonized_system_code": "string"
      }
    ],
    "created_at": "2022-06-22T13:15:14.029Z",
    "deleted": true,
    "harmonized_system_code": "string",
    "id": "string",
    "province_code_of_origin": "string",
    "requires_shipping": true,
    "sku": "string",
    "tracked": true,
    "updated_at": "2022-06-22T13:15:14.029Z"
  }
]
Response - 201 (Created) 
 {
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T13:15:14.041Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T13:15:14.041Z"
}

HTTP Status Code:

- 200 OK
- 201 created
- 400 NOK bad request
- 401 NOK unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Create an inventory level

Method: POST

Endpoint: /api​/inventorylevel

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
{
  "admin_graphql_api_id": "string",
  "available": 0,
  "inventory_item_id": "string",
  "location_id": "string"
}
Response - 201 (OK inventory level item created) 
 {
  "admin_graphql_api_id": "string",
  "available": 0,
  "created_at": "2022-06-22T13:18:43.519Z",
  "inventory_item_id": "string",
  "location_id": "string",
  "updated_at": "2022-06-22T13:18:43.519Z"
}

HTTP Status Code:

- 200 OK
- 201 NOK inventory level item created
- 400 NOK Invalid status value
- 401 NOK Unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Update an inventory level

Method: PUT

Endpoint: /api​/inventorylevel

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
{
  "admin_graphql_api_id": "string",
  "available": 0,
  "created_at": "2022-06-22T13:22:49.148Z",
  "inventory_item_id": "string",
  "location_id": "string",
  "updated_at": "2022-06-22T13:22:49.148Z"
}
Response - 200 (OK inventory item created) 
{
  "admin_graphql_api_id": "string",
  "available": 0,
  "created_at": "2022-06-22T13:22:49.203Z",
  "inventory_item_id": "string",
  "location_id": "string",
  "updated_at": "2022-06-22T13:22:49.203Z"
}

HTTP Status Code:

- 200 OK inventory item created
- 201 created
- 400 NOK Invalid status value
- 401 NOK Unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Find Inventory Level By Id

Method: GET

Endpoint: ​/api​/inventorylevel​/inventoryitem​/{inventoryItemRef}​/location​/{locationRef}

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Path Variables Response - 200 (OK) 
 {
  "admin_graphql_api_id": "string",
  "cost": 0,
  "country_code_of_origin": "string",
  "country_harmonized_system_codes": [
    {
      "country_code": "string",
      "harmonized_system_code": "string"
    }
  ],
  "created_at": "2022-06-22T13:26:19.864Z",
  "deleted": true,
  "harmonized_system_code": "string",
  "id": "string",
  "province_code_of_origin": "string",
  "requires_shipping": true,
  "sku": "string",
  "tracked": true,
  "updated_at": "2022-06-22T13:26:19.864Z"
}

HTTP Status Code:

- 200 OK Found InventoryLevel
- 400 Bad request unable to create InventoryLevel
- 401 Unauthorized
- 403 Forbidden 
- 404 InventoryLevel with provided id not found
- 405 Invalid input

Create an inventory level

Method: POST

Endpoint: /api​/inventorylevels

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
[
  {
    "admin_graphql_api_id": "string",
    "available": 0,
    "created_at": "2022-06-22T13:31:10.253Z",
    "inventory_item_id": "string",
    "location_id": "string",
    "updated_at": "2022-06-22T13:31:10.253Z"
  }
]
Response - 201 (Created) 
 [
  {
    "admin_graphql_api_id": "string",
    "available": 0,
    "created_at": "2022-06-22T13:31:10.253Z",
    "inventory_item_id": "string",
    "location_id": "string",
    "updated_at": "2022-06-22T13:31:10.253Z"
  }
]

HTTP Status Code:

- 200 OK
- 201 OK inventory level item created
- 400 NOK bad request
- 401 NOK unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Create an inventory Location

Method: POST

Endpoint: /api​/inventorylocation

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
 {
  "active": true,
  "address1": "string",
  "address2": "string",
  "admin_graphql_api_id": "string",
  "city": "string",
  "country": "string",
  "country_code": "string",
  "country_name": "string",
  "created_at": "2022-06-22T13:35:40.215Z",
  "id": "string",
  "legacy": true,
  "localized_country_name": "string",
  "localized_province_name": "string",
  "name": "string",
  "phone": "string",
  "province": "string",
  "province_code": "string",
  "updated_at": "2022-06-22T13:35:40.215Z",
  "zip": "string"
}
Response - 201 (ok inventory location created) 
 {
  "active": true,
  "address1": "string",
  "address2": "string",
  "admin_graphql_api_id": "string",
  "city": "string",
  "country": "string",
  "country_code": "string",
  "country_name": "string",
  "created_at": "2022-06-22T13:35:40.215Z",
  "id": "string",
  "legacy": true,
  "localized_country_name": "string",
  "localized_province_name": "string",
  "name": "string",
  "phone": "string",
  "province": "string",
  "province_code": "string",
  "updated_at": "2022-06-22T13:35:40.215Z",
  "zip": "string"
}

HTTP Status Code:

- 200 OK
- 201 OK inventory location created
- 400 NOK bad request
- 401 NOK Unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Update an inventory level

Method: PUT

Endpoint: ​/api​/inventorylocation

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
{
  "active": true,
  "address1": "string",
  "address2": "string",
  "admin_graphql_api_id": "string",
  "city": "string",
  "country": "string",
  "country_code": "string",
  "country_name": "string",
  "created_at": "2022-06-22T13:39:39.407Z",
  "id": "string",
  "legacy": true,
  "localized_country_name": "string",
  "localized_province_name": "string",
  "name": "string",
  "phone": "string",
  "province": "string",
  "province_code": "string",
  "updated_at": "2022-06-22T13:39:39.407Z",
  "zip": "string"
}
Response - 200 (OK)

HTTP Status Code:

- 200 OK Location item created
- 201 created
- 400 NOK Invalid status value
- 401 NOK Unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Find Inventory location by ID

Method: GET

Endpoint: ​/api​/inventorylocation​/{id}

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Path Variable 
- {id}
Response - 200 (OK) 
 {
  "active": true,
  "address1": "string",
  "address2": "string",
  "admin_graphql_api_id": "string",
  "city": "string",
  "country": "string",
  "country_code": "string",
  "country_name": "string",
  "created_at": "2022-06-22T13:44:35.975Z",
  "id": "string",
  "legacy": true,
  "localized_country_name": "string",
  "localized_province_name": "string",
  "name": "string",
  "phone": "string",
  "province": "string",
  "province_code": "string",
  "updated_at": "2022-06-22T13:44:35.975Z",
  "zip": "string"
}

HTTP Status Code:

- 200 OK Found location
- 400 Bad request unable to create Location
- 401 Unauthorized
- 403 Forbidden 
- 404 Location with provided id not found
- 405 Invalid input

Create multiple inventory Locations

Method: POST

Endpoint: /api​/inventorylocations

OAuth 2.0 Scopes: Tenant authentication

Request Headers
Key Value
Content-Type application/json
X-TWC-Tenant {Tenant Name}
Request Payload : 
 [
  {
    "active": true,
    "address1": "string",
    "address2": "string",
    "admin_graphql_api_id": "string",
    "city": "string",
    "country": "string",
    "country_code": "string",
    "country_name": "string",
    "created_at": "2022-06-22T13:47:30.858Z",
    "id": "string",
    "legacy": true,
    "localized_country_name": "string",
    "localized_province_name": "string",
    "name": "string",
    "phone": "string",
    "province": "string",
    "province_code": "string",
    "updated_at": "2022-06-22T13:47:30.858Z",
    "zip": "string"
  }
]
Response - 201 (Created)

HTTP Status Code:

- 200 OK
- 201 OK inventory location created
- 400 NOK Invalid status value
- 401 NOK Unauthorized
- 403 Forbidden 
- 404 Not Found
- 405 NOK Invalid input

Back to Shopify connector

Back to Index