Shopify Connector for SSIS

Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.

In this article you will learn how to quickly and efficiently integrate Shopify data in SSIS without coding. We will use high-performance Shopify Connector to easily connect to Shopify and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Video Tutorial - Integrate Shopify data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Shopify integration in SSIS
  • How to configure the connection for Shopify
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Shopify in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Shopify in SSIS (Export data)

In this section we will learn how to configure and use Shopify Connector in API Source to extract data from Shopify.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom

    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop
  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Shopify Connector from Popular Connector List or press Search Online radio button to download Shopify Connector. Once downloaded simply use it in the configuration:

    Shopify
    Shopify Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Steps how to get and use Shopify credentials : Access Token [Http]
    Setting up your Shopify store account for API access involves creating an "app" for your store. The "app" is installed into the Shopify account and configured with the appropriate access levels for your data integration needs.
    1. Visit https://accounts.shopify.com and log into your Shopify store account.
    2. After logging in, select the store to connect to with the ZappySys Shopify Connector.
    3. Select the Settings link (usually in the lower-left corner) to launch the Settings screen.
    4. On the left menu panel, select Apps and sales channels.
    5. On the Apps and sales channels screen, select Develop apps (near the top of the screen).
    6. On the App development screen, select Create an app (near the upper-right corner of the screen).
    7. Give the app that will be used to provide Shopify API access a name, select the appropriate developer from the App developer drop-down, and then select Create app.
    8. Select Configure Admin API scopes and the Admin API access scopes screen will appear.
    9. In the Admin API access scopes screen, select every access scope checkbox that applies to your integration needs. It is generally not a good idea to allow more access than what is needed in order to fulfill your integration needs.
      • To enable the reading of customer information, select read_customers.
      • To enable the writing of customer information, select write_customers.
      • To enable the reading of inventory item information, select read_inventory.
      • To enable the writing of inventory item information, select write_inventory.
      • To enable the reading of order information, select read_orders.
      • To enable the writing of order information, select write_orders.
      After selecting all applicable access scopes, select Save.
    10. Install the app by selecting the Install app button (near the upper-right corner of the screen). If any other prompts for installation appears, select Install.
    11. After the app is installed, the Admin API access token will be available in the API credentials tab of the page. It can only be revealed ONCE for security purposes. Select Reveal token once to show the new Admin API access token. SAVE THE ADMIN API ACCESS TOKEN IN A SAFE PLACE WHERE YOU HAVE IT CONFIDENTIAL, SECURE, AND NOT ACCESSIBLE TO UNAUTHORIZED INDIVIDUALS. The Admin API access token will be needed in this process later.
    12. In the ZappySys connector API screen, enter the subdomain of your Shopify store into the Subdomain parameter textbox. For example, if your Shopify URL is https://acmetoys.myshopify.com, the subdomain would be acmetoys.
    13. In the same screen, enter the Admin API access token saved from step 11 above into the Admin API Access Token textbox. In order to edit the text in this field, select the ellipses (...) button that appears when the textbox is clicked and edit the access token with the dialog box that appears.
    14. Select the Test Connection button at the bottom of the window to verify proper connectivity with the Shopify store.
    15. If the connection test succeeds, select OK.

    Configuring authentication parameters
    Shopify
    Access Token [Http]
    https://[$Subdomain$].myshopify.com/admin/api/2023-01
    Required Parameters
    Sub-domain Fill-in the parameter...
    Admin API Access Token Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Shopify
    Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Shopify using Shopify Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Shopify and load into target

Write data to Shopify using SSIS (Import data)

In this section we will learn how to configure and use Shopify Connector in the API Destination to write data to Shopify.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Shopify integration in SSIS
  • How to configure connection for Shopify
  • How to write or lookup data to Shopify
  • Features about SSIS API Destination
  • Using Shopify Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Shopify in the API Source to POST data to the Shopify.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - Shopify
    Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.
    API Destination - New Connection

  4. Use a preinstalled Shopify Connector from Popular Connector List or press Search Online radio button to download Shopify Connector. Once downloaded simply use it in the configuration:

    Shopify
    Shopify Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Steps how to get and use Shopify credentials : Access Token [Http]
    Setting up your Shopify store account for API access involves creating an "app" for your store. The "app" is installed into the Shopify account and configured with the appropriate access levels for your data integration needs.
    1. Visit https://accounts.shopify.com and log into your Shopify store account.
    2. After logging in, select the store to connect to with the ZappySys Shopify Connector.
    3. Select the Settings link (usually in the lower-left corner) to launch the Settings screen.
    4. On the left menu panel, select Apps and sales channels.
    5. On the Apps and sales channels screen, select Develop apps (near the top of the screen).
    6. On the App development screen, select Create an app (near the upper-right corner of the screen).
    7. Give the app that will be used to provide Shopify API access a name, select the appropriate developer from the App developer drop-down, and then select Create app.
    8. Select Configure Admin API scopes and the Admin API access scopes screen will appear.
    9. In the Admin API access scopes screen, select every access scope checkbox that applies to your integration needs. It is generally not a good idea to allow more access than what is needed in order to fulfill your integration needs.
      • To enable the reading of customer information, select read_customers.
      • To enable the writing of customer information, select write_customers.
      • To enable the reading of inventory item information, select read_inventory.
      • To enable the writing of inventory item information, select write_inventory.
      • To enable the reading of order information, select read_orders.
      • To enable the writing of order information, select write_orders.
      After selecting all applicable access scopes, select Save.
    10. Install the app by selecting the Install app button (near the upper-right corner of the screen). If any other prompts for installation appears, select Install.
    11. After the app is installed, the Admin API access token will be available in the API credentials tab of the page. It can only be revealed ONCE for security purposes. Select Reveal token once to show the new Admin API access token. SAVE THE ADMIN API ACCESS TOKEN IN A SAFE PLACE WHERE YOU HAVE IT CONFIDENTIAL, SECURE, AND NOT ACCESSIBLE TO UNAUTHORIZED INDIVIDUALS. The Admin API access token will be needed in this process later.
    12. In the ZappySys connector API screen, enter the subdomain of your Shopify store into the Subdomain parameter textbox. For example, if your Shopify URL is https://acmetoys.myshopify.com, the subdomain would be acmetoys.
    13. In the same screen, enter the Admin API access token saved from step 11 above into the Admin API Access Token textbox. In order to edit the text in this field, select the ellipses (...) button that appears when the textbox is clicked and edit the access token with the dialog box that appears.
    14. Select the Test Connection button at the bottom of the window to verify proper connectivity with the Shopify store.
    15. If the connection test succeeds, select OK.

    Configuring authentication parameters
    Shopify
    Access Token [Http]
    https://[$Subdomain$].myshopify.com/admin/api/2023-01
    Required Parameters
    Sub-domain Fill-in the parameter...
    Admin API Access Token Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Shopify
    Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - Shopify
    Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Shopify API call using ZappySys Shopify Connector

    Execute Package - Reading data from API Source and load into target

Load Shopify data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Shopify data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table
  9. Click OK to save the configuration.

  10. Run the package and Shopify data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target
  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Actions supported by Shopify Connector

Shopify Connector supports following actions for REST API integration:

Create a Customer

Description

