shopr_get_orders_count: Get Orders Count

In GormAnalysis/shopr: Connecting the Shopify API with R

Description

Retrieve the number of orders for a shop satisfying some criteria

Usage

shopr_get_orders_count(
  shopURL,
  APIKey,
  APIPassword,
  APIVersion = NULL,
  ids = NULL,
  since_id = NULL,
  created_at_min = NULL,
  created_at_max = NULL,
  updated_at_min = NULL,
  updated_at_max = NULL,
  processed_at_min = NULL,
  processed_at_max = NULL,
  status = "any",
  financial_status = NULL,
  fulfillment_status = 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)
ids	vector of order ids like c(123, 456) (default = NULL)
since_id	only consider orders with id > since_id (default = 0)
created_at_min	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
created_at_max	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
updated_at_min	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
updated_at_max	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
processed_at_min	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
processed_at_max	POSIXct datetime or a string with format like '2014-04-25T16:15:47-04:00' (default = NULL)
status	order status. Should be NULL or one of {'open', 'closed', 'any'}. (default = 'any')
financial_status	financial status. Should be NULL or one of {'any', 'authorized', 'pending', 'paid', 'refunded', 'voided'}. (default = NULL)
fulfillment_status	fulfillment status. Should be NULL or one of {'any', 'shipped', 'partial', 'unshipped'}. (default = NULL)
verbose	should progress messages be printed? (default = FALSE)

Value

number of orders

References

https://help.shopify.com/en/api/reference/orders/order#count

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