shopr_get_inventory_levels: Get Inventory Levels

In GormAnalysis/shopr: Connecting the Shopify API with R

Description

Retrieve inventory levels for a shop

Usage

shopr_get_inventory_levels(
  shopURL,
  APIKey,
  APIPassword,
  APIVersion = NULL,
  max_pages = Inf,
  limit_per_page = 250L,
  inventory_item_ids = NULL,
  location_ids = NULL,
  updated_at_min = NULL,
  verbose = FALSE
)

Arguments

shopURL	shop URL (e.g. 'https://superstore-1.myshopify.com')
APIKey	API key
APIPassword	API password
APIVersion	API version (default = NULL -> use the latest version)
max_pages	max number of pages of orders to return. (default = Inf)
limit_per_page	max number of results to return per request. Should be in the range [1, 250]. (default = 250)
inventory_item_ids	inventory item ids. At least one of inventory_item_ids and location_ids must be provided. (default = NULL)
location_ids	location ids. At least one of inventory_item_ids and location_ids must be provided. (default = NULL)
updated_at_min	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
verbose	should progress messages be printed? (default = FALSE)

Details

An inventory level represents the available quantity of an inventory item at a specific location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item is available, there's an inventory level that represents the inventory item's quantity at that location:

Value

data.table of inventory levels

References

https://help.shopify.com/en/api/reference/inventory/inventorylevel#index

GormAnalysis/shopr documentation built on Jan. 10, 2022, 1:42 a.m.