Creates a new customer.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • FirstName
  • LastName
  • Email
  • Phone
  • Password
  • PasswordConfirmation
  • SendWelcomeEmail
  • MultipassIdentifier
  • Note
  • Tags
  • TaxExempt
  • TaxExemptions
  • DefaultAddressFirstName
  • DefaultAddressLastName
  • DefaultAddressCompany
  • DefaultAddressLine1
  • DefaultAddressLine2
  • DefaultAddressCity
  • DefaultAddressProvince
  • DefaultAddressCountry
  • DefaultAddressZip
  • DefaultAddressPhone
  • DefaultAddressName
  • DefaultAddressProvinceCode
  • DefaultAddressCountryCode
  • DefaultAddressCountryName

Output Fields

The following fields are returned after calling this action:

  • Id
  • Email
  • AcceptsMarketing
  • CreatedAt
  • UpdatedAt
  • FirstName
  • LastName
  • OrdersCount
  • State
  • TotalSpent
  • LastOrderId
  • Note
  • VerifiedEmail
  • MultipassIdentifier
  • TaxExempt
  • TaxExemptions
  • Tags
  • LastOrderName
  • Currency
  • Phone
  • AcceptsMarketingUpdatedAt
  • MarketingOptInLevel
  • SMSMarketingConsent
  • AdminGraphQLApiId
  • DefaultAddressId
  • DefaultAddressCustomerId
  • DefaultAddressFirstName
  • DefaultAddressLastName
  • DefaultAddressCompany
  • DefaultAddressAddress1
  • DefaultAddressAddress2
  • DefaultAddressCity
  • DefaultAddressProvince
  • DefaultAddressCountry
  • DefaultAddressZip
  • DefaultAddressPhone
  • DefaultAddressName
  • DefaultAddressProvinceCode
  • DefaultAddressCountryCode
  • DefaultAddressCountryName
  • EmailMarketingConsentState
  • EmailMarketingConsentOptInLevel
  • EmailMarketingConsentUpdatedAt

Visit documentation for more information.

Create a Location

Description

Creates a new location.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • Name
  • Active
  • Address1
  • Address2
  • City
  • Province
  • Zip
  • Country
  • Phone
  • ProvinceCode
  • CountryCode
  • CountryName
  • LocalizedProvinceName
  • LocalizedCountryName

Output Fields

The following fields are returned after calling this action:

  • Id
  • Name
  • Active
  • Address1
  • Address2
  • City
  • Province
  • Zip
  • Country
  • Phone
  • ProvinceCode
  • CountryCode
  • CountryName
  • LocalizedProvinceName
  • LocalizedCountryName
  • Legacy
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Create a Product

Description

Creates a new product.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • Title
  • BodyHtml
  • UrlHandle
  • ProductType
  • Status
  • Vendor
  • TemplateSuffix
  • PublishedScope
  • Tags
  • Variants
  • Options
  • Images
  • Metafields
  • SEOTitle
  • SEODescription

Output Fields

The following fields are returned after calling this action:

  • Id
  • Title
  • BodyHtml
  • Vendor
  • ProductType
  • CreatedAt
  • UrlHandle
  • UpdatedAt
  • PublishedAt
  • TemplateSuffix
  • Status
  • PublishedScope
  • Tags
  • AdminGraphqlApiId
  • Variants
  • Options
  • Images
  • Image
  • ImageId
  • ImageProductId
  • ImagePosition
  • ImageCreatedAt
  • ImageUpdatedAt
  • ImageAlt
  • ImageWidth
  • ImageHeight
  • ImageSrc
  • ImageVariantIds
  • ImageAdminGraphqlApiId
  • Metafields

Visit documentation for more information.

Create a Product Variant

Description

Creates a new product variant.

Parameters

You can provide the following parameters to this action:

  • Product Id

Input Fields

You can provide the following fields to this action:

  • Id
  • ProductId
  • Title
  • Price
  • Sku
  • Position
  • InventoryPolicy
  • CompareAtPrice
  • FulfillmentService
  • InventoryManagement
  • Option1
  • Option2
  • Option3
  • Taxable
  • Barcode
  • Grams
  • ImageId
  • Weight
  • WeightUnit
  • InventoryItemId
  • InventoryQuantity
  • OldInventoryQuantity
  • RequiresShipping
  • AdminGraphqlApiId
  • ProductId

Output Fields

The following fields are returned after calling this action:

  • Id
  • ProductId
  • Title
  • Sku
  • Price
  • CompareAtPrice
  • Position
  • Option1
  • Option2
  • Option3
  • CreatedAt
  • UpdatedAt
  • Taxable
  • InventoryItemId
  • InventoryQuantity
  • OldInventoryQuantity
  • InventoryPolicy
  • InventoryManagement
  • FulfillmentService
  • Barcode
  • Grams
  • ImageId
  • Weight
  • WeightUnit
  • RequiresShipping
  • AdminGraphqlApiId
  • PresentmentPrices

Visit documentation for more information.

Create an Order

Description

Creates a new order.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BuyerAcceptsMarketing
  • LineItems
  • CustomerId
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • FulfillmentStatus
  • LocationId
  • MerchantOfRecordAppId
  • Name
  • Note
  • Phone
  • Currency
  • PresentmentCurrency
  • ProcessedAt
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • Tags
  • TaxesIncluded
  • TotalWeight
  • UserId
  • InventoryBehaviour
  • SendReceipt
  • SendFulfillmentReceipt

Output Fields

