GetShopify

GetShopify 2.0.0

Bundle: org.apache.nifi | nifi-shopify-nar
Description: Retrieves objects from a custom Shopify store. The processor yield time must be set to the account's rate limit accordingly.
Tags: shopify
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Access Token
Access Token to authenticate requests

Display Name

Access Token

Description

Access Token to authenticate requests

API Name

access-token

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

true

Required

true
API Version
The Shopify REST API version

Display Name

API Version

Description

The Shopify REST API version

API Name

api-version

Default Value

2022-10

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Customer Category
Customer resource to query
Display Name

Customer Category

Description

Customer resource to query

API Name

CUSTOMERS

Allowable Values
- Customers
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [CUSTOMERS]
Discount Category
Discount resource to query
Display Name

Discount Category

Description

Discount resource to query

API Name

DISCOUNTS

Allowable Values
- Price Rules
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [DISCOUNTS]
Incremental Delay
The 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.
Display Name

Incremental Delay

Description

The 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.

API Name

incremental-delay

Default Value

3 sec

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dependencies
- Incremental Loading is set to any of [true]
Incremental Initial Start Time
This 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".
Display Name

Incremental Initial Start Time

Description

This 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".

API Name

incremental-initial-start-time

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dependencies
- Incremental Loading is set to any of [true]
Inventory Category
Inventory resource to query
Display Name

Inventory Category

Description

Inventory resource to query

API Name

INVENTORY

Allowable Values
- Locations
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [INVENTORY]
Incremental Loading
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.
Display Name

Incremental Loading

Description

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.

API Name

is-incremental

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Object Category
Shopify object category
Display Name

Object Category

Description

Shopify object category

API Name

object-category

Allowable Values
- Customers
- Discounts
- Inventory
- Online Store
- Orders
- Products
- Sales Channels
- Store Properties
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Online Store Category
Online Store resource to query
Display Name

Online Store Category

Description

Online Store resource to query

API Name

ONLINE_STORE

Allowable Values
- Blogs
- Comments
- Pages
- Redirects
- Script Tags
- Themes
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [ONLINE_STORE]
Order Category
Order resource to query
Display Name

Order Category

Description

Order resource to query

API Name

ORDERS

Allowable Values
- Abandoned Checkouts
- Draft Orders
- Orders
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [ORDERS]
Product Category
Product resource to query
Display Name

Product Category

Description

Product resource to query

API Name

PRODUCT

Allowable Values
- Collects
- Custom Collections
- Products
- Smart Collections
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [PRODUCT]
Result Limit
The maximum number of results to request for each invocation of the Processor

Display Name

Result Limit

Description

The maximum number of results to request for each invocation of the Processor

API Name

result-limit

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Sales Channel Category
Sales Channel resource to query
Display Name

Sales Channel Category

Description

Sales Channel resource to query

API Name

SALES_CHANNELS

Allowable Values
- Collection Listings
- Product Listings
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [SALES_CHANNELS]
Store Domain
The domain of the Shopify store, e.g. nifistore.myshopify.com

Display Name

Store Domain

Description

The domain of the Shopify store, e.g. nifistore.myshopify.com

API Name

store-domain

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Store Property Category
Store Property resource to query
Display Name

Store Property Category

Description

Store Property resource to query

API Name

STORE_PROPERTIES

Allowable Values
- Countries
- Currencies
- Policies
- Shipping Zones
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Object Category is set to any of [STORE_PROPERTIES]
Web Client Service Provider
Controller service for HTTP client operations

Display Name

Web Client Service Provider

Description

Controller service for HTTP client operations

API Name

web-client-service-provider

Service Interface

org.apache.nifi.web.client.provider.api.WebClientServiceProvider

Service Implementations

org.apache.nifi.web.client.provider.service.StandardWebClientServiceProvider

Expression Language Scope

Not Supported

Sensitive

false

Required

true

State Management

Scopes	Description
CLUSTER	For a few resources the processor supports incremental loading. The list of the resources with the supported parameters can be found in the additional details.

Relationships

Name	Description
success	For FlowFiles created as a result of a successful query.

Writes Attributes

Name	Description
mime.type	Sets the MIME type to application/json