shopr_get_locations: Get Locations

Description Usage Arguments Details Value References Examples

View source: R/shopr_get_locations.R

Description

Retrieve the locations associated with a shop

Usage

1
2
3
4
5
6
7
shopr_get_locations(
  shopURL,
  APIKey,
  APIPassword,
  APIVersion = NULL,
  verbose = FALSE
)

Arguments

shopURL

shop url (e.g. 'https://superstore-1.myshopify.com')

APIKey

API key

APIPassword

API password

APIVersion

API version

verbose

should progress messages be printed? (default FALSE)

Details

A location represents a geographical location where stores, pop-up stores, headquarters, and warehouses exist. The Location resource can be used to track sales, manage inventory, and configure the tax rates to apply at checkout.

Value

data.table of locations

References

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

Examples

1
2
3
4
5
shopr_get_locations(
  shopURL = "https://superstore-1.myshopify.com",
  APIKey = "abc123",
  APIPassword = "123abc"
)

ben519/shopr documentation built on Jan. 5, 2022, 12:24 a.m.