The following fields are returned after calling this action:

  • Id
  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BrowserIp
  • BuyerAcceptsMarketing
  • LineItems
  • CancelReason
  • CancelledAt
  • CartToken
  • CheckoutToken
  • ClientDetailsAcceptLanguage
  • ClientDetailsBrowserHeight
  • ClientDetailsBrowserIp
  • ClientDetailsBrowserWidth
  • ClientDetailsSessionHash
  • ClientDetailsUserAgent
  • ClosedAt
  • CompanyId
  • CompanyLocationId
  • CreatedAt
  • Currency
  • CurrentTotalDiscounts
  • CurrentTotalDiscountsShopMoneyAmount
  • CurrentTotalDiscountsShopMoneyCurrencyCode
  • CurrentTotalDiscountsPresentmentMoneyAmount
  • CurrentTotalDiscountsPresentmentMoneyCurrencyCode
  • CurrentTotalDutiesShopMoneyAmount
  • CurrentTotalDutiesShopMoneyCurrencyCode
  • CurrentTotalDutiesPresentmentMoneyAmount
  • CurrentTotalDutiesPresentmentMoneyCurrencyCode
  • CurrentTotalPrice
  • CurrentTotalPriceShopMoneyAmount
  • CurrentTotalPriceShopMoneyCurrencyCode
  • CurrentTotalPricePresentmentMoneyAmount
  • CurrentTotalPricePresentmentMoneyCurrencyCode
  • CurrentSubtotalPrice
  • CurrentSubtotalPriceShopMoneyAmount
  • CurrentSubtotalPriceShopMoneyCurrencyCode
  • CurrentSubtotalPricePresentmentMoneyAmount
  • CurrentSubtotalPricePresentmentMoneyCurrencyCode
  • CurrentTotalTax
  • CurrentTotalTaxShopMoneyAmount
  • CurrentTotalTaxShopMoneyCurrencyCode
  • CurrentTotalTaxPresentmentMoneyAmount
  • CurrentTotalTaxPresentmentMoneyCurrencyCode
  • CustomerId
  • CustomerLocale
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • FulfillmentStatus
  • LandingSite
  • LocationId
  • MerchantOfRecordAppId
  • Name
  • Note
  • Number
  • OrderNumber
  • OriginalTotalDutiesShopMoneyAmount
  • OriginalTotalDutiesShopMoneyCurrencyCode
  • OriginalTotalDutiesPresentmentMoneyAmount
  • OriginalTotalDutiesPresentmentMoneyCurrencyCode
  • PaymentTermsAmount
  • PaymentTermsCurrency
  • PaymentTermsName
  • PaymentTermsType
  • PaymentTermsDueInDays
  • Phone
  • PresentmentCurrency
  • ProcessedAt
  • ProcessingMethod
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • SubtotalPrice
  • SubtotalPriceSetShopMoneyAmount
  • SubtotalPriceSetShopMoneyCurrencyCode
  • SubtotalPriceSetPresentmentMoneyAmount
  • SubtotalPriceSetPresentmentMoneyCurrencyCode
  • Tags
  • TaxesIncluded
  • Test
  • Token
  • TotalDiscounts
  • TotalDiscountsSetShopMoneyAmount
  • TotalDiscountsSetShopMoneyCurrencyCode
  • TotalDiscountsSetPresentmentMoneyAmount
  • TotalDiscountsSetPresentmentMoneyCurrencyCode
  • TotalLineItemsPrice
  • TotalLineItemsPriceSetShopMoneyAmount
  • TotalLineItemsPriceSetShopMoneyCurrencyCode
  • TotalLineItemsPriceSetPresentmentMoneyAmount
  • TotalLineItemsPriceSetPresentmentMoneyCurrencyCode
  • TotalOutstanding
  • TotalPrice
  • TotalPriceSetShopMoneyAmount
  • TotalPriceSetShopMoneyCurrencyCode
  • TotalPriceSetPresentmentMoneyAmount
  • TotalPriceSetPresentmentMoneyCurrencyCode
  • TotalShippingPriceSetShopMoneyAmount
  • TotalShippingPriceSetShopMoneyCurrencyCode
  • TotalShippingPriceSetPresentmentMoneyAmount
  • TotalShippingPriceSetPresentmentMoneyCurrencyCode
  • TotalTax
  • TotalTaxSetShopMoneyAmount
  • TotalTaxSetShopMoneyCurrencyCode
  • TotalTaxSetPresentmentMoneyAmount
  • TotalTaxSetPresentmentMoneyCurrencyCode
  • TotalTipReceived
  • TotalWeight
  • UpdatedAt
  • UserId
  • OrderStatusUrl

Visit documentation for more information.

Delete a Customer

Description

Deletes a specific customer.

Parameters

You can provide the following parameters to this action:

  • Customer Id

Input Fields

You can provide the following fields to this action:

  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Response

Visit documentation for more information.

Delete a Location

Description

Deletes a specific location.

Parameters

You can provide the following parameters to this action:

  • Location Id

Input Fields

You can provide the following fields to this action:

  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Response

Visit documentation for more information.

Delete a product

Description

Deletes a specific product.

Parameters

You can provide the following parameters to this action:

  • Product Id

Input Fields

You can provide the following fields to this action:

  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Response

Visit documentation for more information.

Delete a product variant

Description

Deletes a specific product variant.

Parameters

You can provide the following parameters to this action:

  • Product Variant Id

Input Fields

You can provide the following fields to this action:

  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Response

Visit documentation for more information.

Delete an Order

Description

Deletes a specific order.

Parameters

You can provide the following parameters to this action:

  • Order Id

Input Fields

You can provide the following fields to this action:

  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Response

Visit documentation for more information.

Get Customer

Description

Gets a specific customer.

Parameters

You can provide the following parameters to this action:

  • Customer Id
  • Only Fields to Show

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Email
  • AcceptsMarketing
  • CreatedAt
  • UpdatedAt
  • FirstName
  • LastName
  • OrdersCount
  • State
  • TotalSpent
  • LastOrderId
  • Note
  • VerifiedEmail
  • MultipassIdentifier
  • TaxExempt
  • TaxExemptions
  • Tags
  • LastOrderName
  • Currency
  • Phone
  • AcceptsMarketingUpdatedAt
  • MarketingOptInLevel
  • SMSMarketingConsent
  • AdminGraphQLApiId
  • DefaultAddressId
  • DefaultAddressCustomerId
  • DefaultAddressFirstName
  • DefaultAddressLastName
  • DefaultAddressCompany
  • DefaultAddressAddress1
  • DefaultAddressAddress2
  • DefaultAddressCity
  • DefaultAddressProvince
  • DefaultAddressCountry
  • DefaultAddressZip
  • DefaultAddressPhone
  • DefaultAddressName
  • DefaultAddressProvinceCode
  • DefaultAddressCountryCode
  • DefaultAddressCountryName
  • EmailMarketingConsentState
  • EmailMarketingConsentOptInLevel
  • EmailMarketingConsentUpdatedAt

Visit documentation for more information.

Get Customers

Description

Gets a list of customers.

Parameters

You can provide the following parameters to this action:

  • Customer Id(s) - Comma separated
  • Since Customer Id
  • Page Size
  • Only Fields to Show
  • Created Before
  • Created After
  • Updated Before
  • Updated After

Input Fields

You can provide the following fields to this action:

  • CustomerId

Output Fields

The following fields are returned after calling this action:

  • Id
  • Email
  • AcceptsMarketing
  • CreatedAt
  • UpdatedAt
  • FirstName
  • LastName
  • OrdersCount
  • State
  • TotalSpent
  • LastOrderId
  • Note
  • VerifiedEmail
  • MultipassIdentifier
  • TaxExempt
  • TaxExemptions
  • Tags
  • LastOrderName
  • Currency
  • Phone
  • AcceptsMarketingUpdatedAt
  • MarketingOptInLevel
  • SMSMarketingConsent
  • AdminGraphQLApiId
  • DefaultAddressId
  • DefaultAddressCustomerId
  • DefaultAddressFirstName
  • DefaultAddressLastName
  • DefaultAddressCompany
  • DefaultAddressAddress1
  • DefaultAddressAddress2
  • DefaultAddressCity
  • DefaultAddressProvince
  • DefaultAddressCountry
  • DefaultAddressZip
  • DefaultAddressPhone
  • DefaultAddressName
  • DefaultAddressProvinceCode
  • DefaultAddressCountryCode
  • DefaultAddressCountryName
  • EmailMarketingConsentState
  • EmailMarketingConsentOptInLevel
  • EmailMarketingConsentUpdatedAt

Visit documentation for more information.

Get Inventory Item

Description

Gets a specific inventory item.

Parameters

You can provide the following parameters to this action:

  • Inventory Item Id(s) - Comma separated

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Sku
  • Cost
  • Tracked
  • RequiresShipping
  • CountryCodeOfOrigin
  • ProvinceCodeOfOrigin
  • CountryHarmonizedSystemCodes
  • HarmonizedSystemCode
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Get Inventory Items

