shopr_make_requests: Make Requests

Description Usage Arguments Value References

View source: R/shopr_make_requests.R

Description

Generic helper method for making API requests that return paginated results using cursor-based pagination

Usage

1
2
3
4
5
6
7
8
9
shopr_make_requests(
  requestURL,
  params,
  pagesN,
  maxPages = Inf,
  APIKey,
  APIPassword,
  verbose = FALSE
)

Arguments

requestURL

e.g. https://abc.myshopify.com/admin/api/2020-01/orders.json?limit=250&since_id=0

params

list of request parameters that must include 'limit'

pagesN

expected number of pages to be returned (used for printing progress and initializing response list)

maxPages

maximum number of pages to return (default = Inf)

APIKey

API key

APIPassword

API password

verbose

should progress messages be printed? (default = FALSE)

Value

list of http responses

References

https://help.shopify.com/en/api/guides/paginated-rest-results


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