Endpoint Get Inventory Items
Name
get_inventory_items
Description
Gets a list of inventory items. Each Product Variant has Inventory Item Id .. Its one to one relationship with Product Variant and Inventory Item. Query get_product_variants to get InventoryItemId and use as Id in this endpoint. [API reference]
Related Tables
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: Inventory Item Id(s) - Comma separated Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams) |
YES | |
|
Name:
Label: Page Size The maximum number of records to show. |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_I8
|
bigint
|
||
| Sku |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Cost |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Tracked |
DT_BOOL
|
bit
|
||
| RequiresShipping |
DT_BOOL
|
bit
|
||
| CountryCodeOfOrigin |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ProvinceCodeOfOrigin |
DT_WSTR
|
nvarchar(50)
|
50 | |
| CountryHarmonizedSystemCodes |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| HarmonizedSystemCode |
DT_I8
|
bigint
|
||
| CreatedAt |
DT_DBTIMESTAMP
|
datetime
|
||
| UpdatedAt |
DT_DBTIMESTAMP
|
datetime
|
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_I8
|
bigint
|
Examples
SSIS
Use Shopify Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the InventoryItems table, therefore it is better to use it, instead of accessing the endpoint directly:
| Required Parameters | |
|---|---|
| Inventory Item Id(s) - Comma separated | Fill-in the parameter... |
API Destination
This Endpoint belongs to the InventoryItems table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get inventory items:
| Required Parameters | |
|---|---|
| Inventory Item Id(s) - Comma separated | Fill-in the parameter... |
ODBC application
Use these SQL queries in your ODBC application data source:
Read multiple inventory items by IDs
<p>Gets multiple inventory items by supplying a comma-separated list of IDs in the <code>Ids</code> parameter within the <code>WITH</code> clause.</p>
select * from InventoryItems WITH(Ids='43512280416356, 43512280449124')
get_inventory_items endpoint belongs to
InventoryItems
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read multiple inventory items by IDs
<p>Gets multiple inventory items by supplying a comma-separated list of IDs in the <code>Ids</code> parameter within the <code>WITH</code> clause.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'select * from InventoryItems WITH(Ids=''43512280416356, 43512280449124'')';
EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];
get_inventory_items endpoint belongs to
InventoryItems
table(s), and can therefore be used via those table(s).