Description

Gets a list of inventory items. Each Product Variant has Inventory Item Id .. Its one to one relationship with Product Variant and Inventory Item. Query get_product_variants to get InventoryItemId and use as Id in this endpoint.

Parameters

You can provide the following parameters to this action:

  • Inventory Item Id(s) - Comma separated
  • Page Size

Input Fields

You can provide the following fields to this action:

  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Sku
  • Cost
  • Tracked
  • RequiresShipping
  • CountryCodeOfOrigin
  • ProvinceCodeOfOrigin
  • CountryHarmonizedSystemCodes
  • HarmonizedSystemCode
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Get Inventory Levels

Description

Gets inventory level for a specific location and inventory item.

Parameters

You can provide the following parameters to this action:

  • inventory_item_ids
  • location_ids
  • Updated at or after
  • Page Size

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • InventoryItemId
  • LocationId
  • UpdatedAt
  • Available

Visit documentation for more information.

Get Location

Description

Gets a specific location.

Parameters

You can provide the following parameters to this action:

  • Location Id

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Name
  • Active
  • Address1
  • Address2
  • City
  • Province
  • Zip
  • Country
  • Phone
  • ProvinceCode
  • CountryCode
  • CountryName
  • LocalizedProvinceName
  • LocalizedCountryName
  • Legacy
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Get Locations

Description

Gets a list of locations.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Name
  • Active
  • Address1
  • Address2
  • City
  • Province
  • Zip
  • Country
  • Phone
  • ProvinceCode
  • CountryCode
  • CountryName
  • LocalizedProvinceName
  • LocalizedCountryName
  • Legacy
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Get Order

Description

Gets a specific order.

Parameters

You can provide the following parameters to this action:

  • Order Id
  • Only Fields to Show

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BrowserIp
  • BuyerAcceptsMarketing
  • LineItems
  • CancelReason
  • CancelledAt
  • CartToken
  • CheckoutToken
  • ClientDetailsAcceptLanguage
  • ClientDetailsBrowserHeight
  • ClientDetailsBrowserIp
  • ClientDetailsBrowserWidth
  • ClientDetailsSessionHash
  • ClientDetailsUserAgent
  • ClosedAt
  • CompanyId
  • CompanyLocationId
  • CreatedAt
  • Currency
  • CurrentTotalDiscounts
  • CurrentTotalDiscountsShopMoneyAmount
  • CurrentTotalDiscountsShopMoneyCurrencyCode
  • CurrentTotalDiscountsPresentmentMoneyAmount
  • CurrentTotalDiscountsPresentmentMoneyCurrencyCode
  • CurrentTotalDutiesShopMoneyAmount
  • CurrentTotalDutiesShopMoneyCurrencyCode
  • CurrentTotalDutiesPresentmentMoneyAmount
  • CurrentTotalDutiesPresentmentMoneyCurrencyCode
  • CurrentTotalPrice
  • CurrentTotalPriceShopMoneyAmount
  • CurrentTotalPriceShopMoneyCurrencyCode
  • CurrentTotalPricePresentmentMoneyAmount
  • CurrentTotalPricePresentmentMoneyCurrencyCode
  • CurrentSubtotalPrice
  • CurrentSubtotalPriceShopMoneyAmount
  • CurrentSubtotalPriceShopMoneyCurrencyCode
  • CurrentSubtotalPricePresentmentMoneyAmount
  • CurrentSubtotalPricePresentmentMoneyCurrencyCode
  • CurrentTotalTax
  • CurrentTotalTaxShopMoneyAmount
  • CurrentTotalTaxShopMoneyCurrencyCode
  • CurrentTotalTaxPresentmentMoneyAmount
  • CurrentTotalTaxPresentmentMoneyCurrencyCode
  • CustomerId
  • CustomerLocale
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • FulfillmentStatus
  • LandingSite
  • LocationId
  • MerchantOfRecordAppId
  • Name
  • Note
  • Number
  • OrderNumber
  • OriginalTotalDutiesShopMoneyAmount
  • OriginalTotalDutiesShopMoneyCurrencyCode
  • OriginalTotalDutiesPresentmentMoneyAmount
  • OriginalTotalDutiesPresentmentMoneyCurrencyCode
  • PaymentTermsAmount
  • PaymentTermsCurrency
  • PaymentTermsName
  • PaymentTermsType
  • PaymentTermsDueInDays
  • Phone
  • PresentmentCurrency
  • ProcessedAt
  • ProcessingMethod
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • SubtotalPrice
  • SubtotalPriceSetShopMoneyAmount
  • SubtotalPriceSetShopMoneyCurrencyCode
  • SubtotalPriceSetPresentmentMoneyAmount
  • SubtotalPriceSetPresentmentMoneyCurrencyCode
  • Tags
  • TaxesIncluded
  • Test
  • Token
  • TotalDiscounts
  • TotalDiscountsSetShopMoneyAmount
  • TotalDiscountsSetShopMoneyCurrencyCode
  • TotalDiscountsSetPresentmentMoneyAmount
  • TotalDiscountsSetPresentmentMoneyCurrencyCode
  • TotalLineItemsPrice
  • TotalLineItemsPriceSetShopMoneyAmount
  • TotalLineItemsPriceSetShopMoneyCurrencyCode
  • TotalLineItemsPriceSetPresentmentMoneyAmount
  • TotalLineItemsPriceSetPresentmentMoneyCurrencyCode
  • TotalOutstanding
  • TotalPrice
  • TotalPriceSetShopMoneyAmount
  • TotalPriceSetShopMoneyCurrencyCode
  • TotalPriceSetPresentmentMoneyAmount
  • TotalPriceSetPresentmentMoneyCurrencyCode
  • TotalShippingPriceSetShopMoneyAmount
  • TotalShippingPriceSetShopMoneyCurrencyCode
  • TotalShippingPriceSetPresentmentMoneyAmount
  • TotalShippingPriceSetPresentmentMoneyCurrencyCode
  • TotalTax
  • TotalTaxSetShopMoneyAmount
  • TotalTaxSetShopMoneyCurrencyCode
  • TotalTaxSetPresentmentMoneyAmount
  • TotalTaxSetPresentmentMoneyCurrencyCode
  • TotalTipReceived
  • TotalWeight
  • UpdatedAt
  • UserId
  • OrderStatusUrl

Visit documentation for more information.

Get Order Items

Description

Gets a list of line items for all orders or the specified order(s).

Parameters

You can provide the following parameters to this action:

  • Order Id(s) - Comma separated
  • Since Order Id
  • Created Before
  • Created After
  • Updated Before
  • Updated After
  • Attribution App Id
  • Financial Status
  • Fulfillment Status
  • Imported Before
  • Imported After
  • Status
  • Page Size
  • Only Fields to Show

Input Fields

You can provide the following fields to this action:

  • OrderId

Output Fields

