Skip to main content

GetShopify

Description​

Retrieves objects from a custom Shopify store. The processor yield time must be set to the account's rate limit accordingly.

Tags​

shopify

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Store Domain *store-domainThe domain of the Shopify store, e.g. nifistore.myshopify.com

Supports Expression Language, using Environment variables.
Access Token *access-tokenAccess Token to authenticate requests

Supports Expression Language, using Environment variables.
API Version *api-version2022-10The Shopify REST API version

Supports Expression Language, using Environment variables.
Object Category *object-category
  • Customers
  • Discounts
  • Inventory
  • Online Store
  • Orders
  • Products
  • Sales Channels
  • Store Properties
Shopify object category
Customer Category *CUSTOMERS
  • Customers
Customer resource to query

This property is only considered if:
  • the property Object Category has a value of CUSTOMERS
Discount Category *DISCOUNTS
  • Price Rules
Discount resource to query

This property is only considered if:
  • the property Object Category has a value of DISCOUNTS
Inventory Category *INVENTORY
  • Locations
Inventory resource to query

This property is only considered if:
  • the property Object Category has a value of INVENTORY
Online Store Category *ONLINE_STORE
  • Blogs
  • Comments
  • Pages
  • Redirects
  • Script Tags
  • Themes
Online Store resource to query

This property is only considered if:
  • the property Object Category has a value of ONLINE_STORE
Order Category *ORDERS
  • Abandoned Checkouts
  • Draft Orders
  • Orders
Order resource to query

This property is only considered if:
  • the property Object Category has a value of ORDERS
Product Category *PRODUCT
  • Collects
  • Custom Collections
  • Products
  • Smart Collections
Product resource to query

This property is only considered if:
  • the property Object Category has a value of PRODUCT
Sales Channel Category *SALES_CHANNELS
  • Collection Listings
  • Product Listings
Sales Channel resource to query

This property is only considered if:
  • the property Object Category has a value of SALES_CHANNELS
Store Property Category *STORE_PROPERTIES
  • Countries
  • Currencies
  • Policies
  • Shipping Zones
Store Property resource to query

This property is only considered if:
  • the property Object Category has a value of STORE_PROPERTIES
Result Limitresult-limitThe maximum number of results to request for each invocation of the Processor

Supports Expression Language, using Environment variables.
Incremental Loading *is-incrementaltrue
  • true
  • false
The processor can incrementally load the queried objects so that each object is queried exactly once. For each query, the processor queries objects which were created or modified after the previous run time but before the current time.
Incremental Delayincremental-delay3 secThe ending timestamp of the time window will be adjusted earlier by the amount configured in this property. For example, with a property value of 10 seconds, an ending timestamp of 12:30:45 would be changed to 12:30:35. Set this property to avoid missing objects when the clock of your local machines and Shopify servers' clock are not in sync.

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property Incremental Loading has a value of true
Incremental Initial Start Timeincremental-initial-start-timeThis property specifies the start time when running the first request. Represents an ISO 8601-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as "2019-09-07T15:50:00Z".

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property Incremental Loading has a value of true
Web Client Service Provider *web-client-service-providerController Service:
WebClientServiceProvider

Implementations:
StandardWebClientServiceProvider		Controller service for HTTP client operations

Dynamic Properties​

This component does not support dynamic properties.

Relationships​

NameDescription
successFor FlowFiles created as a result of a successful query.

Reads Attributes​

This processor does not read attributes.

Writes Attributes​

NameDescription
mime.typeSets the MIME type to application/json

State Management​

ScopeDescription
CLUSTERFor a few resources the processor supports incremental loading. The list of the resources with the supported parameters can be found in the additional details.

Restricted​

This component is not restricted.

Input Requirement​

This component does not allow an incoming relationship.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​