Shopify Connector

Shopify Connector

The high-performance Shopify Connector provides read/write capabilities within your application, allowing you to perform numerous Shopify operations with minimal coding or even no-coding at all. Integrate Shopify data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector.

Download for SSIS Download for SQL Server and ODBC Documentation

Integrate Shopify with these applications

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

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.

Download for SSIS Download for SQL Server and ODBC