The following fields are returned after calling this action:

  • Id
  • OrderId
  • OrderNumber
  • FulfillableQuantity
  • FulfillmentService
  • FulfillmentStatus
  • Grams
  • Price
  • ProductId
  • Quantity
  • RequiresShipping
  • Sku
  • Name
  • Title
  • VariantId
  • VariantTitle
  • Vendor
  • ProductExists
  • GiftCard
  • PriceSetShopMoneyAmount
  • PriceSetShopMoneyCurrencyCode
  • PriceSetPresentmentMoneyAmount
  • PriceSetPresentmentMoneyCurrencyCode
  • Properties
  • Taxable
  • TaxLines
  • TotalDiscount
  • TotalDiscountSetShopMoneyAmount
  • TotalDiscountSetShopMoneyCurrencyCode
  • TotalDiscountSetPresentmentMoneyAmount
  • TotalDiscountSetPresentmentMoneyCurrencyCode
  • DiscountAllocations
  • OriginLocationId
  • OriginLocationCountryCode
  • OriginLocationProvinceCode
  • OriginLocationName
  • OriginLocationAddress1
  • OriginLocationAddress2
  • OriginLocationCity
  • OriginLocationZip
  • Duties
  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BrowserIp
  • BuyerAcceptsMarketing
  • LineItems
  • CancelReason
  • CancelledAt
  • CartToken
  • CheckoutToken
  • ClientDetailsAcceptLanguage
  • ClientDetailsBrowserHeight
  • ClientDetailsBrowserIp
  • ClientDetailsBrowserWidth
  • ClientDetailsSessionHash
  • ClientDetailsUserAgent
  • ClosedAt
  • CompanyId
  • CompanyLocationId
  • CreatedAt
  • Currency
  • CurrentTotalDiscounts
  • CurrentTotalDiscountsShopMoneyAmount
  • CurrentTotalDiscountsShopMoneyCurrencyCode
  • CurrentTotalDiscountsPresentmentMoneyAmount
  • CurrentTotalDiscountsPresentmentMoneyCurrencyCode
  • CurrentTotalDutiesShopMoneyAmount
  • CurrentTotalDutiesShopMoneyCurrencyCode
  • CurrentTotalDutiesPresentmentMoneyAmount
  • CurrentTotalDutiesPresentmentMoneyCurrencyCode
  • CurrentTotalPrice
  • CurrentTotalPriceShopMoneyAmount
  • CurrentTotalPriceShopMoneyCurrencyCode
  • CurrentTotalPricePresentmentMoneyAmount
  • CurrentTotalPricePresentmentMoneyCurrencyCode
  • CurrentSubtotalPrice
  • CurrentSubtotalPriceShopMoneyAmount
  • CurrentSubtotalPriceShopMoneyCurrencyCode
  • CurrentSubtotalPricePresentmentMoneyAmount
  • CurrentSubtotalPricePresentmentMoneyCurrencyCode
  • CurrentTotalTax
  • CurrentTotalTaxShopMoneyAmount
  • CurrentTotalTaxShopMoneyCurrencyCode
  • CurrentTotalTaxPresentmentMoneyAmount
  • CurrentTotalTaxPresentmentMoneyCurrencyCode
  • CustomerId
  • CustomerLocale
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • OrderFulfillmentStatus
  • LandingSite
  • LocationId
  • MerchantOfRecordAppId
  • OrderName
  • Note
  • Number
  • OriginalTotalDutiesShopMoneyAmount
  • OriginalTotalDutiesShopMoneyCurrencyCode
  • OriginalTotalDutiesPresentmentMoneyAmount
  • OriginalTotalDutiesPresentmentMoneyCurrencyCode
  • PaymentTermsAmount
  • PaymentTermsCurrency
  • PaymentTermsName
  • PaymentTermsType
  • PaymentTermsDueInDays
  • Phone
  • PresentmentCurrency
  • ProcessedAt
  • ProcessingMethod
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • SubtotalPrice
  • SubtotalPriceSetShopMoneyAmount
  • SubtotalPriceSetShopMoneyCurrencyCode
  • SubtotalPriceSetPresentmentMoneyAmount
  • SubtotalPriceSetPresentmentMoneyCurrencyCode
  • Tags
  • TaxesIncluded
  • Test
  • Token
  • TotalDiscounts
  • TotalDiscountsSetShopMoneyAmount
  • TotalDiscountsSetShopMoneyCurrencyCode
  • TotalDiscountsSetPresentmentMoneyAmount
  • TotalDiscountsSetPresentmentMoneyCurrencyCode
  • TotalLineItemsPrice
  • TotalLineItemsPriceSetShopMoneyAmount
  • TotalLineItemsPriceSetShopMoneyCurrencyCode
  • TotalLineItemsPriceSetPresentmentMoneyAmount
  • TotalLineItemsPriceSetPresentmentMoneyCurrencyCode
  • TotalOutstanding
  • TotalPrice
  • TotalPriceSetShopMoneyAmount
  • TotalPriceSetShopMoneyCurrencyCode
  • TotalPriceSetPresentmentMoneyAmount
  • TotalPriceSetPresentmentMoneyCurrencyCode
  • TotalShippingPriceSetShopMoneyAmount
  • TotalShippingPriceSetShopMoneyCurrencyCode
  • TotalShippingPriceSetPresentmentMoneyAmount
  • TotalShippingPriceSetPresentmentMoneyCurrencyCode
  • TotalTax
  • TotalTaxSetShopMoneyAmount
  • TotalTaxSetShopMoneyCurrencyCode
  • TotalTaxSetPresentmentMoneyAmount
  • TotalTaxSetPresentmentMoneyCurrencyCode
  • TotalTipReceived
  • TotalWeight
  • UpdatedAt
  • UserId
  • OrderStatusUrl

Visit documentation for more information.

Get Orders

Description

Gets a list of orders by status, date and other search criteria. By default only Open orders returned. Change Status parameter to any to get all orders.

Parameters

You can provide the following parameters to this action:

  • Order Id(s) - Comma separated
  • Since Order Id
  • Created Before
  • Created After
  • Updated Before
  • Updated After
  • Attribution App Id
  • Financial Status
  • Fulfillment Status
  • Imported Before
  • Imported After
  • Status
  • Page Size
  • Only Fields to Show

Input Fields

You can provide the following fields to this action:

  • OrderId

Output Fields

