GetShopify

Description:

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

Additional Details...

Tags:

shopify

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) 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 Domainstore-domainThe domain of the Shopify store, e.g. nifistore.myshopify.com
Supports Expression Language: true (will be evaluated using variable registry only)
Access Tokenaccess-tokenAccess Token to authenticate requests
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
API Versionapi-version2022-10The Shopify REST API version
Supports Expression Language: true (will be evaluated using variable registry only)
Object Categoryobject-category
  • Customers Query a Customer resource
  • Discounts Query a Discount resource
  • Inventory Query an Inventory resource
  • Online Store Query an Online Store resource
  • Orders Query an Order resource
  • Products Query a Product resource
  • Sales Channels Query a Sales Channel resource
  • Store Properties Query a Store Property resource
Shopify object category
Customer CategoryCUSTOMERS
  • Customers The Customer resource stores information about a shop's customers, such as their contact details, their order history, and whether they've agreed to receive email marketing.
Customer resource to query

This Property is only considered if the [Object Category] Property has a value of "Customers".
Discount CategoryDISCOUNTS
  • Price Rules The PriceRule resource can be used to get discounts using conditions
Discount resource to query

This Property is only considered if the [Object Category] Property has a value of "Discounts".
Inventory CategoryINVENTORY
  • Locations A location represents a geographical location where your stores, pop-up stores, headquarters and warehouses exist.
Inventory resource to query

This Property is only considered if the [Object Category] Property has a value of "Inventory".
Online Store CategoryONLINE_STORE
  • Blogs Shopify shops come with a built-in blogging engine, allowing a shop to have one or more blogs.
  • Comments A comment is a reader's response to an article in a blog.
  • Pages Shopify stores come with a tool for creating basic HTML web pages.
  • Redirects A redirect causes a visitor on a specific path on the shop's site to be automatically sent to a different location.
  • Script Tags The ScriptTag resource represents remote JavaScript code that is loaded into the pages of a shop's storefront or the order status page of checkout.
  • Themes A theme controls the look and feel of a Shopify online store.
Online Store resource to query

This Property is only considered if the [Object Category] Property has a value of "Online Store".
Order CategoryORDERS
  • Abandoned Checkouts A checkout is considered abandoned after the customer has added contact information, but before the customer has completed their purchase.
  • Draft Orders Merchants can use draft orders to create orders on behalf of their customers.
  • Orders An order is a customer's request to purchase one or more products from a shop.
Order resource to query

This Property is only considered if the [Object Category] Property has a value of "Orders".
Product CategoryPRODUCT
  • Collects Collects are meant for managing the relationship between products and custom collections.
  • Custom Collections A custom collection is a grouping of products that a merchant can create to make their store easier to browse.
  • Products Get products in a merchant's store
  • Smart Collections A smart collection is a grouping of products defined by rules that are set by the merchant.
Product resource to query

This Property is only considered if the [Object Category] Property has a value of "Products".
Sales Channel CategorySALES_CHANNELS
  • Collection Listings A CollectionListing resource represents a product collection that a merchant has made available to your sales channel.
  • Product Listings A ProductListing resource represents a Product which is available to your sales channel.
Sales Channel resource to query

This Property is only considered if the [Object Category] Property has a value of "Sales Channels".
Store Property CategorySTORE_PROPERTIES
  • Countries The Country resource represents the tax rates applied to orders from the different countries where a shop sells its products.
  • Currencies Merchants who use Shopify Payments can allow customers to pay in their local currency on the online store.
  • Policies Policy resource can be used to access the policies that a merchant has configured for their shop, such as their refund and privacy policies.
  • Shipping Zones ShippingZone resource can be used to view shipping zones and their countries, provinces, and shipping rates.
Store Property resource to query

This Property is only considered if the [Object Category] Property has a value of "Store Properties".
Result Limitresult-limitThe maximum number of results to request for each invocation of the Processor
Supports Expression Language: true (will be evaluated using variable registry only)
Incremental Loadingis-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: true (will be evaluated using variable registry only)

This Property is only considered if the [Incremental Loading] Property 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: true (will be evaluated using variable registry only)

This Property is only considered if the [Incremental Loading] Property has a value of "true".
Web Client Service Providerweb-client-service-providerController Service API:
WebClientServiceProvider
Implementation: StandardWebClientServiceProvider		Controller service for HTTP client operations

Relationships:

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

Reads Attributes:

None specified.

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:

None specified.