shopr_get_inventory_items: Get Inventory Items

Description Usage Arguments Details Value References

View source: R/shopr_get_inventory_items.R

Description

Retrieve inventory items for a shop

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
shopr_get_inventory_items(
  shopURL,
  APIKey,
  APIPassword,
  APIVersion = NULL,
  max_pages = Inf,
  limit_per_page = 250L,
  ids,
  since_id = 0L,
  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

maximum pages of records to return (i.e. the maximum number of HTTP GET requests to make). (default = Inf)

limit_per_page

maximum number of records to return per page (i.e. per HTTP GET request). Should be in the range [1, 250]. (default = 250)

ids

vector of inventory item ids like c(123, 456) (REQUIRED)

since_id

only return inventory items with id > since_id (default = 0)

verbose

should progress messages be printed? (default = FALSE)

Details

An inventory item represents the physical good available to be shipped to a customer. It holds essential information about the physical good, including its SKU and whether its inventory is tracked.

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 inventory information.

Use the InventoryItem resource together with the InventoryLevel and Location resources to manage a store's inventory across multiple locations.

Value

data.table of inventory items

References

https://help.shopify.com/en/api/reference/inventory/inventoryitem


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