The following fields are returned after calling this action:

  • Id
  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BrowserIp
  • BuyerAcceptsMarketing
  • LineItems
  • CancelReason
  • CancelledAt
  • CartToken
  • CheckoutToken
  • ClientDetailsAcceptLanguage
  • ClientDetailsBrowserHeight
  • ClientDetailsBrowserIp
  • ClientDetailsBrowserWidth
  • ClientDetailsSessionHash
  • ClientDetailsUserAgent
  • ClosedAt
  • CompanyId
  • CompanyLocationId
  • CreatedAt
  • Currency
  • CurrentTotalDiscounts
  • CurrentTotalDiscountsShopMoneyAmount
  • CurrentTotalDiscountsShopMoneyCurrencyCode
  • CurrentTotalDiscountsPresentmentMoneyAmount
  • CurrentTotalDiscountsPresentmentMoneyCurrencyCode
  • CurrentTotalDutiesShopMoneyAmount
  • CurrentTotalDutiesShopMoneyCurrencyCode
  • CurrentTotalDutiesPresentmentMoneyAmount
  • CurrentTotalDutiesPresentmentMoneyCurrencyCode
  • CurrentTotalPrice
  • CurrentTotalPriceShopMoneyAmount
  • CurrentTotalPriceShopMoneyCurrencyCode
  • CurrentTotalPricePresentmentMoneyAmount
  • CurrentTotalPricePresentmentMoneyCurrencyCode
  • CurrentSubtotalPrice
  • CurrentSubtotalPriceShopMoneyAmount
  • CurrentSubtotalPriceShopMoneyCurrencyCode
  • CurrentSubtotalPricePresentmentMoneyAmount
  • CurrentSubtotalPricePresentmentMoneyCurrencyCode
  • CurrentTotalTax
  • CurrentTotalTaxShopMoneyAmount
  • CurrentTotalTaxShopMoneyCurrencyCode
  • CurrentTotalTaxPresentmentMoneyAmount
  • CurrentTotalTaxPresentmentMoneyCurrencyCode
  • CustomerId
  • CustomerLocale
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • FulfillmentStatus
  • LandingSite
  • LocationId
  • MerchantOfRecordAppId
  • Name
  • Note
  • Number
  • OrderNumber
  • OriginalTotalDutiesShopMoneyAmount
  • OriginalTotalDutiesShopMoneyCurrencyCode
  • OriginalTotalDutiesPresentmentMoneyAmount
  • OriginalTotalDutiesPresentmentMoneyCurrencyCode
  • PaymentTermsAmount
  • PaymentTermsCurrency
  • PaymentTermsName
  • PaymentTermsType
  • PaymentTermsDueInDays
  • Phone
  • PresentmentCurrency
  • ProcessedAt
  • ProcessingMethod
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • SubtotalPrice
  • SubtotalPriceSetShopMoneyAmount
  • SubtotalPriceSetShopMoneyCurrencyCode
  • SubtotalPriceSetPresentmentMoneyAmount
  • SubtotalPriceSetPresentmentMoneyCurrencyCode
  • Tags
  • TaxesIncluded
  • Test
  • Token
  • TotalDiscounts
  • TotalDiscountsSetShopMoneyAmount
  • TotalDiscountsSetShopMoneyCurrencyCode
  • TotalDiscountsSetPresentmentMoneyAmount
  • TotalDiscountsSetPresentmentMoneyCurrencyCode
  • TotalLineItemsPrice
  • TotalLineItemsPriceSetShopMoneyAmount
  • TotalLineItemsPriceSetShopMoneyCurrencyCode
  • TotalLineItemsPriceSetPresentmentMoneyAmount
  • TotalLineItemsPriceSetPresentmentMoneyCurrencyCode
  • TotalOutstanding
  • TotalPrice
  • TotalPriceSetShopMoneyAmount
  • TotalPriceSetShopMoneyCurrencyCode
  • TotalPriceSetPresentmentMoneyAmount
  • TotalPriceSetPresentmentMoneyCurrencyCode
  • TotalShippingPriceSetShopMoneyAmount
  • TotalShippingPriceSetShopMoneyCurrencyCode
  • TotalShippingPriceSetPresentmentMoneyAmount
  • TotalShippingPriceSetPresentmentMoneyCurrencyCode
  • TotalTax
  • TotalTaxSetShopMoneyAmount
  • TotalTaxSetShopMoneyCurrencyCode
  • TotalTaxSetPresentmentMoneyAmount
  • TotalTaxSetPresentmentMoneyCurrencyCode
  • TotalTipReceived
  • TotalWeight
  • UpdatedAt
  • UserId
  • OrderStatusUrl

Visit documentation for more information.

Get Orders Count

Description

Retrieve a orders count.

Parameters

You can provide the following parameters to this action:

  • status
  • Financial Status
  • Fulfillment Status
  • Created Before
  • Created After
  • Updated Before
  • Updated After

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Count

Visit documentation for more information.

Get Payouts

Description

Retrieves a list of all payouts ordered by payout date, with the most recent being first. Requires following permissions shopify_payments_payouts, shopify_payments for API Token.

Parameters

You can provide the following parameters to this action:

  • Date (format: yyyy-MM-ddd)
  • Date maximum (format: yyyy-MM-ddd)
  • Date minimum(format: yyyy-MM-ddd)
  • Payouts before this Id
  • Payouts after this Id
  • Status
  • Page Size

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Status
  • Date
  • Currency
  • Amount

Visit documentation for more information.

Get Product

Description

Gets a specific product.

Parameters

You can provide the following parameters to this action:

  • Product Id
  • Only Fields to Show
  • Extra Api Features (** SLOW **)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Title
  • BodyHtml
  • Vendor
  • ProductType
  • CreatedAt
  • UrlHandle
  • UpdatedAt
  • PublishedAt
  • TemplateSuffix
  • Status
  • PublishedScope
  • Tags
  • AdminGraphqlApiId
  • Variants
  • Options
  • Images
  • Image
  • ImageId
  • ImageProductId
  • ImagePosition
  • ImageCreatedAt
  • ImageUpdatedAt
  • ImageAlt
  • ImageWidth
  • ImageHeight
  • ImageSrc
  • ImageVariantIds
  • ImageAdminGraphqlApiId
  • Metafields

Visit documentation for more information.

Get Product Variants

Description

Gets a list of products with their variants.

Parameters

You can provide the following parameters to this action:

  • Product Id(s) - Comma separated
  • Since Product Id
  • Only Fields to Show
  • Created Before
  • Created After
  • Updated Before
  • Updated After
  • Page Size
  • Extra Api Features (** SLOW **)

Input Fields

You can provide the following fields to this action:

  • ProductId

Output Fields

The following fields are returned after calling this action:

  • Id
  • ProductId
  • Title
  • Sku
  • Price
  • CompareAtPrice
  • Position
  • Option1
  • Option2
  • Option3
  • CreatedAt
  • UpdatedAt
  • Taxable
  • InventoryItemId
  • InventoryQuantity
  • OldInventoryQuantity
  • InventoryPolicy
  • InventoryManagement
  • FulfillmentService
  • Barcode
  • Grams
  • ImageId
  • Weight
  • WeightUnit
  • RequiresShipping
  • AdminGraphqlApiId
  • PresentmentPrices
  • ProductTitle
  • ProductBodyHtml
  • ProductVendor
  • ProductType
  • ProductCreatedAt
  • ProductHandle
  • ProductUpdatedAt
  • ProductPublishedAt
  • ProductTemplateSuffix
  • ProductStatus
  • ProductPublishedScope
  • ProductTags
  • ProductAdminGraphqlApiId
  • ProductImage
  • ProductImageId
  • ProductImageProductId
  • ProductImagePosition
  • ProductImageCreatedAt
  • ProductImageUpdatedAt
  • ProductImageAlt
  • ProductImageWidth
  • ProductImageHeight
  • ProductImageSrc
  • ProductImageAdminGraphqlApiId

Visit documentation for more information.

Get Products

Description

Gets a list of products.

Parameters

You can provide the following parameters to this action:

  • Product Id(s) - Comma separated
  • Since Product Id
  • Created Before
  • Created After
  • Updated Before
  • Updated After
  • Page Size
  • Only Fields to Show
  • Extra Api Features (** SLOW **)

Input Fields

You can provide the following fields to this action:

  • ProductId

Output Fields

The following fields are returned after calling this action:

  • Id
  • Title
  • BodyHtml
  • Vendor
  • ProductType
  • CreatedAt
  • UrlHandle
  • UpdatedAt
  • PublishedAt
  • TemplateSuffix
  • Status
  • PublishedScope
  • Tags
  • AdminGraphqlApiId
  • Variants
  • Options
  • Images
  • Image
  • ImageId
  • ImageProductId
  • ImagePosition
  • ImageCreatedAt
  • ImageUpdatedAt
  • ImageAlt
  • ImageWidth
  • ImageHeight
  • ImageSrc
  • ImageVariantIds
  • ImageAdminGraphqlApiId
  • Metafields

Visit documentation for more information.

Get Products Count

Description

Retrieve a products count.

Parameters

You can provide the following parameters to this action:

  • Published Status
  • Product Type (e.g. Cult Products)
  • Collection Id
  • Published After
  • Published Before
  • Created Before
  • Created After
  • Updated Before
  • Updated After

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Count

Visit documentation for more information.

Insert Inventory Levels

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • InventoryItemId
  • LocationId
  • Available

Output Fields

The following fields are returned after calling this action:

  • InventoryItemId
  • LocationId
  • UpdatedAt
  • Available

Visit documentation for more information.

Update a Customer

Description

Updates an existing customer.

Parameters

You can provide the following parameters to this action:

  • Customer Id

Input Fields

You can provide the following fields to this action:

  • Id
  • FirstName
  • LastName
  • Email
  • Phone
  • Password
  • PasswordConfirmation
  • SendWelcomeEmail
  • MultipassIdentifier
  • Note
  • Tags
  • TaxExempt
  • TaxExemptions
  • DefaultAddressFirstName
  • DefaultAddressLastName
  • DefaultAddressCompany
  • DefaultAddressLine1
  • DefaultAddressLine2
  • DefaultAddressCity
  • DefaultAddressProvince
  • DefaultAddressCountry
  • DefaultAddressZip
  • DefaultAddressPhone
  • DefaultAddressName
  • DefaultAddressProvinceCode
  • DefaultAddressCountryCode
  • DefaultAddressCountryName

Output Fields

The following fields are returned after calling this action:

  • Id
  • Email
  • AcceptsMarketing
  • CreatedAt
  • UpdatedAt
  • FirstName
  • LastName
  • OrdersCount
  • State
  • TotalSpent
  • LastOrderId
  • Note
  • VerifiedEmail
  • MultipassIdentifier
  • TaxExempt
  • TaxExemptions
  • Tags
  • LastOrderName
  • Currency
  • Phone
  • AcceptsMarketingUpdatedAt
  • MarketingOptInLevel
  • SMSMarketingConsent
  • AdminGraphQLApiId
  • DefaultAddressId
  • DefaultAddressCustomerId
  • DefaultAddressFirstName
  • DefaultAddressLastName
  • DefaultAddressCompany
  • DefaultAddressAddress1
  • DefaultAddressAddress2
  • DefaultAddressCity
  • DefaultAddressProvince
  • DefaultAddressCountry
  • DefaultAddressZip
  • DefaultAddressPhone
  • DefaultAddressName
  • DefaultAddressProvinceCode
  • DefaultAddressCountryCode
  • DefaultAddressCountryName
  • EmailMarketingConsentState
  • EmailMarketingConsentOptInLevel
  • EmailMarketingConsentUpdatedAt

Visit documentation for more information.

Update a Location

Description

Updates an existing location.

Parameters

You can provide the following parameters to this action:

  • Location Id

Input Fields

You can provide the following fields to this action:

  • Id
  • Name
  • Active
  • Address1
  • Address2
  • City
  • Province
  • Zip
  • Country
  • Phone
  • ProvinceCode
  • CountryCode
  • CountryName
  • LocalizedProvinceName
  • LocalizedCountryName

Output Fields

The following fields are returned after calling this action:

  • Id
  • Name
  • Active
  • Address1
  • Address2
  • City
  • Province
  • Zip
  • Country
  • Phone
  • ProvinceCode
  • CountryCode
  • CountryName
  • LocalizedProvinceName
  • LocalizedCountryName
  • Legacy
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Update a Product

Description

Updates an existing product.

Parameters

You can provide the following parameters to this action:

  • Product Id

Input Fields

You can provide the following fields to this action:

  • Title
  • BodyHtml
  • UrlHandle
  • ProductType
  • Status
  • Vendor
  • TemplateSuffix
  • PublishedScope
  • Tags
  • Variants
  • Options
  • Images
  • Metafields
  • SEOTitle
  • SEODescription
  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Title
  • BodyHtml
  • Vendor
  • ProductType
  • CreatedAt
  • UrlHandle
  • UpdatedAt
  • PublishedAt
  • TemplateSuffix
  • Status
  • PublishedScope
  • Tags
  • AdminGraphqlApiId
  • Variants
  • Options
  • Images
  • Image
  • ImageId
  • ImageProductId
  • ImagePosition
  • ImageCreatedAt
  • ImageUpdatedAt
  • ImageAlt
  • ImageWidth
  • ImageHeight
  • ImageSrc
  • ImageVariantIds
  • ImageAdminGraphqlApiId
  • Metafields

Visit documentation for more information.

Update a Product Variant

Description

Updates an existing product variant.

Parameters

You can provide the following parameters to this action:

  • Product Variant Id

Input Fields

You can provide the following fields to this action:

  • Id
  • ProductId
  • Title
  • Price
  • Sku
  • Position
  • InventoryPolicy
  • CompareAtPrice
  • FulfillmentService
  • InventoryManagement
  • Option1
  • Option2
  • Option3
  • Taxable
  • Barcode
  • Grams
  • ImageId
  • Weight
  • WeightUnit
  • InventoryItemId
  • InventoryQuantity
  • OldInventoryQuantity
  • RequiresShipping
  • AdminGraphqlApiId

Output Fields

The following fields are returned after calling this action:

  • Id
  • ProductId
  • Title
  • Sku
  • Price
  • CompareAtPrice
  • Position
  • Option1
  • Option2
  • Option3
  • CreatedAt
  • UpdatedAt
  • Taxable
  • InventoryItemId
  • InventoryQuantity
  • OldInventoryQuantity
  • InventoryPolicy
  • InventoryManagement
  • FulfillmentService
  • Barcode
  • Grams
  • ImageId
  • Weight
  • WeightUnit
  • RequiresShipping
  • AdminGraphqlApiId
  • PresentmentPrices

Visit documentation for more information.

Update an Order

Description

Updates an existing order.

Parameters

You can provide the following parameters to this action:

  • Order Id

Input Fields

You can provide the following fields to this action:

  • Id
  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BuyerAcceptsMarketing
  • LineItems
  • CustomerId
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • FulfillmentStatus
  • LocationId
  • MerchantOfRecordAppId
  • Name
  • Note
  • Phone
  • Currency
  • PresentmentCurrency
  • ProcessedAt
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • Tags
  • TaxesIncluded
  • TotalWeight
  • UserId
  • InventoryBehaviour
  • SendReceipt
  • SendFulfillmentReceipt

Output Fields

The following fields are returned after calling this action:

  • Id
  • BillingAddressLine1
  • BillingAddressLine2
  • BillingAddressCity
  • BillingAddressCompany
  • BillingAddressCountry
  • BillingAddressFirstName
  • BillingAddressLastName
  • BillingAddressPhone
  • BillingAddressProvince
  • BillingAddressZip
  • BillingAddressName
  • BillingAddressProvinceCode
  • BillingAddressCountryCode
  • BillingAddressLatitude
  • BillingAddressLongitude
  • BrowserIp
  • BuyerAcceptsMarketing
  • LineItems
  • CancelReason
  • CancelledAt
  • CartToken
  • CheckoutToken
  • ClientDetailsAcceptLanguage
  • ClientDetailsBrowserHeight
  • ClientDetailsBrowserIp
  • ClientDetailsBrowserWidth
  • ClientDetailsSessionHash
  • ClientDetailsUserAgent
  • ClosedAt
  • CompanyId
  • CompanyLocationId
  • CreatedAt
  • Currency
  • CurrentTotalDiscounts
  • CurrentTotalDiscountsShopMoneyAmount
  • CurrentTotalDiscountsShopMoneyCurrencyCode
  • CurrentTotalDiscountsPresentmentMoneyAmount
  • CurrentTotalDiscountsPresentmentMoneyCurrencyCode
  • CurrentTotalDutiesShopMoneyAmount
  • CurrentTotalDutiesShopMoneyCurrencyCode
  • CurrentTotalDutiesPresentmentMoneyAmount
  • CurrentTotalDutiesPresentmentMoneyCurrencyCode
  • CurrentTotalPrice
  • CurrentTotalPriceShopMoneyAmount
  • CurrentTotalPriceShopMoneyCurrencyCode
  • CurrentTotalPricePresentmentMoneyAmount
  • CurrentTotalPricePresentmentMoneyCurrencyCode
  • CurrentSubtotalPrice
  • CurrentSubtotalPriceShopMoneyAmount
  • CurrentSubtotalPriceShopMoneyCurrencyCode
  • CurrentSubtotalPricePresentmentMoneyAmount
  • CurrentSubtotalPricePresentmentMoneyCurrencyCode
  • CurrentTotalTax
  • CurrentTotalTaxShopMoneyAmount
  • CurrentTotalTaxShopMoneyCurrencyCode
  • CurrentTotalTaxPresentmentMoneyAmount
  • CurrentTotalTaxPresentmentMoneyCurrencyCode
  • CustomerId
  • CustomerLocale
  • Email
  • EstimatedTaxes
  • FinancialStatus
  • FulfillmentStatus
  • LandingSite
  • LocationId
  • MerchantOfRecordAppId
  • Name
  • Note
  • Number
  • OrderNumber
  • OriginalTotalDutiesShopMoneyAmount
  • OriginalTotalDutiesShopMoneyCurrencyCode
  • OriginalTotalDutiesPresentmentMoneyAmount
  • OriginalTotalDutiesPresentmentMoneyCurrencyCode
  • PaymentTermsAmount
  • PaymentTermsCurrency
  • PaymentTermsName
  • PaymentTermsType
  • PaymentTermsDueInDays
  • Phone
  • PresentmentCurrency
  • ProcessedAt
  • ProcessingMethod
  • ReferringSite
  • ShippingAddressLine1
  • ShippingAddressLine2
  • ShippingAddressCity
  • ShippingAddressCompany
  • ShippingAddressCountry
  • ShippingAddressFirstName
  • ShippingAddressLastName
  • ShippingAddressPhone
  • ShippingAddressProvince
  • ShippingAddressZip
  • ShippingAddressName
  • ShippingAddressProvinceCode
  • ShippingAddressCountryCode
  • ShippingAddressLatitude
  • ShippingAddressLongitude
  • SourceName
  • SourceIdentifier
  • SourceUrl
  • SubtotalPrice
  • SubtotalPriceSetShopMoneyAmount
  • SubtotalPriceSetShopMoneyCurrencyCode
  • SubtotalPriceSetPresentmentMoneyAmount
  • SubtotalPriceSetPresentmentMoneyCurrencyCode
  • Tags
  • TaxesIncluded
  • Test
  • Token
  • TotalDiscounts
  • TotalDiscountsSetShopMoneyAmount
  • TotalDiscountsSetShopMoneyCurrencyCode
  • TotalDiscountsSetPresentmentMoneyAmount
  • TotalDiscountsSetPresentmentMoneyCurrencyCode
  • TotalLineItemsPrice
  • TotalLineItemsPriceSetShopMoneyAmount
  • TotalLineItemsPriceSetShopMoneyCurrencyCode
  • TotalLineItemsPriceSetPresentmentMoneyAmount
  • TotalLineItemsPriceSetPresentmentMoneyCurrencyCode
  • TotalOutstanding
  • TotalPrice
  • TotalPriceSetShopMoneyAmount
  • TotalPriceSetShopMoneyCurrencyCode
  • TotalPriceSetPresentmentMoneyAmount
  • TotalPriceSetPresentmentMoneyCurrencyCode
  • TotalShippingPriceSetShopMoneyAmount
  • TotalShippingPriceSetShopMoneyCurrencyCode
  • TotalShippingPriceSetPresentmentMoneyAmount
  • TotalShippingPriceSetPresentmentMoneyCurrencyCode
  • TotalTax
  • TotalTaxSetShopMoneyAmount
  • TotalTaxSetShopMoneyCurrencyCode
  • TotalTaxSetPresentmentMoneyAmount
  • TotalTaxSetPresentmentMoneyCurrencyCode
  • TotalTipReceived
  • TotalWeight
  • UpdatedAt
  • UserId
  • OrderStatusUrl

Visit documentation for more information.

Update Inventory Item

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Inventory Item Id

Input Fields

You can provide the following fields to this action:

  • Sku
  • Cost
  • Tracked
  • RequiresShipping
  • CountryCodeOfOrigin
  • ProvinceCodeOfOrigin
  • CountryHarmonizedSystemCodes
  • HarmonizedSystemCode
  • Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Sku
  • Cost
  • Tracked
  • RequiresShipping
  • CountryCodeOfOrigin
  • ProvinceCodeOfOrigin
  • CountryHarmonizedSystemCodes
  • HarmonizedSystemCode
  • CreatedAt
  • UpdatedAt

Visit documentation for more information.

Update Inventory Levels

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Action

Input Fields

You can provide the following fields to this action:

  • InventoryItemId
  • LocationId
  • AvailableAdjustment
  • Available

Output Fields

The following fields are returned after calling this action:

  • InventoryItemId
  • LocationId
  • UpdatedAt
  • Available

Visit documentation for more information.

Make Generic API Request

Description

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • Url
  • Body
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request (Bulk Write)

Description

This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • Url
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Conclusion

In this article we showed you how to connect to Shopify in SSIS and integrate data without any coding, saving you time and effort.

We encourage you to download Shopify Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Shopify Connector for SSIS Documentation

More integrations

Other connectors for SSIS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Shopify

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications