Shopify connection for LinkyFlow

Shopify connection for LinkyFlow

LinkyFlow brings Shopify ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

22

Read requests

20

Write actions

17

Documented fields

73660

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

B2B

Company

Companies data in Shopify.

Read

List Companies

Fetch companies from Shopify.

Route: GET /companies

Excel formula: =LF.shopify.companies("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list by the given key. Values: CREATED_AT, ID, NAME, ORDER_COUNT, SINCE_DATE
query.active_customers_countnumberNo-
query.created_atdateNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.external_ididNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.metafields.{namespace}.{key}stringNoFilters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about [querying by metafield value](https:/...
query.namestringNo-
query.ordering_statusstringNo-
query.since_datedateNo-
query.updated_atdateNo-
Data returned in Excel
Field
Type
Relations
Description
contactCount
default

number

-

id
default

id

-

name
default

string

-

note
default

string

-

createdAt
default

date

-

id
default

id

-

isMainContact
default

boolean

-

lifetimeDuration
default

string

-

locale
default

string

-

title
default

string

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

createdAt
default

date

-

customerSince
default

date

-

id
default

id

-

name
default

string

-

note
default

string

-

acceptAutomaticDiscounts
default

boolean

-

allowDiscountCodesInCheckout
default

boolean

-

allVariantPricesOverridden
default

boolean

-

anyVariantPricesOverridden
default

boolean

-

billingAddressMatchesShippingAddress
default

boolean

-

completedAt
default

date

-

createdAt
default

date

-

currencyCode
default

enum

-

discountCodes
default

string[]

-

email
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

draftOrders

-

invoiceEmailTemplateSubject
default

string

-

invoiceSentAt
default

date

-

invoiceUrl
default

string

-

marketName
default

string

-

marketRegionCountryCode
default

enum

-

name
default

string

-

note2
default

string

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

ready
default

boolean

-

reserveInventoryUntil
default

date

-

status
default

enum

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

totalPrice
default

string

-

totalQuantityOfLineItems
default

number

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

transformerFingerprint
default

string

-

updatedAt
default

date

-

visibleToCustomer
default

boolean

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

externalId
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

companies

-

lifetimeDuration
default

string

-

createdAt
default

date

-

currency
default

enum

-

externalId
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

companyLocations

-

locale
default

string

-

name
default

string

-

note
default

string

-

orderCount
default

number

-

phone
default

string

-

taxExemptions
default

string

-

taxRegistrationId
default

string

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

createdAt
default

date

-

id
default

id

-

isMainContact
default

boolean

-

lifetimeDuration
default

string

-

locale
default

string

-

title
default

string

-

updatedAt
default

date

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

name
default

string

-

note
default

string

-

billingAddressMatchesShippingAddress
default

boolean

-

cancelledAt
default

date

-

cancelReason
default

enum

-

canMarkAsPaid
default

boolean

-

canNotifyCustomer
default

boolean

-

capturable
default

boolean

-

cartDiscountAmount
default

string

-

clientIp
default

string

-

closed
default

boolean

-

closedAt
default

date

-

confirmationNumber
default

string

-

confirmed
default

boolean

-

createdAt
default

date

-

currencyCode
default

enum

-

currentSubtotalLineItemsQuantity
default

number

-

currentTotalWeight
default

string

-

customerAcceptsMarketing
default

boolean

-

customerLocale
default

string

-

discountCode
default

string

-

discountCodes
default

string[]

-

displayFinancialStatus
default

enum

-

displayFulfillmentStatus
default

enum

-

dutiesIncluded
default

boolean

-

edited
default

boolean

-

email
default

string

-

estimatedTaxes
default

boolean

-

fulfillable
default

boolean

-

fullyPaid
default

boolean

-

hasTimelineComment
default

boolean

-

id
default

id

orders

-

landingPageDisplayText
default

string

-

landingPageUrl
default

string

-

merchantEditable
default

boolean

-

merchantEditableErrors
default

string[]

-

name
default

string

-

netPayment
default

string

-

note
default

string

-

number
default

number

-

paymentGatewayNames
default

string[]

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

processedAt
default

date

-

productNetwork
default

boolean

-

referralCode
default

string

-

referrerDisplayText
default

string

-

referrerUrl
default

string

-

refundable
default

boolean

-

registeredSourceUrl
default

string

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

returnStatus
default

enum

-

riskLevel
default

enum

-

sourceIdentifier
default

string

-

sourceName
default

string

-

subtotalLineItemsQuantity
default

number

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

test
default

boolean

-

totalCapturable
default

string

-

totalDiscounts
default

string

-

totalPrice
default

string

-

totalReceived
default

string

-

totalRefunded
default

string

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

unpaid
default

boolean

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

amount
default

number

-

currencyCode
default

enum

-

updatedAt
default

date

-

Company Location

Company Locations data in Shopify.

Read

List Company Locations

Fetch company locations from Shopify.

Route: GET /companyLocations

Excel formula: =LF.shopify.companyLocations("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list by the given key. Values: COMPANY_AND_LOCATION_NAME, COMPANY_ID, CREATED_AT, ID, NAME
query.company_ididNo-
query.created_atdateNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.external_idstringNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.idsstringNo-
query.metafields.{namespace}.{key}stringNoFilters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about [querying by metafield value](https:/...
query.namestringNo-
query.updated_atdateNo-
Data returned in Excel
Field
Type
Relations
Description
address1
default

string

-

address2
default

string

-

city
default

string

-

companyName
default

string

-

country
default

string

-

countryCode
default

enum

-

createdAt
default

date

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

phone
default

string

-

province
default

string

-

recipient
default

string

-

updatedAt
default

date

-

zip
default

string

-

zoneCode
default

string

-

checkoutToDraft
default

boolean

-

editableShippingAddress
default

boolean

-

payNowOnly
default

boolean

-

id
default

id

catalogs

-

status
default

enum

-

title
default

string

-

count
default

number

-

precision
default

enum

-

contactCount
default

number

-

createdAt
default

date

-

customerSince
default

date

-

externalId
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

companies

-

lifetimeDuration
default

string

-

name
default

string

-

note
default

string

-

updatedAt
default

date

-

createdAt
default

date

-

currency
default

enum

-

acceptAutomaticDiscounts
default

boolean

-

allowDiscountCodesInCheckout
default

boolean

-

allVariantPricesOverridden
default

boolean

-

anyVariantPricesOverridden
default

boolean

-

billingAddressMatchesShippingAddress
default

boolean

-

completedAt
default

date

-

createdAt
default

date

-

currencyCode
default

enum

-

discountCodes
default

string[]

-

email
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

draftOrders

-

invoiceEmailTemplateSubject
default

string

-

invoiceSentAt
default

date

-

invoiceUrl
default

string

-

marketName
default

string

-

marketRegionCountryCode
default

enum

-

name
default

string

-

note2
default

string

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

ready
default

boolean

-

reserveInventoryUntil
default

date

-

status
default

enum

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

totalPrice
default

string

-

totalQuantityOfLineItems
default

number

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

transformerFingerprint
default

string

-

updatedAt
default

date

-

visibleToCustomer
default

boolean

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

externalId
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

companyLocations

-

locale
default

string

-

enabled
default

boolean

-

handle
default

string

-

id
default

id

markets

-

name
default

string

-

primary
default

boolean

-

status
default

enum

-

type
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

name
default

string

-

note
default

string

-

orderCount
default

number

-

billingAddressMatchesShippingAddress
default

boolean

-

cancelledAt
default

date

-

cancelReason
default

enum

-

canMarkAsPaid
default

boolean

-

canNotifyCustomer
default

boolean

-

capturable
default

boolean

-

cartDiscountAmount
default

string

-

clientIp
default

string

-

closed
default

boolean

-

closedAt
default

date

-

confirmationNumber
default

string

-

confirmed
default

boolean

-

createdAt
default

date

-

currencyCode
default

enum

-

currentSubtotalLineItemsQuantity
default

number

-

currentTotalWeight
default

string

-

customerAcceptsMarketing
default

boolean

-

customerLocale
default

string

-

discountCode
default

string

-

discountCodes
default

string[]

-

displayFinancialStatus
default

enum

-

displayFulfillmentStatus
default

enum

-

dutiesIncluded
default

boolean

-

edited
default

boolean

-

email
default

string

-

estimatedTaxes
default

boolean

-

fulfillable
default

boolean

-

fullyPaid
default

boolean

-

hasTimelineComment
default

boolean

-

id
default

id

orders

-

landingPageDisplayText
default

string

-

landingPageUrl
default

string

-

merchantEditable
default

boolean

-

merchantEditableErrors
default

string[]

-

name
default

string

-

netPayment
default

string

-

note
default

string

-

number
default

number

-

paymentGatewayNames
default

string[]

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

processedAt
default

date

-

productNetwork
default

boolean

-

referralCode
default

string

-

referrerDisplayText
default

string

-

referrerUrl
default

string

-

refundable
default

boolean

-

registeredSourceUrl
default

string

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

returnStatus
default

enum

-

riskLevel
default

enum

-

sourceIdentifier
default

string

-

sourceName
default

string

-

subtotalLineItemsQuantity
default

number

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

test
default

boolean

-

totalCapturable
default

string

-

totalDiscounts
default

string

-

totalPrice
default

string

-

totalReceived
default

string

-

totalRefunded
default

string

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

unpaid
default

boolean

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

phone
default

string

-

createdAt
default

date

-

id
default

id

-

updatedAt
default

date

-

address1
default

string

-

address2
default

string

-

city
default

string

-

companyName
default

string

-

country
default

string

-

countryCode
default

enum

-

createdAt
default

date

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

phone
default

string

-

province
default

string

-

recipient
default

string

-

updatedAt
default

date

-

zip
default

string

-

zoneCode
default

string

-

id
default

id

-

id
default

id

-

taxExemptions
default

string

-

taxRegistrationId
default

string

-

taxExempt
default

boolean

-

taxExemptions
default

string

-

taxRegistrationId
default

string

-

amount
default

number

-

currencyCode
default

enum

-

updatedAt
default

date

-

Catalog

Catalog

Catalogs data in Shopify.

Read

List Catalogs

Fetch catalogs from Shopify.

Route: GET /catalogs

Excel formula: =LF.shopify.catalogs("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
typeenumNoThe type of the catalogs to be returned. Values: NONE, APP, COMPANY_LOCATION, MARKET
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: ID, RELEVANCE, TITLE, TYPE
query.app_ididNo-
query.company_ididNo-
query.company_location_ididNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.managed_country_ididNo-
query.market_ididNo-
query.statusstringNo-
query.titlestringNo-
Data returned in Excel
Field
Type
Relations
Description
apiKey
default

string

-

appStoreAppUrl
default

string

-

appStoreDeveloperUrl
default

string

-

description
default

string

-

developerName
default

string

-

developerType
default

enum

-

developerUrl
default

string

-

embedded
default

boolean

-

features
default

string[]

-

handle
default

string

-

id
default

id

-

installUrl
default

string

-

isPostPurchaseAppInUse
default

boolean

-

launchUrl
default

string

-

previouslyInstalled
default

boolean

-

pricingDetails
default

string

-

pricingDetailsSummary
default

string

-

privacyPolicyUrl
default

string

-

publicCategory
default

enum

-

published
default

boolean

-

shopifyDeveloped
default

boolean

-

title
default

string

-

uninstallMessage
default

string

-

uninstallUrl
default

string

-

webhookApiVersion
default

string

-

id
default

id

catalogs

-

id
default

id

-

processedRowCount
default

number

-

status
default

enum

-

currency
default

enum

-

fixedPricesCount
default

number

-

id
default

id

-

name
default

string

-

autoPublish
default

boolean

-

id
default

id

-

name
default

string

-

supportsFuturePublishing
default

boolean

-

status
default

enum

-

title
default

string

-

Edit

Delete Catalog

Delete an existing catalog in Shopify.

Route: DELETE /catalogs/{id}

Inputs you can set
NameTypeRequiredDescription
deleteDependentResourcesbooleanNo-
idstringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Collection

Collections data in Shopify.

Read

List Collections

Fetch collections from Shopify.

Route: GET /collections

Excel formula: =LF.shopify.collections("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: ID, RELEVANCE, TITLE, UPDATED_AT
query.collection_typeenumNoValues: custom, smart
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.handlestringNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.product_ididNoFilter by collections containing a product by its ID.
query.product_publication_statusenumNoFilter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the [channel ... Values: * {channel_app_id}-approved, * {channel_app_id}-rejected, * {channel_app_id}-needs_action, * {channel_app_id}-awaiting_review, * {channel_app_id}-published
query.publishable_statusenumNo**Deprecated:** This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use [published_status](https://shopi... Values: * {channel_app_id}-unset, * {channel_app_id}-pending, * {channel_app_id}-approved, * {channel_app_id}-not_approved
query.published_atdateNoFilter by the date and time when the collection was published to the Online Store.
query.published_statusenumNoFilter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns a... Values: online_store_channel, published, visible, unpublished, * {channel_id_or_handle}-published
query.titlestringNo-
query.updated_atdateNo-
savedSearchIdstringNoThe ID of a saved search. The search’s query string is used as...
Data returned in Excel
Field
Type
Relations
Description
count
default

number

-

precision
default

enum

-

descriptionHtml
default

string

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

summary
default

string

-

handle
default

string

-

id
default

id

collections

-

altText
default

string

-

height
default

number

-

id
default

id

-

originalSrc
default

string

-

src
default

string

-

thumbhash
default

string

-

width
default

number

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

count
default

number

-

precision
default

enum

-

isPublished
default

boolean

-

publishDate
default

date

-

isPublished
default

boolean

-

publishDate
default

date

-

count
default

number

-

precision
default

enum

-

isPublished
default

boolean

-

publishDate
default

date

-

appliedDisjunctively
default

boolean

-

description
default

string

-

title
default

string

-

sortOrder
default

enum

-

storefrontId
default

string

-

templateSuffix
default

string

-

title
default

string

-

key
default

string

-

locale
default

string

-

outdated
default

boolean

-

updatedAt
default

date

-

value
default

string

-

handle
default

string

-

id
default

id

-

name
default

string

-

overviewPath
default

string

-

supportsFuturePublishing
default

boolean

-

autoPublish
default

boolean

-

id
default

id

publications

-

name
default

string

-

supportsFuturePublishing
default

boolean

-

updatedAt
default

date

-

Create

Create Collection

Create a new collection in Shopify.

Route: POST /collections

Inputs you can set
NameTypeRequiredDescription
input.descriptionHtmlstringNo-
input.handlestringNo-
input.idstringNo-
input.image.altTextstringNo-
input.image.idstringNo-
input.image.srcstringNo-
input.metafields.idstringNo-
input.metafields.keystringNo-
input.metafields.namespacestringNo-
input.metafields.typestringNo-
input.metafields.valuestringNo-
input.productsstring[]No-
input.redirectNewHandlebooleanNo-
input.ruleSet.appliedDisjunctivelybooleanYes-
input.ruleSet.rules.columnenumYesValues: TAG, TITLE, TYPE, PRODUCT_TAXONOMY_NODE_ID, PRODUCT_CATEGORY_ID
input.ruleSet.rules.conditionstringYes-
input.ruleSet.rules.conditionObjectIdstringNo-
input.ruleSet.rules.relationenumYesValues: CONTAINS, ENDS_WITH, EQUALS, GREATER_THAN, IS_NOT_SET
input.seo.descriptionstringNo-
input.seo.titlestringNo-
input.sortOrderenumNoValues: ALPHA_ASC, ALPHA_DESC, BEST_SELLING, CREATED, CREATED_DESC
input.templateSuffixstringNo-
input.titlestringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Collection

Update an existing collection in Shopify.

Route: PATCH /collections/{id}

Inputs you can set
NameTypeRequiredDescription
input.descriptionHtmlstringNo-
input.handlestringNo-
input.idstringNo-
input.image.altTextstringNo-
input.image.idstringNo-
input.image.srcstringNo-
input.metafields.idstringNo-
input.metafields.keystringNo-
input.metafields.namespacestringNo-
input.metafields.typestringNo-
input.metafields.valuestringNo-
input.productsstring[]No-
input.redirectNewHandlebooleanNo-
input.ruleSet.appliedDisjunctivelybooleanYes-
input.ruleSet.rules.columnenumYesValues: TAG, TITLE, TYPE, PRODUCT_TAXONOMY_NODE_ID, PRODUCT_CATEGORY_ID
input.ruleSet.rules.conditionstringYes-
input.ruleSet.rules.conditionObjectIdstringNo-
input.ruleSet.rules.relationenumYesValues: CONTAINS, ENDS_WITH, EQUALS, GREATER_THAN, IS_NOT_SET
input.seo.descriptionstringNo-
input.seo.titlestringNo-
input.sortOrderenumNoValues: ALPHA_ASC, ALPHA_DESC, BEST_SELLING, CREATED, CREATED_DESC
input.templateSuffixstringNo-
input.titlestringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Collection

Delete an existing collection in Shopify.

Route: DELETE /collections/{id}

Inputs you can set
NameTypeRequiredDescription
input.idstringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Price List

Price Lists data in Shopify.

Read

List Price Lists

Fetch price lists from Shopify.

Route: GET /priceLists

Excel formula: =LF.shopify.priceLists("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: ID, NAME
Data returned in Excel
Field
Type
Relations
Description
id
default

id

-

status
default

enum

-

title
default

string

-

currency
default

enum

-

fixedPricesCount
default

number

-

id
default

id

priceLists

-

name
default

string

-

originType
default

enum

-

increment
default

number

-

isDefault
default

boolean

-

maximum
default

number

-

minimum
default

number

-

originType
default

enum

-

Create

Create Price List

Create a new price list in Shopify.

Route: POST /priceLists

Inputs you can set
NameTypeRequiredDescription
input.catalogIdstringNo-
input.currencyenumYesValues: USD, EUR, GBP, CAD, AFN
input.namestringYes-
input.parent.adjustment.typeenumYesValues: PERCENTAGE_DECREASE, PERCENTAGE_INCREASE
input.parent.adjustment.valuenumberYes-
input.parent.settings.compareAtModeenumYesValues: ADJUSTED, NULLIFY
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Price List

Update an existing price list in Shopify.

Route: PATCH /priceLists/{id}

Inputs you can set
NameTypeRequiredDescription
idstringYes-
input.catalogIdstringNo-
input.currencyenumNoValues: USD, EUR, GBP, CAD, AFN
input.namestringNo-
input.parent.adjustment.typeenumYesValues: PERCENTAGE_DECREASE, PERCENTAGE_INCREASE
input.parent.adjustment.valuenumberYes-
input.parent.settings.compareAtModeenumYesValues: ADJUSTED, NULLIFY
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Price List

Delete an existing price list in Shopify.

Route: DELETE /priceLists/{id}

Inputs you can set
NameTypeRequiredDescription
idstringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product

Products in Shopify catalog.

Read

List Products

Fetch products from Shopify.

Route: GET /products

Excel formula: =LF.shopify.products("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: CREATED_AT, ID, INVENTORY_TOTAL, PRODUCT_TYPE, PUBLISHED_AT
query.barcodestringNoFilter by the product variant barcode field. Example:...
query.bundlesbooleanNoFilter by a product bundle. A product bundle is a set of two or more re...
query.category_idstringNoFilter by the product category ID (product.category.id). A...
query.collection_ididNoFilter by the collection id field. Example: - collection_id:1...
query.combined_listing_roleenumNoFilter by the role of the product in a combined listing. Example:... Values: parent, child, no_role
query.created_atdateNoFilter by the date and time when the product was created. Example: - created_at:>'2020-10-21T23:39:20Z' - created_at:<now - c...
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.delivery_profile_ididNoFilter by the delivery profile id field. Example: - deli...
query.error_feedbackstringNoFilter by products with publishing errors.
query.gift_cardbooleanNoFilter by the product isGiftCard field. Example: - gift_...
query.handlestringNoFilter by a comma-separated list of product [handles](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-ha...
query.has_only_compositesbooleanNoFilter by products that have only composite variants. Example: - has_only_composites:true
query.has_only_default_variantbooleanNoFilter by products that have only a default variant. A default variant is the only variant if no other variants are specified. Example: - h...
query.has_variant_with_componentsbooleanNoFilter by products that have variants with associated components. Example: - has_variant_with_components:true
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.inventory_totalnumberNoFilter by inventory count. Example: - inventory_total:0 - inventory_total:>150 - inventory_total:>=200
query.is_price_reducedbooleanNoFilter by products that have a reduced price. For more information, refer to the [CollectionRule](https://shopify.dev/api/admin-graphql/la...
query.metafields.{namespace}.{key}stringNoFilters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about [querying by metafield value](https:/...
query.out_of_stock_somewherebooleanNoFilter by products that are out of stock in at least one location. Example: - out_of_stock_somewhere:true
query.pricenumberNoFilter by the product variant price field. Example: - ...
query.product_configuration_ownerstringNoFilter by the app id field. Example: - product_configuration_owner:1...
query.product_publication_statusenumNoFilter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the [channel ... Values: * {channel_app_id}-approved, * {channel_app_id}-rejected, * {channel_app_id}-needs_action, * {channel_app_id}-awaiting_review, * {channel_app_id}-published
query.product_typestringNoFilter by a comma-separated list of product types. Example: - product_type...
query.publication_idsstringNoFilter by a comma-separated list of publication IDs that are associated with the product. Example: - publication_ids:184111530305,184111694...
query.publishable_statusenumNo**Deprecated:** This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use [published_status](https://shopi... Values: * {channel_app_id}-unset, * {channel_app_id}-pending, * {channel_app_id}-approved, * {channel_app_id}-not_approved
query.published_atdateNoFilter by the date and time when the product was published to the online store and other sales channels. Example: - published_at:>2020-10-2...
query.published_statusenumNoFilter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns a... Values: online_store_channel, published, visible, unpublished, * {channel_id_or_handle}-published
query.skustringNoFilter by the product variant sku field. [Learn more abou...
query.statusenumNoFilter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE stat... Default: active Values: active, archived, draft
query.tagstringNoFilter objects by the tag field. Example: - tag:my_tag
query.tag_notstringNoFilter by objects that don’t have the specified tag. Example: - tag_not:my_tag
query.titlestringNoFilter by the product title field. Example: - title:The Minim...
query.updated_atdateNoFilter by the date and time when the product was last updated. Example: - updated_at:>'2020-10-21T23:39:20Z' - updated_at:<now ...
query.variant_ididNoFilter by the product variant id field. Example: - varian...
query.variant_titlestringNoFilter by the product variant title field. Example: - ...
query.vendorstringNoFilter by the origin or source of the product. Learn more about [vendors and managing vendor information](https://help.shopify.com/manual/pr...
savedSearchIdstringNoThe ID of a saved search. The search’s query string is used as...
Data returned in Excel
Field
Type
Relations
Description
count
default

number

-

precision
default

enum

-

bodyHtml
default

string

-

quantity
default

number

-

name
default

string

-

ancestorIds
default

string[]

-

childrenIds
default

string[]

-

fullName
default

string

-

id
default

id

-

isArchived
default

boolean

-

isLeaf
default

boolean

-

isRoot
default

boolean

-

level
default

number

-

name
default

string

-

parentId
default

string

-

descriptionHtml
default

string

-

handle
default

string

-

id
default

id

collections

-

sortOrder
default

enum

-

storefrontId
default

string

-

templateSuffix
default

string

-

title
default

string

-

updatedAt
default

date

-

combinedListingRole
default

enum

-

fixedQuantityRulesCount
default

number

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

altText
default

string

-

height
default

number

-

id
default

id

-

originalSrc
default

string

-

src
default

string

-

thumbhash
default

string

-

width
default

number

-

alt
default

string

-

createdAt
default

date

-

embeddedUrl
default

string

-

embedUrl
default

string

-

fileStatus
default

enum

-

host
default

enum

-

id
default

id

-

mediaContentType
default

enum

-

originUrl
default

string

-

status
default

enum

-

updatedAt
default

date

-

summary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

altText
default

string

-

height
default

number

-

id
default

id

-

originalSrc
default

string

-

src
default

string

-

thumbhash
default

string

-

width
default

number

-

isGiftCard
default

boolean

-

alt
default

string

-

createdAt
default

date

-

embeddedUrl
default

string

-

embedUrl
default

string

-

fileStatus
default

enum

-

host
default

enum

-

id
default

id

-

mediaContentType
default

enum

-

originUrl
default

string

-

status
default

enum

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

id
default

id

productOptions

-

name
default

string

-

position
default

number

-

values
default

string[]

-

count
default

number

-

precision
default

enum

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

isPublished
default

boolean

-

publishDate
default

date

-

productType
default

string

-

isPublished
default

boolean

-

publishDate
default

date

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

isPublished
default

boolean

-

publishDate
default

date

-

isPublished
default

boolean

-

publishDate
default

date

-

count
default

number

-

precision
default

enum

-

isPublished
default

boolean

-

publishDate
default

date

-

restricted
default

boolean

-

restrictedReason
default

string

-

sellingPlanGroupCount
default

number

-

appId
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

sellingPlanGroups

-

merchantCode
default

string

-

name
default

string

-

options
default

string[]

-

position
default

number

-

summary
default

string

-

count
default

number

-

precision
default

enum

-

description
default

string

-

title
default

string

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

key
default

string

-

locale
default

string

-

outdated
default

boolean

-

updatedAt
default

date

-

value
default

string

-

handle
default

string

-

id
default

id

-

name
default

string

-

overviewPath
default

string

-

supportsFuturePublishing
default

boolean

-

autoPublish
default

boolean

-

id
default

id

publications

-

name
default

string

-

supportsFuturePublishing
default

boolean

-

updatedAt
default

date

-

availableForSale
default

boolean

-

barcode
default

string

-

compareAtPrice
default

string

-

createdAt
default

date

-

displayName
default

string

-

id
default

id

productVariants

-

inventoryPolicy
default

enum

-

inventoryQuantity
default

number

-

position
default

number

-

price
default

string

-

requiresComponents
default

boolean

-

sellableOnlineQuantity
default

number

-

sellingPlanGroupCount
default

number

-

showUnitPrice
default

boolean

-

sku
default

string

-

storefrontId
default

string

-

taxable
default

boolean

-

taxCode
default

string

-

title
default

string

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

vendor
default

string

-

Create

Create Product

Create a new product in Shopify.

Route: POST /products

Inputs you can set
NameTypeRequiredDescription
media.altstringNo-
media.mediaContentTypeenumYesValues: VIDEO, EXTERNAL_VIDEO, MODEL_3D, IMAGE
media.originalSourcestringYes-
product.categorystringNo-
product.claimOwnership.bundlesbooleanNo-
product.collectionsToJoinstring[]No-
product.combinedListingRoleenumNoValues: PARENT, CHILD
product.descriptionHtmlstringNo-
product.giftCardbooleanNo-
product.giftCardTemplateSuffixstringNo-
product.handlestringNo-
product.metafields.idstringNo-
product.metafields.keystringNo-
product.metafields.namespacestringNo-
product.metafields.typestringNo-
product.metafields.valuestringNo-
product.productOptions.linkedMetafield.keystringYes-
product.productOptions.linkedMetafield.namespacestringYes-
product.productOptions.linkedMetafield.valuesstring[]No-
product.productOptions.namestringNo-
product.productOptions.positionnumberNo-
product.productOptions.values.linkedMetafieldValuestringNo-
product.productOptions.values.namestringNo-
product.productTypestringNo-
product.requiresSellingPlanbooleanNo-
product.seo.descriptionstringNo-
product.seo.titlestringNo-
product.statusenumNoValues: ACTIVE, ARCHIVED, DRAFT, UNLISTED
product.tagsstring[]No-
product.templateSuffixstringNo-
product.titlestringNo-
product.vendorstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Update an existing product in Shopify.

Route: PATCH /products/{id}

Inputs you can set
NameTypeRequiredDescription
media.altstringNo-
media.mediaContentTypeenumYesValues: VIDEO, EXTERNAL_VIDEO, MODEL_3D, IMAGE
media.originalSourcestringYes-
product.categorystringNo-
product.collectionsToJoinstring[]No-
product.collectionsToLeavestring[]No-
product.deleteConflictingConstrainedMetafieldsbooleanNo-
product.descriptionHtmlstringNo-
product.giftCardTemplateSuffixstringNo-
product.handlestringNo-
product.idstringNo-
product.metafields.idstringNo-
product.metafields.keystringNo-
product.metafields.namespacestringNo-
product.metafields.typestringNo-
product.metafields.valuestringNo-
product.productTypestringNo-
product.redirectNewHandlebooleanNo-
product.requiresSellingPlanbooleanNo-
product.seo.descriptionstringNo-
product.seo.titlestringNo-
product.statusenumNoValues: ACTIVE, ARCHIVED, DRAFT, UNLISTED
product.tagsstring[]No-
product.templateSuffixstringNo-
product.titlestringNo-
product.vendorstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Product

Delete an existing product in Shopify.

Route: DELETE /products/{id}

Inputs you can set
NameTypeRequiredDescription
input.idstringYes-
synchronousbooleanNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Option

Product Options data in Shopify.

Create

Create Product Option

Create a new product option in Shopify.

Route: POST /productOptions

Inputs you can set
NameTypeRequiredDescription
options.linkedMetafield.keystringYes-
options.linkedMetafield.namespacestringYes-
options.linkedMetafield.valuesstring[]No-
options.namestringNo-
options.positionnumberNo-
options.values.linkedMetafieldValuestringNo-
options.values.namestringNo-
productIdstringYes-
variantStrategyenumNoValues: LEAVE_AS_IS, CREATE
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Set

Products managed through Shopify productSet mutation.

Create

Create Product Set

Create a new product set in Shopify.

Route: POST /productSets

Inputs you can set
NameTypeRequiredDescription
identifier.customId.keystringYes-
identifier.customId.namespacestringNo-
identifier.customId.valuestringYes-
identifier.handlestringNo-
identifier.idstringNo-
input.categorystringNo-
input.claimOwnership.bundlesbooleanNo-
input.collectionsstring[]No-
input.combinedListingRoleenumNoValues: PARENT, CHILD
input.descriptionHtmlstringNo-
input.files.altstringNo-
input.files.contentTypeenumNoValues: IMAGE, FILE, VIDEO, EXTERNAL_VIDEO, MODEL_3D
input.files.duplicateResolutionModeenumNoValues: APPEND_UUID, RAISE_ERROR, REPLACE
input.files.filenamestringNo-
input.files.idstringNo-
input.files.originalSourcestringNo-
input.giftCardbooleanNo-
input.giftCardTemplateSuffixstringNo-
input.handlestringNo-
input.metafields.idstringNo-
input.metafields.keystringNo-
input.metafields.namespacestringNo-
input.metafields.typestringNo-
input.metafields.valuestringNo-
input.productOptions.idstringNo-
input.productOptions.linkedMetafield.keystringYes-
input.productOptions.linkedMetafield.namespacestringYes-
input.productOptions.linkedMetafield.valuesstring[]No-
input.productOptions.namestringNo-
input.productOptions.positionnumberNo-
input.productOptions.values.idstringNo-
input.productOptions.values.namestringNo-
input.productTypestringNo-
input.redirectNewHandlebooleanNo-
input.requiresSellingPlanbooleanNo-
input.seo.descriptionstringNo-
input.seo.titlestringNo-
input.statusenumNoValues: ACTIVE, ARCHIVED, DRAFT, UNLISTED
input.tagsstring[]No-
input.templateSuffixstringNo-
input.titlestringNo-
input.variants.barcodestringNo-
input.variants.compareAtPricestringNo-
input.variants.file.altstringNo-
input.variants.file.contentTypeenumNoValues: IMAGE, FILE, VIDEO, EXTERNAL_VIDEO, MODEL_3D
input.variants.file.duplicateResolutionModeenumNoValues: APPEND_UUID, RAISE_ERROR, REPLACE
input.variants.file.filenamestringNo-
input.variants.file.idstringNo-
input.variants.file.originalSourcestringNo-
input.variants.idstringNo-
input.variants.inventoryItem.costnumberNo-
input.variants.inventoryItem.countryCodeOfOriginenumNoValues: AF, AX, AL, DZ, AD
input.variants.inventoryItem.countryHarmonizedSystemCodes.countryCodeenumNoValues: AF, AX, AL, DZ, AD
input.variants.inventoryItem.countryHarmonizedSystemCodes.harmonizedSystemCodestringYes-
input.variants.inventoryItem.harmonizedSystemCodestringNo-
input.variants.inventoryItem.measurement.shippingPackageIdstringNo-
input.variants.inventoryItem.measurement.weight.unitenumYesValues: KILOGRAMS, GRAMS, POUNDS, OUNCES
input.variants.inventoryItem.measurement.weight.valuenumberYes-
input.variants.inventoryItem.provinceCodeOfOriginstringNo-
input.variants.inventoryItem.requiresShippingbooleanNo-
input.variants.inventoryItem.skustringNo-
input.variants.inventoryItem.trackedbooleanNo-
input.variants.inventoryPolicyenumNoValues: DENY, CONTINUE
input.variants.inventoryQuantities.locationIdstringYes-
input.variants.inventoryQuantities.namestringYes-
input.variants.inventoryQuantities.quantitynumberYes-
input.variants.metafields.idstringNo-
input.variants.metafields.keystringNo-
input.variants.metafields.namespacestringNo-
input.variants.metafields.typestringNo-
input.variants.metafields.valuestringNo-
input.variants.optionValues.idstringNo-
input.variants.optionValues.linkedMetafieldValuestringNo-
input.variants.optionValues.namestringNo-
input.variants.optionValues.optionIdstringNo-
input.variants.optionValues.optionNamestringNo-
input.variants.positionnumberNo-
input.variants.pricestringNo-
input.variants.requiresComponentsbooleanNo-
input.variants.showUnitPricebooleanNo-
input.variants.skustringNo-
input.variants.taxablebooleanNo-
input.variants.taxCodestringNo-
input.variants.unitPriceMeasurement.quantityUnitenumNoValues: ML, CL, L, M3, FLOZ
input.variants.unitPriceMeasurement.quantityValuenumberNo-
input.variants.unitPriceMeasurement.referenceUnitenumNoValues: ML, CL, L, M3, FLOZ
input.variants.unitPriceMeasurement.referenceValuenumberNo-
input.vendorstringNo-
synchronousbooleanNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Variant

Product Variants data in Shopify.

Read

List Product Variants

Fetch product variants from Shopify.

Route: GET /productVariants

Excel formula: =LF.shopify.productVariants("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: FULL_TITLE, ID, INVENTORY_LEVELS_AVAILABLE, INVENTORY_MANAGEMENT, INVENTORY_POLICY
query.barcodestringNoFilter by the product variant barcode field. Example:...
query.collectionstringNoFilter by the ID of the collection that the product variant belo...
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.delivery_profile_ididNoFilter by the product variant [delivery profile ID](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-deliveryprofil...
query.exclude_compositebooleanNoFilter by product variants that aren't composites. Example: - exclude_composite:true
query.exclude_variants_with_componentsbooleanNoFilter by whether there are components that ar...
query.gift_cardbooleanNoFilter by the product isGiftCard field. Example: - gift_...
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.inventory_quantitynumberNoFilter by an aggregate of inventory across all locations where the product variant is stocked. Example: - inventory_quantity:10
query.location_ididNoFilter by the location ID for the product variant. Example: - loc...
query.managedbooleanNoFilter by whether there is fulfillment service tracking associated with the product variants. Example: - managed:true
query.managed_bystringNoFilter by the fulfillment service that tracks the number of items in stock for the product variant. Example: - managed_by:shopify
query.option1stringNoFilter by a custom property that a shop owner uses to define product variants. Example: - option1:small
query.option2stringNoFilter by a custom property that a shop owner uses to define product variants. Example: - option2:medium
query.option3stringNoFilter by a custom property that a shop owner uses to define product variants. Example: - option3:large
query.product_ididNoFilter by the product id field. Example: - product_id:8474977763...
query.product_idsstringNoFilter by a comma-separated list of product IDs. Example: - produc...
query.product_publication_statusenumNoFilter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the [channel ... Values: * {channel_app_id}-approved, * {channel_app_id}-rejected, * {channel_app_id}-needs_action, * {channel_app_id}-awaiting_review, * {channel_app_id}-published
query.product_statusstringNoFilter by a comma-separated list of product statuses. Example:...
query.product_typestringNoFilter by the product type that's associated with the product variants. Example: - product_type:snowboard
query.publishable_statusenumNo**Deprecated:** This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use [published_status](https://shopi... Values: * {channel_app_id}-unset, * {channel_app_id}-pending, * {channel_app_id}-approved, * {channel_app_id}-not_approved
query.published_statusenumNoFilter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns a... Values: online_store_channel, published, visible, unpublished, * {channel_id_or_handle}-published
query.requires_componentsbooleanNoFilter by whether the product variant can only be purchased with components. [Learn more](https://shopify.dev/apps/build/product-merchandisi...
query.skustringNoFilter by the product variant sku field. [Learn more abou...
query.tagstringNoFilter objects by the tag field. Example: - tag:my_tag
query.tag_notstringNoFilter by objects that don’t have the specified tag. Example: - tag_not:my_tag
query.taxablebooleanNoFilter by the product variant taxable field. Example:...
query.titlestringNoFilter by the product variant title field. Example: - ...
query.updated_atdateNoFilter by date and time when the product variant was updated. Example: - updated_at:>2020-10-21T23:39:20Z - updated_at:<now -...
query.vendorstringNoFilter by the origin or source of the product variant. Learn more about [vendors and managing vendor information](https://help.shopify.com/m...
savedSearchIdstringNoThe ID of a saved search. The search’s query string is used as...
Data returned in Excel
Field
Type
Relations
Description
availableForSale
default

boolean

-

barcode
default

string

-

compareAtPrice
default

string

-

createdAt
default

date

-

activeMethodDefinitionsCount
default

number

-

default
default

boolean

-

id
default

id

-

legacyMode
default

boolean

-

locationsWithoutRatesCount
default

number

-

name
default

string

-

originLocationCount
default

number

-

version
default

number

-

zoneCountryCount
default

number

-

displayName
default

string

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

id
default

id

productVariants

-

altText
default

string

-

height
default

number

-

id
default

id

-

originalSrc
default

string

-

src
default

string

-

thumbhash
default

string

-

width
default

number

-

countryCodeOfOrigin
default

enum

-

createdAt
default

date

-

duplicateSkuCount
default

number

-

harmonizedSystemCode
default

string

-

id
default

id

inventoryItems

-

inventoryHistoryUrl
default

string

-

provinceCodeOfOrigin
default

string

-

requiresShipping
default

boolean

-

sku
default

string

-

tracked
default

boolean

-

updatedAt
default

date

-

inventoryPolicy
default

enum

-

inventoryQuantity
default

number

-

alt
default

string

-

createdAt
default

date

-

embeddedUrl
default

string

-

embedUrl
default

string

-

fileStatus
default

enum

-

host
default

enum

-

id
default

id

-

mediaContentType
default

enum

-

originUrl
default

string

-

status
default

enum

-

updatedAt
default

date

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

position
default

number

-

price
default

string

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

id
default

id

-

quantity
default

number

-

requiresComponents
default

boolean

-

name
default

string

-

value
default

string

-

sellableOnlineQuantity
default

number

-

sellingPlanGroupCount
default

number

-

appId
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

sellingPlanGroups

-

merchantCode
default

string

-

name
default

string

-

options
default

string[]

-

position
default

number

-

summary
default

string

-

count
default

number

-

precision
default

enum

-

showUnitPrice
default

boolean

-

sku
default

string

-

storefrontId
default

string

-

taxable
default

boolean

-

taxCode
default

string

-

title
default

string

-

key
default

string

-

locale
default

string

-

outdated
default

boolean

-

updatedAt
default

date

-

value
default

string

-

amount
default

number

-

currencyCode
default

enum

-

measuredType
default

enum

-

quantityUnit
default

enum

-

quantityValue
default

number

-

referenceUnit
default

enum

-

referenceValue
default

number

-

updatedAt
default

date

-

Create

Create Product Variant

Create a new product variant in Shopify.

Route: POST /productVariants

Inputs you can set
NameTypeRequiredDescription
media.altstringNo-
media.mediaContentTypeenumYesValues: VIDEO, EXTERNAL_VIDEO, MODEL_3D, IMAGE
media.originalSourcestringYes-
productIdstringYes-
strategyenumNoValues: DEFAULT, REMOVE_STANDALONE_VARIANT, PRESERVE_STANDALONE_VARIANT
variants.barcodestringNo-
variants.compareAtPricestringNo-
variants.idstringNo-
variants.inventoryItem.costnumberNo-
variants.inventoryItem.countryCodeOfOriginenumNoValues: AF, AX, AL, DZ, AD
variants.inventoryItem.countryHarmonizedSystemCodes.countryCodeenumNoValues: AF, AX, AL, DZ, AD
variants.inventoryItem.countryHarmonizedSystemCodes.harmonizedSystemCodestringYes-
variants.inventoryItem.harmonizedSystemCodestringNo-
variants.inventoryItem.measurement.shippingPackageIdstringNo-
variants.inventoryItem.measurement.weight.unitenumYesValues: KILOGRAMS, GRAMS, POUNDS, OUNCES
variants.inventoryItem.measurement.weight.valuenumberYes-
variants.inventoryItem.provinceCodeOfOriginstringNo-
variants.inventoryItem.requiresShippingbooleanNo-
variants.inventoryItem.skustringNo-
variants.inventoryItem.trackedbooleanNo-
variants.inventoryPolicyenumNoValues: DENY, CONTINUE
variants.inventoryQuantities.availableQuantitynumberYes-
variants.inventoryQuantities.locationIdstringYes-
variants.mediaIdstringNo-
variants.mediaSrcstring[]No-
variants.metafields.idstringNo-
variants.metafields.keystringNo-
variants.metafields.namespacestringNo-
variants.metafields.typestringNo-
variants.metafields.valuestringNo-
variants.optionValues.idstringNo-
variants.optionValues.linkedMetafieldValuestringNo-
variants.optionValues.namestringNo-
variants.optionValues.optionIdstringNo-
variants.optionValues.optionNamestringNo-
variants.pricestringNo-
variants.quantityAdjustments.adjustmentnumberNo-
variants.quantityAdjustments.changeFromQuantitynumberNo-
variants.quantityAdjustments.locationIdstringYes-
variants.requiresComponentsbooleanNo-
variants.showUnitPricebooleanNo-
variants.taxablebooleanNo-
variants.taxCodestringNo-
variants.unitPriceMeasurement.quantityUnitenumNoValues: ML, CL, L, M3, FLOZ
variants.unitPriceMeasurement.quantityValuenumberNo-
variants.unitPriceMeasurement.referenceUnitenumNoValues: ML, CL, L, M3, FLOZ
variants.unitPriceMeasurement.referenceValuenumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Publication

Publications data in Shopify.

Read

List Publications

Fetch publications from Shopify.

Route: GET /publications

Excel formula: =LF.shopify.publications("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
catalogTypeenumNoFilter publications by catalog type. Values: NONE, APP, COMPANY_LOCATION, MARKET
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
Data returned in Excel
Field
Type
Relations
Description
apiKey
default

string

-

appStoreAppUrl
default

string

-

appStoreDeveloperUrl
default

string

-

description
default

string

-

developerName
default

string

-

developerType
default

enum

-

developerUrl
default

string

-

embedded
default

boolean

-

features
default

string[]

-

handle
default

string

-

id
default

id

-

installUrl
default

string

-

isPostPurchaseAppInUse
default

boolean

-

launchUrl
default

string

-

previouslyInstalled
default

boolean

-

pricingDetails
default

string

-

pricingDetailsSummary
default

string

-

privacyPolicyUrl
default

string

-

publicCategory
default

enum

-

published
default

boolean

-

shopifyDeveloped
default

boolean

-

title
default

string

-

uninstallMessage
default

string

-

uninstallUrl
default

string

-

webhookApiVersion
default

string

-

autoPublish
default

boolean

-

id
default

id

-

status
default

enum

-

title
default

string

-

isPublished
default

boolean

-

publishDate
default

date

-

descriptionHtml
default

string

-

handle
default

string

-

id
default

id

collections

-

sortOrder
default

enum

-

storefrontId
default

string

-

templateSuffix
default

string

-

title
default

string

-

updatedAt
default

date

-

id
default

id

publications

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

count
default

number

-

precision
default

enum

-

name
default

string

-

id
default

id

-

processedRowCount
default

number

-

status
default

enum

-

isPublished
default

boolean

-

publishDate
default

date

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

supportsFuturePublishing
default

boolean

-

Selling Plan Group

Selling Plan Groups data in Shopify.

Read

List Selling Plan Groups

Fetch selling plan groups from Shopify.

Route: GET /sellingPlanGroups

Excel formula: =LF.shopify.sellingPlanGroups("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: CREATED_AT, ID, NAME, UPDATED_AT
query.app_idenumNoDefault: CURRENT Values: CURRENT, ALL, * (numeric app ID)
query.categoryenumNoA comma-separated list of categories. Values: SUBSCRIPTION, PRE_ORDER, TRY_BEFORE_YOU_BUY, OTHER
query.created_atdateNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.delivery_frequencystringNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.namestringNo-
query.percentage_offnumberNo-
Data returned in Excel
Field
Type
Relations
Description
appId
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

sellingPlanGroups

-

merchantCode
default

string

-

name
default

string

-

options
default

string[]

-

position
default

number

-

bodyHtml
default

string

-

combinedListingRole
default

enum

-

createdAt
default

date

-

customProductType
default

string

-

descriptionHtml
default

string

-

descriptionPlainSummary
default

string

-

giftCardTemplateSuffix
default

string

-

handle
default

string

-

hasOnlyDefaultVariant
default

boolean

-

hasOutOfStockVariants
default

boolean

-

hasVariantsThatRequiresComponents
default

boolean

-

id
default

id

products

-

isGiftCard
default

boolean

-

onlineStorePreviewUrl
default

string

-

onlineStoreUrl
default

string

-

productType
default

string

-

publishedAt
default

date

-

requiresSellingPlan
default

boolean

-

sellingPlanGroupCount
default

number

-

status
default

enum

-

storefrontId
default

string

-

tags
default

string[]

-

templateSuffix
default

string

-

title
default

string

-

totalInventory
default

number

-

totalVariants
default

number

-

tracksInventory
default

boolean

-

updatedAt
default

date

-

vendor
default

string

-

count
default

number

-

precision
default

enum

-

availableForSale
default

boolean

-

barcode
default

string

-

compareAtPrice
default

string

-

createdAt
default

date

-

displayName
default

string

-

id
default

id

productVariants

-

inventoryPolicy
default

enum

-

inventoryQuantity
default

number

-

position
default

number

-

price
default

string

-

requiresComponents
default

boolean

-

sellableOnlineQuantity
default

number

-

sellingPlanGroupCount
default

number

-

showUnitPrice
default

boolean

-

sku
default

string

-

storefrontId
default

string

-

taxable
default

boolean

-

taxCode
default

string

-

title
default

string

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

category
default

enum

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

name
default

string

-

options
default

string[]

-

position
default

number

-

summary
default

string

-

key
default

string

-

locale
default

string

-

outdated
default

boolean

-

updatedAt
default

date

-

value
default

string

-

Customers

Segment

Segments data in Shopify.

Read

List Segments

Fetch segments from Shopify.

Route: GET /segments

Excel formula: =LF.shopify.segments("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list by the given key. Values: CREATION_DATE, ID, LAST_EDIT_DATE, RELEVANCE
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.namestringNo-
Data returned in Excel
Field
Type
Relations
Description
creationDate
default

date

-

id
default

id

segments

-

lastEditDate
default

date

-

name
default

string

-

query
default

string

-

Inventory

Inventory Item

Inventory Items data in Shopify.

Read

List Inventory Items

Fetch inventory items from Shopify.

Route: GET /inventoryItems

Excel formula: =LF.shopify.inventoryItems("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
query.created_atdateNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.skustringNoFilter by the inventory item sku field. [Learn more a...
query.updated_atdateNo-
Data returned in Excel
Field
Type
Relations
Description
countryCodeOfOrigin
default

enum

-

countryCode
default

enum

-

harmonizedSystemCode
default

string

-

createdAt
default

date

-

duplicateSkuCount
default

number

-

harmonizedSystemCode
default

string

-

id
default

id

inventoryItems

-

inventoryHistoryUrl
default

string

-

canDeactivate
default

boolean

-

createdAt
default

date

-

deactivationAlert
default

string

-

id
default

id

-

updatedAt
default

date

-

canDeactivate
default

boolean

-

createdAt
default

date

-

deactivationAlert
default

string

-

id
default

id

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

id
default

id

-

provinceCodeOfOrigin
default

string

-

requiresShipping
default

boolean

-

sku
default

string

-

tracked
default

boolean

-

locked
default

boolean

-

reason
default

string

-

amount
default

number

-

currencyCode
default

enum

-

updatedAt
default

date

-

availableForSale
default

boolean

-

barcode
default

string

-

compareAtPrice
default

string

-

createdAt
default

date

-

displayName
default

string

-

id
default

id

productVariants

-

inventoryPolicy
default

enum

-

inventoryQuantity
default

number

-

position
default

number

-

price
default

string

-

requiresComponents
default

boolean

-

sellableOnlineQuantity
default

number

-

sellingPlanGroupCount
default

number

-

showUnitPrice
default

boolean

-

sku
default

string

-

storefrontId
default

string

-

taxable
default

boolean

-

taxCode
default

string

-

title
default

string

-

updatedAt
default

date

-

availableForSale
default

boolean

-

barcode
default

string

-

compareAtPrice
default

string

-

createdAt
default

date

-

displayName
default

string

-

id
default

id

-

inventoryPolicy
default

enum

-

inventoryQuantity
default

number

-

position
default

number

-

price
default

string

-

requiresComponents
default

boolean

-

sellableOnlineQuantity
default

number

-

sellingPlanGroupCount
default

number

-

showUnitPrice
default

boolean

-

sku
default

string

-

storefrontId
default

string

-

taxable
default

boolean

-

taxCode
default

string

-

title
default

string

-

updatedAt
default

date

-

Location

Locations data in Shopify.

Read

List Locations

Fetch locations from Shopify.

Route: GET /locations

Excel formula: =LF.shopify.locations("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: ID, NAME, RELEVANCE
query.activestringNo-
query.address1stringNo-
query.address2stringNo-
query.citystringNo-
query.countrystringNo-
query.created_atdateNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.geolocatedbooleanNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.legacybooleanNo-
query.location_ididNo-
query.namestringNo-
query.pickup_in_storeenumNoValues: enabled, disabled
query.provincestringNo-
query.zipstringNo-
includeLegacybooleanNoWhether to include the legacy locations of fulfillment services. Default: false
includeInactivebooleanNoWhether to include the locations that are deactivated. Default: false
Data returned in Excel
Field
Type
Relations
Description
activatable
default

boolean

-

address1
default

string

-

address2
default

string

-

city
default

string

-

country
default

string

-

countryCode
default

string

-

formatted
default

string[]

-

latitude
default

number

-

longitude
default

number

-

phone
default

string

-

province
default

string

-

provinceCode
default

string

-

zip
default

string

-

addressVerified
default

boolean

-

createdAt
default

date

-

deactivatable
default

boolean

-

deactivatedAt
default

string

-

deletable
default

boolean

-

callbackUrl
default

string

-

fulfillmentOrdersOptIn
default

boolean

-

handle
default

string

-

id
default

id

-

inventoryManagement
default

boolean

-

permitsSkuSharing
default

boolean

-

requiresShippingMethod
default

boolean

-

serviceName
default

string

-

trackingSupport
default

boolean

-

type
default

enum

-

fulfillsOnlineOrders
default

boolean

-

hasActiveInventory
default

boolean

-

hasUnfulfilledOrders
default

boolean

-

id
default

id

locations

-

canDeactivate
default

boolean

-

createdAt
default

date

-

deactivationAlert
default

string

-

id
default

id

-

updatedAt
default

date

-

canDeactivate
default

boolean

-

createdAt
default

date

-

deactivationAlert
default

string

-

id
default

id

-

updatedAt
default

date

-

isActive
default

boolean

-

isFulfillmentService
default

boolean

-

isPrimary
default

boolean

-

instructions
default

string

-

pickupTime
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

name
default

string

-

shipsInventory
default

boolean

-

address1
default

string

-

address2
default

string

-

city
default

string

-

country
default

string

-

countryCode
default

enum

-

formatted
default

string[]

-

province
default

string

-

provinceCode
default

string

-

zip
default

string

-

updatedAt
default

date

-

Logistics

Delivery Customization

Delivery Customizations data in Shopify.

Read

List Delivery Customizations

Fetch delivery customizations from Shopify.

Route: GET /deliveryCustomizations

Excel formula: =LF.shopify.deliveryCustomizations("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
query.enabledbooleanNo-
query.function_idstringNo-
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
Data returned in Excel
Field
Type
Relations
Description
enabled
default

boolean

-

errorsFirstOccurredAt
default

date

-

firstOccurredAt
default

date

-

hasBeenSharedSinceLastError
default

boolean

-

hasSharedRecentErrors
default

boolean

-

functionId
default

string

-

id
default

id

deliveryCustomizations

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

apiType
default

string

-

apiVersion
default

string

-

appKey
default

string

-

description
default

string

-

handle
default

string

-

id
default

id

-

inputQuery
default

string

-

title
default

string

-

useCreationUi
default

boolean

-

title
default

string

-

Delivery Profile

Delivery Profiles data in Shopify.

Read

List Delivery Profiles

Fetch delivery profiles from Shopify.

Route: GET /deliveryProfiles

Excel formula: =LF.shopify.deliveryProfiles("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
merchantOwnedOnlybooleanNoIf true, returns only delivery profiles that were created by the merchant.
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
Data returned in Excel
Field
Type
Relations
Description
activeMethodDefinitionsCount
default

number

-

default
default

boolean

-

id
default

id

deliveryProfiles

-

legacyMode
default

boolean

-

locationsWithoutRatesCount
default

number

-

name
default

string

-

originLocationCount
default

number

-

count
default

number

-

precision
default

enum

-

capped
default

boolean

-

count
default

number

-

id
default

id

-

appId
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

sellingPlanGroups

-

merchantCode
default

string

-

name
default

string

-

options
default

string[]

-

position
default

number

-

summary
default

string

-

activatable
default

boolean

-

addressVerified
default

boolean

-

createdAt
default

date

-

deactivatable
default

boolean

-

deactivatedAt
default

string

-

deletable
default

boolean

-

fulfillsOnlineOrders
default

boolean

-

hasActiveInventory
default

boolean

-

hasUnfulfilledOrders
default

boolean

-

id
default

id

locations

-

isActive
default

boolean

-

isFulfillmentService
default

boolean

-

isPrimary
default

boolean

-

name
default

string

-

shipsInventory
default

boolean

-

updatedAt
default

date

-

activatable
default

boolean

-

addressVerified
default

boolean

-

createdAt
default

date

-

deactivatable
default

boolean

-

deactivatedAt
default

string

-

deletable
default

boolean

-

fulfillsOnlineOrders
default

boolean

-

hasActiveInventory
default

boolean

-

hasUnfulfilledOrders
default

boolean

-

id
default

id

locations

-

isActive
default

boolean

-

isFulfillmentService
default

boolean

-

isPrimary
default

boolean

-

name
default

string

-

shipsInventory
default

boolean

-

updatedAt
default

date

-

version
default

number

-

zoneCountryCount
default

number

-

Marketing

Marketing Activity

Marketing Activities data in Shopify.

Read

List Marketing Activities

Fetch marketing activities from Shopify.

Route: GET /marketingActivities

Excel formula: =LF.shopify.marketingActivities("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
marketingActivityIdsstring[]NoThe list of marketing activity IDs to filter by.
remoteIdsstring[]NoThe list of remote IDs associated with marketing activities to filter by.
utmstringNoThe UTM parameters associated with marketing activities to filter by.
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: CREATED_AT, ID, TITLE
query.app_ididNo-
query.app_namestringNoA comma-separated list of app names.
query.created_atdateNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.marketing_campaign_ididNo-
query.scheduled_to_end_atdateNo-
query.scheduled_to_start_atdateNo-
query.tacticstringNo-
query.titlestringNo-
query.updated_atdateNo-
savedSearchIdstringNoThe ID of a saved search. The search’s query string is used as...
Data returned in Excel
Field
Type
Relations
Description
activityListUrl
default

string

-

amount
default

number

-

currencyCode
default

enum

-

apiKey
default

string

-

appStoreAppUrl
default

string

-

appStoreDeveloperUrl
default

string

-

description
default

string

-

developerName
default

string

-

developerType
default

enum

-

developerUrl
default

string

-

embedded
default

boolean

-

features
default

string[]

-

handle
default

string

-

id
default

id

-

installUrl
default

string

-

isPostPurchaseAppInUse
default

boolean

-

launchUrl
default

string

-

previouslyInstalled
default

boolean

-

pricingDetails
default

string

-

pricingDetailsSummary
default

string

-

privacyPolicyUrl
default

string

-

publicCategory
default

enum

-

published
default

boolean

-

shopifyDeveloped
default

boolean

-

title
default

string

-

uninstallMessage
default

string

-

uninstallUrl
default

string

-

webhookApiVersion
default

string

-

code
default

enum

-

budgetType
default

enum

-

createdAt
default

date

-

formData
default

string

-

hierarchyLevel
default

enum

-

id
default

id

marketingActivities

-

inMainWorkflowVersion
default

boolean

-

isExternal
default

boolean

-

marketingChannel
default

enum

-

marketingChannelType
default

enum

-

channel
default

enum

-

channelHandle
default

string

-

description
default

string

-

endedAt
default

date

-

id
default

id

-

manageUrl
default

string

-

marketingChannelType
default

enum

-

previewUrl
default

string

-

remoteId
default

string

-

scheduledToEndAt
default

date

-

sourceAndMedium
default

string

-

startedAt
default

date

-

targetTypeDisplayText
default

string

-

type
default

enum

-

utmCampaign
default

string

-

utmMedium
default

string

-

utmSource
default

string

-

parentActivityId
default

id

-

parentRemoteId
default

string

-

sourceAndMedium
default

string

-

status
default

enum

-

statusBadgeType
default

enum

-

statusBadgeTypeV2
default

enum

-

statusLabel
default

string

-

statusTransitionedAt
default

date

-

tactic
default

enum

-

targetStatus
default

enum

-

title
default

string

-

updatedAt
default

date

-

urlParameterValue
default

string

-

campaign
default

string

-

content
default

string

-

medium
default

string

-

source
default

string

-

term
default

string

-

Markets

Market

Markets data in Shopify.

Read

List Markets

Fetch markets from Shopify.

Route: GET /markets

Excel formula: =LF.shopify.markets("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
typeenumNoFilters markets by type. Values: NONE, REGION, LOCATION, COMPANY_LOCATION
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: CREATED_AT, ID, MARKET_CONDITION_TYPES, MARKET_TYPE, NAME
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.market_condition_typesstringNoA comma-separated list of condition types.
query.market_typestringNo-
query.namestringNo-
query.statusenumNoValues: ACTIVE, DRAFT
query.wildcard_company_location_with_country_codestringNo-
Data returned in Excel
Field
Type
Relations
Description
id
default

id

-

status
default

enum

-

title
default

string

-

count
default

number

-

precision
default

enum

-

conditionTypes
default

string

-

localCurrencies
default

boolean

-

roundingEnabled
default

boolean

-

enabled
default

boolean

-

handle
default

string

-

id
default

id

markets

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

name
default

string

-

inclusiveDutiesPricingStrategy
default

enum

-

inclusiveTaxPricingStrategy
default

enum

-

currency
default

enum

-

fixedPricesCount
default

number

-

id
default

id

-

name
default

string

-

primary
default

boolean

-

code
default

enum

-

id
default

id

-

name
default

string

-

status
default

enum

-

type
default

enum

-

id
default

id

-

subfolderSuffix
default

string

-

id
default

id

-

subfolderSuffix
default

string

-

Sales

Draft Order

Draft Orders data in Shopify.

Read

List Draft Orders

Fetch draft orders from Shopify.

Route: GET /draftOrders

Excel formula: =LF.shopify.draftOrders("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: CUSTOMER_NAME, ID, NUMBER, RELEVANCE, STATUS
query.created_atdateNo-
query.customer_ididNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.sourcestringNo-
query.statusstringNo-
query.tagstringNo-
query.updated_atdateNo-
savedSearchIdstringNoThe ID of a saved search. The search’s query string is used as...
Data returned in Excel
Field
Type
Relations
Description
acceptAutomaticDiscounts
default

boolean

-

allowDiscountCodesInCheckout
default

boolean

-

allVariantPricesOverridden
default

boolean

-

anyVariantPricesOverridden
default

boolean

-

amount
default

string

-

description
default

string

-

title
default

string

-

value
default

number

-

valueType
default

enum

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

coordinatesValidated
default

boolean

-

country
default

string

-

countryCode
default

string

-

countryCodeV2
default

enum

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

latitude
default

number

-

longitude
default

number

-

name
default

string

-

phone
default

string

-

province
default

string

-

provinceCode
default

string

-

timeZone
default

string

-

validationResultSummary
default

enum

-

zip
default

string

-

billingAddressMatchesShippingAddress
default

boolean

-

completedAt
default

date

-

createdAt
default

date

-

currencyCode
default

enum

-

key
default

string

-

value
default

string

-

canDelete
default

boolean

-

createdAt
default

date

-

dataSaleOptOut
default

boolean

-

displayName
default

string

-

email
default

string

-

firstName
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

-

lastName
default

string

-

lifetimeDuration
default

string

-

locale
default

string

-

multipassIdentifier
default

string

-

note
default

string

-

numberOfOrders
default

string

-

phone
default

string

-

productSubscriberStatus
default

enum

-

state
default

enum

-

tags
default

string[]

-

taxExempt
default

boolean

-

taxExemptions
default

string

-

unsubscribeUrl
default

string

-

updatedAt
default

date

-

validEmailAddress
default

boolean

-

verifiedEmail
default

boolean

-

discountCodes
default

string[]

-

email
default

string

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

hasTimelineComment
default

boolean

-

id
default

id

draftOrders

-

invoiceEmailTemplateSubject
default

string

-

invoiceSentAt
default

date

-

invoiceUrl
default

string

-

custom
default

boolean

-

discountedTotal
default

string

-

discountedUnitPrice
default

string

-

grams
default

number

-

id
default

id

-

isGiftCard
default

boolean

-

name
default

string

-

originalTotal
default

string

-

originalUnitPrice
default

string

-

quantity
default

number

-

requiresShipping
default

boolean

-

sku
default

string

-

taxable
default

boolean

-

title
default

string

-

totalDiscount
default

string

-

uuid
default

string

-

variantTitle
default

string

-

vendor
default

string

-

countryCode
default

enum

-

key
default

enum

-

purpose
default

enum

-

title
default

string

-

value
default

string

-

countryCode
default

enum

-

key
default

enum

-

purpose
default

enum

-

title
default

string

-

value
default

string

-

marketName
default

string

-

marketRegionCountryCode
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

name
default

string

-

note2
default

string

-

billingAddressMatchesShippingAddress
default

boolean

-

cancelledAt
default

date

-

cancelReason
default

enum

-

canMarkAsPaid
default

boolean

-

canNotifyCustomer
default

boolean

-

capturable
default

boolean

-

cartDiscountAmount
default

string

-

clientIp
default

string

-

closed
default

boolean

-

closedAt
default

date

-

confirmationNumber
default

string

-

confirmed
default

boolean

-

createdAt
default

date

-

currencyCode
default

enum

-

currentSubtotalLineItemsQuantity
default

number

-

currentTotalWeight
default

string

-

customerAcceptsMarketing
default

boolean

-

customerLocale
default

string

-

discountCode
default

string

-

discountCodes
default

string[]

-

displayFinancialStatus
default

enum

-

displayFulfillmentStatus
default

enum

-

dutiesIncluded
default

boolean

-

edited
default

boolean

-

email
default

string

-

estimatedTaxes
default

boolean

-

fulfillable
default

boolean

-

fullyPaid
default

boolean

-

hasTimelineComment
default

boolean

-

id
default

id

-

landingPageDisplayText
default

string

-

landingPageUrl
default

string

-

merchantEditable
default

boolean

-

merchantEditableErrors
default

string[]

-

name
default

string

-

netPayment
default

string

-

note
default

string

-

number
default

number

-

paymentGatewayNames
default

string[]

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

processedAt
default

date

-

productNetwork
default

boolean

-

referralCode
default

string

-

referrerDisplayText
default

string

-

referrerUrl
default

string

-

refundable
default

boolean

-

registeredSourceUrl
default

string

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

returnStatus
default

enum

-

riskLevel
default

enum

-

sourceIdentifier
default

string

-

sourceName
default

string

-

subtotalLineItemsQuantity
default

number

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

test
default

boolean

-

totalCapturable
default

string

-

totalDiscounts
default

string

-

totalPrice
default

string

-

totalReceived
default

string

-

totalRefunded
default

string

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

unpaid
default

boolean

-

updatedAt
default

date

-

due
default

boolean

-

dueInDays
default

number

-

id
default

id

-

overdue
default

boolean

-

paymentTermsName
default

string

-

paymentTermsType
default

enum

-

translatedName
default

string

-

phone
default

string

-

automaticDiscount
default

boolean

-

bxgyDiscount
default

boolean

-

code
default

string

-

discountClass
default

enum

-

discountClasses
default

string

-

id
default

id

-

presentationLevel
default

string

-

shortSummary
default

string

-

summary
default

string

-

title
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

canDelete
default

boolean

-

createdAt
default

date

-

dataSaleOptOut
default

boolean

-

displayName
default

string

-

email
default

string

-

firstName
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

-

lastName
default

string

-

lifetimeDuration
default

string

-

locale
default

string

-

multipassIdentifier
default

string

-

note
default

string

-

numberOfOrders
default

string

-

phone
default

string

-

productSubscriberStatus
default

enum

-

state
default

enum

-

tags
default

string[]

-

taxExempt
default

boolean

-

taxExemptions
default

string

-

unsubscribeUrl
default

string

-

updatedAt
default

date

-

validEmailAddress
default

boolean

-

verifiedEmail
default

boolean

-

ready
default

boolean

-

reserveInventoryUntil
default

date

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

coordinatesValidated
default

boolean

-

country
default

string

-

countryCode
default

string

-

countryCodeV2
default

enum

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

latitude
default

number

-

longitude
default

number

-

name
default

string

-

phone
default

string

-

province
default

string

-

provinceCode
default

string

-

timeZone
default

string

-

validationResultSummary
default

enum

-

zip
default

string

-

carrierIdentifier
default

string

-

code
default

string

-

custom
default

boolean

-

deliveryCategory
default

string

-

id
default

id

-

isRemoved
default

boolean

-

phone
default

string

-

price
default

string

-

shippingRateHandle
default

string

-

source
default

string

-

title
default

string

-

status
default

enum

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

channelLiable
default

boolean

-

price
default

string

-

rate
default

number

-

ratePercentage
default

number

-

source
default

string

-

title
default

string

-

totalPrice
default

string

-

totalQuantityOfLineItems
default

number

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

transformerFingerprint
default

string

-

updatedAt
default

date

-

visibleToCustomer
default

boolean

-

errorCode
default

string

-

field
default

string

-

message
default

string

-

Edit

Update Draft Order

Update an existing draft order in Shopify.

Route: PATCH /draftOrders/{id}

Inputs you can set
NameTypeRequiredDescription
idstringYes-
input.acceptAutomaticDiscountsbooleanNo-
input.allowDiscountCodesInCheckoutbooleanNo-
input.appliedDiscount.amountWithCurrency.amountnumberYes-
input.appliedDiscount.amountWithCurrency.currencyCodeenumYesValues: USD, EUR, GBP, CAD, AFN
input.appliedDiscount.descriptionstringNo-
input.appliedDiscount.titlestringNo-
input.appliedDiscount.valuenumberYes-
input.appliedDiscount.valueTypeenumYesValues: FIXED_AMOUNT, PERCENTAGE
input.billingAddress.address1stringNo-
input.billingAddress.address2stringNo-
input.billingAddress.citystringNo-
input.billingAddress.companystringNo-
input.billingAddress.countryCodeenumNoValues: AF, AX, AL, DZ, AD
input.billingAddress.firstNamestringNo-
input.billingAddress.lastNamestringNo-
input.billingAddress.phonestringNo-
input.billingAddress.provinceCodestringNo-
input.billingAddress.zipstringNo-
input.customAttributes.keystringYes-
input.customAttributes.valuestringYes-
input.discountCodesstring[]No-
input.emailstringNo-
input.lineItems.appliedDiscount.amountWithCurrency.amountnumberYes-
input.lineItems.appliedDiscount.amountWithCurrency.currencyCodeenumYesValues: USD, EUR, GBP, CAD, AFN
input.lineItems.appliedDiscount.descriptionstringNo-
input.lineItems.appliedDiscount.titlestringNo-
input.lineItems.appliedDiscount.valuenumberYes-
input.lineItems.appliedDiscount.valueTypeenumYesValues: FIXED_AMOUNT, PERCENTAGE
input.lineItems.components.quantitynumberYes-
input.lineItems.components.uuidstringNo-
input.lineItems.components.variantIdstringNo-
input.lineItems.customAttributes.keystringYes-
input.lineItems.customAttributes.valuestringYes-
input.lineItems.generatePriceOverridebooleanNo-
input.lineItems.originalUnitPriceWithCurrency.amountnumberYes-
input.lineItems.originalUnitPriceWithCurrency.currencyCodeenumYesValues: USD, EUR, GBP, CAD, AFN
input.lineItems.priceOverride.amountnumberYes-
input.lineItems.priceOverride.currencyCodeenumYesValues: USD, EUR, GBP, CAD, AFN
input.lineItems.quantitynumberYes-
input.lineItems.requiresShippingbooleanNo-
input.lineItems.skustringNo-
input.lineItems.taxablebooleanNo-
input.lineItems.titlestringNo-
input.lineItems.uuidstringNo-
input.lineItems.variantIdstringNo-
input.lineItems.weight.unitenumYesValues: KILOGRAMS, GRAMS, POUNDS, OUNCES
input.lineItems.weight.valuenumberYes-
input.localizedFields.keyenumYesValues: TAX_CREDENTIAL_BR, SHIPPING_CREDENTIAL_BR, TAX_CREDENTIAL_CL, SHIPPING_CREDENTIAL_CL, SHIPPING_CREDENTIAL_CN
input.localizedFields.valuestringYes-
input.metafields.idstringNo-
input.metafields.keystringNo-
input.metafields.namespacestringNo-
input.metafields.typestringNo-
input.metafields.valuestringNo-
input.notestringNo-
input.paymentTerms.paymentSchedules.dueAtdateNo-
input.paymentTerms.paymentSchedules.issuedAtdateNo-
input.paymentTerms.paymentTermsTemplateIdstringNo-
input.phonestringNo-
input.poNumberstringNo-
input.presentmentCurrencyCodeenumNoValues: USD, EUR, GBP, CAD, AFN
input.purchasingEntity.customerIdstringNo-
input.purchasingEntity.purchasingCompany.companyContactIdstringYes-
input.purchasingEntity.purchasingCompany.companyIdstringYes-
input.purchasingEntity.purchasingCompany.companyLocationIdstringYes-
input.reserveInventoryUntildateNo-
input.sessionTokenstringNo-
input.shippingAddress.address1stringNo-
input.shippingAddress.address2stringNo-
input.shippingAddress.citystringNo-
input.shippingAddress.companystringNo-
input.shippingAddress.countryCodeenumNoValues: AF, AX, AL, DZ, AD
input.shippingAddress.firstNamestringNo-
input.shippingAddress.lastNamestringNo-
input.shippingAddress.phonestringNo-
input.shippingAddress.provinceCodestringNo-
input.shippingAddress.zipstringNo-
input.shippingLine.priceWithCurrency.amountnumberYes-
input.shippingLine.priceWithCurrency.currencyCodeenumYesValues: USD, EUR, GBP, CAD, AFN
input.shippingLine.shippingRateHandlestringNo-
input.shippingLine.titlestringNo-
input.sourceNamestringNo-
input.tagsstring[]No-
input.taxExemptbooleanNo-
input.transformerFingerprintstringNo-
input.useCustomerDefaultAddressbooleanNo-
input.visibleToCustomerbooleanNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Draft Order

Delete an existing draft order in Shopify.

Route: DELETE /draftOrders/{id}

Inputs you can set
NameTypeRequiredDescription
input.idstringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Fulfillment Order

Fulfillment Orders data in Shopify.

Read

List Fulfillment Orders

Fetch fulfillment orders from Shopify.

Route: GET /fulfillmentOrders

Excel formula: =LF.shopify.fulfillmentOrders("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
includeClosedbooleanNoWhether to include closed fulfillment orders. Default: false
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: ID, UPDATED_AT
query.assigned_location_ididNo-
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.statusstringNo-
query.updated_atdateNo-
Data returned in Excel
Field
Type
Relations
Description
address1
default

string

-

address2
default

string

-

city
default

string

-

countryCode
default

enum

-

name
default

string

-

phone
default

string

-

province
default

string

-

zip
default

string

-

channelId
default

id

-

createdAt
default

date

-

id
default

id

-

maxDeliveryDateTime
default

date

-

methodType
default

enum

-

minDeliveryDateTime
default

date

-

presentedName
default

string

-

serviceCode
default

string

-

sourceReference
default

string

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

countryCode
default

enum

-

email
default

string

-

firstName
default

string

-

id
default

id

-

lastName
default

string

-

phone
default

string

-

province
default

string

-

zip
default

string

-

fulfillAt
default

date

-

fulfillBy
default

date

-

displayReason
default

string

-

handle
default

string

-

heldByRequestingApp
default

boolean

-

id
default

id

-

reason
default

enum

-

reasonNotes
default

string

-

channelId
default

id

-

createdAt
default

date

-

fulfillAt
default

date

-

fulfillBy
default

date

-

id
default

id

fulfillmentOrders

-

orderId
default

id

orders

-

orderName
default

string

-

orderProcessedAt
default

date

-

requestStatus
default

enum

-

status
default

enum

-

updatedAt
default

date

-

createdAt
default

date

-

deliveredAt
default

date

-

displayStatus
default

enum

-

estimatedDeliveryAt
default

date

-

id
default

id

-

inTransitAt
default

date

-

name
default

string

-

requiresShipping
default

boolean

-

status
default

enum

-

totalQuantity
default

number

-

updatedAt
default

date

-

id
default

id

fulfillmentOrders

-

incoterm
default

string

-

id
default

id

-

inventoryItemId
default

string

-

productTitle
default

string

-

remainingQuantity
default

number

-

requiresShipping
default

boolean

-

sku
default

string

-

totalQuantity
default

number

-

variantTitle
default

string

-

vendor
default

string

-

message
default

string

-

movable
default

boolean

-

id
default

id

-

kind
default

enum

-

message
default

string

-

requestOptions
default

string

-

responseData
default

string

-

sentAt
default

date

-

billingAddressMatchesShippingAddress
default

boolean

-

cancelledAt
default

date

-

cancelReason
default

enum

-

canMarkAsPaid
default

boolean

-

canNotifyCustomer
default

boolean

-

capturable
default

boolean

-

cartDiscountAmount
default

string

-

clientIp
default

string

-

closed
default

boolean

-

closedAt
default

date

-

confirmationNumber
default

string

-

confirmed
default

boolean

-

createdAt
default

date

-

currencyCode
default

enum

-

currentSubtotalLineItemsQuantity
default

number

-

currentTotalWeight
default

string

-

customerAcceptsMarketing
default

boolean

-

customerLocale
default

string

-

discountCode
default

string

-

discountCodes
default

string[]

-

displayFinancialStatus
default

enum

-

displayFulfillmentStatus
default

enum

-

dutiesIncluded
default

boolean

-

edited
default

boolean

-

email
default

string

-

estimatedTaxes
default

boolean

-

fulfillable
default

boolean

-

fullyPaid
default

boolean

-

hasTimelineComment
default

boolean

-

id
default

id

orders

-

landingPageDisplayText
default

string

-

landingPageUrl
default

string

-

merchantEditable
default

boolean

-

merchantEditableErrors
default

string[]

-

name
default

string

-

netPayment
default

string

-

note
default

string

-

number
default

number

-

paymentGatewayNames
default

string[]

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

processedAt
default

date

-

productNetwork
default

boolean

-

referralCode
default

string

-

referrerDisplayText
default

string

-

referrerUrl
default

string

-

refundable
default

boolean

-

registeredSourceUrl
default

string

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

returnStatus
default

enum

-

riskLevel
default

enum

-

sourceIdentifier
default

string

-

sourceName
default

string

-

subtotalLineItemsQuantity
default

number

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

test
default

boolean

-

totalCapturable
default

string

-

totalDiscounts
default

string

-

totalPrice
default

string

-

totalReceived
default

string

-

totalRefunded
default

string

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

unpaid
default

boolean

-

updatedAt
default

date

-

orderId
default

id

orders

-

orderName
default

string

-

orderProcessedAt
default

date

-

requestStatus
default

enum

-

status
default

enum

-

action
default

enum

-

externalUrl
default

string

-

updatedAt
default

date

-

Manual Holds Fulfillment Order

Manual Holds Fulfillment Orders data in Shopify.

Read

List Manual Holds Fulfillment Orders

Fetch manual holds fulfillment orders from Shopify.

Route: GET /manualHoldsFulfillmentOrders

Excel formula: =LF.shopify.manualHoldsFulfillmentOrders("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
querystringNoThe query conditions used to filter fulfillment orders. Only fulfillment orders corresponding to orders matching the query will be counted....
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
Data returned in Excel
Field
Type
Relations
Description
address1
default

string

-

address2
default

string

-

city
default

string

-

countryCode
default

enum

-

name
default

string

-

phone
default

string

-

province
default

string

-

zip
default

string

-

channelId
default

id

-

createdAt
default

date

-

id
default

id

-

maxDeliveryDateTime
default

date

-

methodType
default

enum

-

minDeliveryDateTime
default

date

-

presentedName
default

string

-

serviceCode
default

string

-

sourceReference
default

string

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

countryCode
default

enum

-

email
default

string

-

firstName
default

string

-

id
default

id

-

lastName
default

string

-

phone
default

string

-

province
default

string

-

zip
default

string

-

fulfillAt
default

date

-

fulfillBy
default

date

-

displayReason
default

string

-

handle
default

string

-

heldByRequestingApp
default

boolean

-

id
default

id

-

reason
default

enum

-

reasonNotes
default

string

-

channelId
default

id

-

createdAt
default

date

-

fulfillAt
default

date

-

fulfillBy
default

date

-

id
default

id

fulfillmentOrders

-

orderId
default

id

orders

-

orderName
default

string

-

orderProcessedAt
default

date

-

requestStatus
default

enum

-

status
default

enum

-

updatedAt
default

date

-

createdAt
default

date

-

deliveredAt
default

date

-

displayStatus
default

enum

-

estimatedDeliveryAt
default

date

-

id
default

id

-

inTransitAt
default

date

-

name
default

string

-

requiresShipping
default

boolean

-

status
default

enum

-

totalQuantity
default

number

-

updatedAt
default

date

-

id
default

id

fulfillmentOrders

-

incoterm
default

string

-

id
default

id

-

inventoryItemId
default

string

-

productTitle
default

string

-

remainingQuantity
default

number

-

requiresShipping
default

boolean

-

sku
default

string

-

totalQuantity
default

number

-

variantTitle
default

string

-

vendor
default

string

-

message
default

string

-

movable
default

boolean

-

id
default

id

-

kind
default

enum

-

message
default

string

-

requestOptions
default

string

-

responseData
default

string

-

sentAt
default

date

-

billingAddressMatchesShippingAddress
default

boolean

-

cancelledAt
default

date

-

cancelReason
default

enum

-

canMarkAsPaid
default

boolean

-

canNotifyCustomer
default

boolean

-

capturable
default

boolean

-

cartDiscountAmount
default

string

-

clientIp
default

string

-

closed
default

boolean

-

closedAt
default

date

-

confirmationNumber
default

string

-

confirmed
default

boolean

-

createdAt
default

date

-

currencyCode
default

enum

-

currentSubtotalLineItemsQuantity
default

number

-

currentTotalWeight
default

string

-

customerAcceptsMarketing
default

boolean

-

customerLocale
default

string

-

discountCode
default

string

-

discountCodes
default

string[]

-

displayFinancialStatus
default

enum

-

displayFulfillmentStatus
default

enum

-

dutiesIncluded
default

boolean

-

edited
default

boolean

-

email
default

string

-

estimatedTaxes
default

boolean

-

fulfillable
default

boolean

-

fullyPaid
default

boolean

-

hasTimelineComment
default

boolean

-

id
default

id

orders

-

landingPageDisplayText
default

string

-

landingPageUrl
default

string

-

merchantEditable
default

boolean

-

merchantEditableErrors
default

string[]

-

name
default

string

-

netPayment
default

string

-

note
default

string

-

number
default

number

-

paymentGatewayNames
default

string[]

-

phone
default

string

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

processedAt
default

date

-

productNetwork
default

boolean

-

referralCode
default

string

-

referrerDisplayText
default

string

-

referrerUrl
default

string

-

refundable
default

boolean

-

registeredSourceUrl
default

string

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

returnStatus
default

enum

-

riskLevel
default

enum

-

sourceIdentifier
default

string

-

sourceName
default

string

-

subtotalLineItemsQuantity
default

number

-

subtotalPrice
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

test
default

boolean

-

totalCapturable
default

string

-

totalDiscounts
default

string

-

totalPrice
default

string

-

totalReceived
default

string

-

totalRefunded
default

string

-

totalShippingPrice
default

string

-

totalTax
default

string

-

totalWeight
default

string

-

unpaid
default

boolean

-

updatedAt
default

date

-

orderId
default

id

orders

-

orderName
default

string

-

orderProcessedAt
default

date

-

requestStatus
default

enum

-

status
default

enum

-

action
default

enum

-

externalUrl
default

string

-

updatedAt
default

date

-

Order

Orders in Shopify checkout flow.

Read

List Orders

Fetch orders from Shopify.

Route: GET /orders

Excel formula: =LF.shopify.orders("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
firstnumberNoThe first n elements from the paginated list. Default: 250
afterstringNoThe elements that come after the specified cursor.
lastnumberNoThe last n elements from the paginated list.
beforestringNoThe elements that come before the specified cursor.
reversebooleanNoReverse the order of the underlying list. Default: false
sortKeyenumNoSort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used... Values: CREATED_AT, CURRENT_TOTAL_PRICE, CUSTOMER_NAME, DESTINATION, FINANCIAL_STATUS
query.cart_tokenstringNoFilter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart t...
query.channelstringNoFilter by the channel information [handle](https://shopify.dev/api/admin-graphql/latest/objects/ChannelInformation#field-ChannelInformatio...
query.channel_ididNoFilter by the channel id field. Example: - channe...
query.chargeback_statusenumNoFilter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial insti... Values: accepted, charge_refunded, lost, needs_response, under_review
query.checkout_tokenstringNoFilter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references t...
query.confirmation_numberstringNoFilter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order...
query.created_atdateNoFilter by the date and time when the order was created in Shopify's system. Example: - created_at:2020-10-21T23:39:20Z - created_at:...
query.credit_card_last4stringNoFilter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the...
query.current_total_pricenumberNoFilter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact...
query.customer_ididNoFilter orders by the customer id field. Example:...
query.defaultstringNoFilter by a case-insensitive search of multiple fields in a document. Example: - query=Bob Norman - query=title:green hoodie
query.delivery_methodenumNoFilter by the delivery [methodType](https://shopify.dev/api/admin-graphql/2024-07/objects/DeliveryMethod#field-DeliveryMethod.fields.metho... Values: shipping, pick-up, retail, local, pickup-point
query.discount_codestringNoFilter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order....
query.emailstringNoFilter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. Example: - email:e...
query.financial_statusenumNoFilter by the order [displayFinancialStatus](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFinancia... Values: paid, pending, authorized, partially_paid, partially_refunded
query.fraud_protection_levelenumNoFilter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. Example: - fraud_pr... Values: fully_protected, partially_protected, not_protected, pending, not_eligible
query.fulfillment_location_ididNoFilter by the fulfillment location [id](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment#field-Fulfillment.fields.location...
query.fulfillment_statusenumNoFilter by the [displayFulfillmentStatus](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFulfill... Values: unshipped, shipped, fulfilled, partial, scheduled
query.gatewaystringNoFilter by the [paymentGatewayNames](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.paymentGatewayNames...
query.ididNoFilter by id range. Example: - id:1234 - id:>=1234 - id:<=1234
query.location_ididNoFilter by the location id that's associated...
query.metafields.{namespace}.{key}stringNoFilters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about [querying by metafield value](https:/...
query.namestringNoFilter by the order name field. Example: - name:1001-A
query.payment_idstringNoFilter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. Example: - payment...
query.payment_provider_ididNoFilter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. Example: -...
query.po_numberstringNoFilter by the order poNumber field. Example: - ...
query.processed_atdateNoFilter by the order processedAt field. Exampl...
query.reference_location_ididNoFilter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary locatio...
query.return_statusenumNoFilter by the order's returnStatus to monito... Values: return_requested, in_progress, inspection_complete, returned, return_failed
query.risk_levelenumNoFilter by the order risk assessment [riskLevel](https://shopify.dev/api/admin-graphql/latest/objects/OrderRiskAssessment#field-OrderRiskAs... Values: high, medium, low, none, pending
query.sales_channelstringNoFilter by the sales channel where the order was made to analyze performance or manage...
query.skustringNoFilter by the product variant sku f...
query.source_identifierstringNoFilter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't corresp...
query.source_namestringNoFilter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use t...
query.statusenumNoFilter by the order's status to manage workflows or analyze the order lifecycle. Example: - status:open Values: open, closed, cancelled, not_closed
query.subtotal_line_items_quantitystringNoFilter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for...
query.tagstringNoFilter objects by the tag field. Example: - tag:my_tag
query.tag_notstringNoFilter by objects that don’t have the specified tag. Example: - tag_not:my_tag
query.testbooleanNoFilter by test orders. Test orders are made using the [Shopify Bogus Gateway](https://help.shopify.com/manual/checkout-settings/test-orders/...
query.total_weightstringNoFilter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all...
query.updated_atdateNoFilter by the date and time when the order was last updated in Shopify's system. Example: - updated_at:2020-10-21T23:39:20Z - update...
savedSearchIdstringNoThe ID of a saved search. The search’s query string is used as...
Data returned in Excel
Field
Type
Relations
Description
id
default

id

-

name
default

string

-

happenedAt
default

date

-

id
default

id

-

reason
default

enum

-

content
default

string

-

dismissibleHandle
default

string

-

icon
default

enum

-

severity
default

enum

-

title
default

string

-

id
default

id

-

name
default

string

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

coordinatesValidated
default

boolean

-

country
default

string

-

countryCode
default

string

-

countryCodeV2
default

enum

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

latitude
default

number

-

longitude
default

number

-

name
default

string

-

phone
default

string

-

province
default

string

-

provinceCode
default

string

-

timeZone
default

string

-

validationResultSummary
default

enum

-

zip
default

string

-

billingAddressMatchesShippingAddress
default

boolean

-

staffNote
default

string

-

cancelledAt
default

date

-

cancelReason
default

enum

-

canMarkAsPaid
default

boolean

-

canNotifyCustomer
default

boolean

-

capturable
default

boolean

-

cartDiscountAmount
default

string

-

handle
default

string

-

id
default

id

-

name
default

string

-

overviewPath
default

string

-

supportsFuturePublishing
default

boolean

-

channelId
default

id

-

displayName
default

string

-

id
default

id

-

clientIp
default

string

-

closed
default

boolean

-

closedAt
default

date

-

confirmationNumber
default

string

-

confirmed
default

boolean

-

createdAt
default

date

-

currencyCode
default

enum

-

currentSubtotalLineItemsQuantity
default

number

-

channelLiable
default

boolean

-

price
default

string

-

rate
default

number

-

ratePercentage
default

number

-

source
default

string

-

title
default

string

-

currentTotalWeight
default

string

-

key
default

string

-

value
default

string

-

canDelete
default

boolean

-

createdAt
default

date

-

dataSaleOptOut
default

boolean

-

displayName
default

string

-

email
default

string

-

firstName
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

-

lastName
default

string

-

lifetimeDuration
default

string

-

locale
default

string

-

multipassIdentifier
default

string

-

note
default

string

-

numberOfOrders
default

string

-

phone
default

string

-

productSubscriberStatus
default

enum

-

state
default

enum

-

tags
default

string[]

-

taxExempt
default

boolean

-

taxExemptions
default

string

-

unsubscribeUrl
default

string

-

updatedAt
default

date

-

validEmailAddress
default

boolean

-

verifiedEmail
default

boolean

-

customerAcceptsMarketing
default

boolean

-

customerOrderIndex
default

number

-

daysToConversion
default

number

-

customerOrderIndex
default

number

-

daysToConversion
default

number

-

ready
default

boolean

-

customerLocale
default

string

-

allocationMethod
default

enum

-

index
default

number

-

targetSelection
default

enum

-

targetType
default

enum

-

title
default

string

-

discountCode
default

string

-

discountCodes
default

string[]

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

coordinatesValidated
default

boolean

-

country
default

string

-

countryCode
default

string

-

countryCodeV2
default

enum

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

latitude
default

number

-

longitude
default

number

-

name
default

string

-

phone
default

string

-

province
default

string

-

provinceCode
default

string

-

timeZone
default

string

-

validationResultSummary
default

enum

-

zip
default

string

-

displayFinancialStatus
default

enum

-

displayFulfillmentStatus
default

enum

-

id
default

id

-

initiatedAs
default

enum

-

status
default

enum

-

dutiesIncluded
default

boolean

-

edited
default

boolean

-

email
default

string

-

estimatedTaxes
default

boolean

-

action
default

string

-

additionalContent
default

string

-

additionalData
default

string

-

appTitle
default

string

-

arguments
default

string

-

attributeToApp
default

boolean

-

attributeToUser
default

boolean

-

author
default

string

-

createdAt
default

date

-

criticalAlert
default

boolean

-

hasAdditionalContent
default

boolean

-

id
default

id

-

message
default

string

-

secondaryMessage
default

string

-

subjectId
default

string

-

subjectType
default

enum

-

completedAt
default

date

-

createdAt
default

date

-

id
default

id

-

mirrored
default

boolean

-

note
default

string

-

fulfillable
default

boolean

-

channelId
default

id

-

createdAt
default

date

-

fulfillAt
default

date

-

fulfillBy
default

date

-

id
default

id

fulfillmentOrders

-

orderId
default

id

orders

-

orderName
default

string

-

orderProcessedAt
default

date

-

requestStatus
default

enum

-

status
default

enum

-

updatedAt
default

date

-

createdAt
default

date

-

deliveredAt
default

date

-

displayStatus
default

enum

-

estimatedDeliveryAt
default

date

-

id
default

id

-

inTransitAt
default

date

-

name
default

string

-

requiresShipping
default

boolean

-

status
default

enum

-

totalQuantity
default

number

-

updatedAt
default

date

-

count
default

number

-

precision
default

enum

-

fullyPaid
default

boolean

-

hasTimelineComment
default

boolean

-

id
default

id

orders

-

landingPageDisplayText
default

string

-

landingPageUrl
default

string

-

canRestock
default

boolean

-

currentQuantity
default

number

-

discountedTotal
default

string

-

discountedUnitPrice
default

string

-

fulfillableQuantity
default

number

-

fulfillmentStatus
default

string

-

id
default

id

-

isGiftCard
default

boolean

-

merchantEditable
default

boolean

-

name
default

string

-

nonFulfillableQuantity
default

number

-

originalTotal
default

string

-

originalUnitPrice
default

string

-

quantity
default

number

-

refundableQuantity
default

number

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

sku
default

string

-

taxable
default

boolean

-

title
default

string

-

totalDiscount
default

string

-

unfulfilledDiscountedTotal
default

string

-

unfulfilledOriginalTotal
default

string

-

unfulfilledQuantity
default

number

-

variantTitle
default

string

-

vendor
default

string

-

countryCode
default

enum

-

key
default

enum

-

purpose
default

enum

-

title
default

string

-

value
default

string

-

countryCode
default

enum

-

key
default

enum

-

purpose
default

enum

-

title
default

string

-

value
default

string

-

archived
default

boolean

-

companyName
default

string

-

displayName
default

string

-

id
default

id

-

primary
default

boolean

-

merchantEditable
default

boolean

-

merchantEditableErrors
default

string[]

-

id
default

id

-

name
default

string

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

description
default

string

-

id
default

id

-

key
default

string

-

name
default

string

-

namespace
default

string

-

ownerType
default

enum

-

pinnedPosition
default

number

-

useAsCollectionCondition
default

boolean

-

validationStatus
default

enum

-

compareDigest
default

string

-

createdAt
default

date

-

description
default

string

-

id
default

id

-

jsonValue
default

string

-

key
default

string

-

namespace
default

string

-

ownerType
default

enum

-

type
default

string

-

updatedAt
default

date

-

value
default

string

-

name
default

string

-

netPayment
default

string

-

canRestock
default

boolean

-

currentQuantity
default

number

-

discountedTotal
default

string

-

discountedUnitPrice
default

string

-

fulfillableQuantity
default

number

-

fulfillmentStatus
default

string

-

id
default

id

-

isGiftCard
default

boolean

-

merchantEditable
default

boolean

-

name
default

string

-

nonFulfillableQuantity
default

number

-

originalTotal
default

string

-

originalUnitPrice
default

string

-

quantity
default

number

-

refundableQuantity
default

number

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

sku
default

string

-

taxable
default

boolean

-

title
default

string

-

totalDiscount
default

string

-

unfulfilledDiscountedTotal
default

string

-

unfulfilledOriginalTotal
default

string

-

unfulfilledQuantity
default

number

-

variantTitle
default

string

-

vendor
default

string

-

note
default

string

-

number
default

number

-

additionalPaymentCollectionUrl
default

string

-

paymentGatewayNames
default

string[]

-

due
default

boolean

-

dueInDays
default

number

-

id
default

id

-

overdue
default

boolean

-

paymentTermsName
default

string

-

paymentTermsType
default

enum

-

translatedName
default

string

-

phone
default

string

-

activatable
default

boolean

-

addressVerified
default

boolean

-

createdAt
default

date

-

deactivatable
default

boolean

-

deactivatedAt
default

string

-

deletable
default

boolean

-

fulfillsOnlineOrders
default

boolean

-

hasActiveInventory
default

boolean

-

hasUnfulfilledOrders
default

boolean

-

id
default

id

-

isActive
default

boolean

-

isFulfillmentService
default

boolean

-

isPrimary
default

boolean

-

name
default

string

-

shipsInventory
default

boolean

-

updatedAt
default

date

-

poNumber
default

string

-

presentmentCurrencyCode
default

enum

-

processedAt
default

date

-

productNetwork
default

boolean

-

autoPublish
default

boolean

-

id
default

id

-

name
default

string

-

supportsFuturePublishing
default

boolean

-

canDelete
default

boolean

-

createdAt
default

date

-

dataSaleOptOut
default

boolean

-

displayName
default

string

-

email
default

string

-

firstName
default

string

-

hasTimelineComment
default

boolean

-

id
default

id

-

lastName
default

string

-

lifetimeDuration
default

string

-

locale
default

string

-

multipassIdentifier
default

string

-

note
default

string

-

numberOfOrders
default

string

-

phone
default

string

-

productSubscriberStatus
default

enum

-

state
default

enum

-

tags
default

string[]

-

taxExempt
default

boolean

-

taxExemptions
default

string

-

unsubscribeUrl
default

string

-

updatedAt
default

date

-

validEmailAddress
default

boolean

-

verifiedEmail
default

boolean

-

referralCode
default

string

-

referrerDisplayText
default

string

-

referrerUrl
default

string

-

refundable
default

boolean

-

createdAt
default

date

-

id
default

id

-

note
default

string

-

processedAt
default

date

-

updatedAt
default

date

-

registeredSourceUrl
default

string

-

requiresShipping
default

boolean

-

restockable
default

boolean

-

activatable
default

boolean

-

addressVerified
default

boolean

-

createdAt
default

date

-

deactivatable
default

boolean

-

deactivatedAt
default

string

-

deletable
default

boolean

-

fulfillsOnlineOrders
default

boolean

-

hasActiveInventory
default

boolean

-

hasUnfulfilledOrders
default

boolean

-

id
default

id

-

isActive
default

boolean

-

isFulfillmentService
default

boolean

-

isPrimary
default

boolean

-

name
default

string

-

shipsInventory
default

boolean

-

updatedAt
default

date

-

closedAt
default

date

-

createdAt
default

date

-

id
default

id

-

name
default

string

-

requestApprovedAt
default

date

-

status
default

enum

-

totalQuantity
default

number

-

returnStatus
default

enum

-

recommendation
default

enum

-

riskLevel
default

enum

-

display
default

boolean

-

level
default

enum

-

message
default

string

-

address1
default

string

-

address2
default

string

-

city
default

string

-

company
default

string

-

coordinatesValidated
default

boolean

-

country
default

string

-

countryCode
default

string

-

countryCodeV2
default

enum

-

firstName
default

string

-

formattedArea
default

string

-

id
default

id

-

lastName
default

string

-

latitude
default

number

-

longitude
default

number

-

name
default

string

-

phone
default

string

-

province
default

string

-

provinceCode
default

string

-

timeZone
default

string

-

validationResultSummary
default

enum

-

zip
default

string

-

carrierIdentifier
default

string

-

code
default

string

-

custom
default

boolean

-

deliveryCategory
default

string

-

id
default

id

-

isRemoved
default

boolean

-

phone
default

string

-

price
default

string

-

shippingRateHandle
default

string

-

source
default

string

-

title
default

string

-

carrierIdentifier
default

string

-

code
default

string

-

custom
default

boolean

-

deliveryCategory
default

string

-

id
default

id

-

isRemoved
default

boolean

-

phone
default

string

-

price
default

string

-

shippingRateHandle
default

string

-

source
default

string

-

title
default

string

-

status
default

enum

-

sourceIdentifier
default

string

-

sourceName
default

string

-

accountType
default

enum

-

active
default

boolean

-

email
default

string

-

exists
default

boolean

-

firstName
default

string

-

id
default

id

-

initials
default

string[]

-

isShopOwner
default

boolean

-

lastName
default

string

-

locale
default

string

-

name
default

string

-

phone
default

string

-

subtotalLineItemsQuantity
default

number

-

subtotalPrice
default

string

-

amount
default

string

-

maximumRefundable
default

string

-

subtotal
default

string

-

totalTaxes
default

string

-

tags
default

string[]

-

taxesIncluded
default

boolean

-

taxExempt
default

boolean

-

channelLiable
default

boolean

-

price
default

string

-

rate
default

number

-

ratePercentage
default

number

-

source
default

string

-

title
default

string

-

test
default

boolean

-

totalCapturable
default

string

-

totalDiscounts
default

string

-

totalPrice
default

string

-

totalReceived
default

string

-

totalRefunded
default

string

-

totalShippingPrice
default

string

-

totalTax
default

string

-

amount
default

number

-

currencyCode
default

enum

-

totalWeight
default

string

-

accountNumber
default

string

-

amount
default

string

-

authorizationCode
default

string

-

authorizationExpiresAt
default

date

-

createdAt
default

date

-

errorCode
default

enum

-

formattedGateway
default

string

-

gateway
default

string

-

id
default

id

-

kind
default

enum

-

manuallyCapturable
default

boolean

-

manualPaymentGateway
default

boolean

-

maximumRefundable
default

string

-

multiCapturable
default

boolean

-

paymentId
default

string

-

paymentMethod
default

enum

-

processedAt
default

date

-

receiptJson
default

string

-

settlementCurrency
default

enum

-

settlementCurrencyRate
default

number

-

status
default

enum

-

test
default

boolean

-

totalUnsettled
default

string

-

count
default

number

-

precision
default

enum

-

unpaid
default

boolean

-

updatedAt
default

date

-

Edit

Update Order

Update an existing order in Shopify.

Route: PATCH /orders/{id}

Inputs you can set
NameTypeRequiredDescription
input.customAttributes.keystringYes-
input.customAttributes.valuestringYes-
input.emailstringNo-
input.idstringYes-
input.localizedFields.keyenumYesValues: TAX_CREDENTIAL_BR, SHIPPING_CREDENTIAL_BR, TAX_CREDENTIAL_CL, SHIPPING_CREDENTIAL_CL, SHIPPING_CREDENTIAL_CN
input.localizedFields.valuestringYes-
input.metafields.idstringNo-
input.metafields.keystringNo-
input.metafields.namespacestringNo-
input.metafields.typestringNo-
input.metafields.valuestringNo-
input.notestringNo-
input.phonestringNo-
input.poNumberstringNo-
input.shippingAddress.address1stringNo-
input.shippingAddress.address2stringNo-
input.shippingAddress.citystringNo-
input.shippingAddress.companystringNo-
input.shippingAddress.countryCodeenumNoValues: AF, AX, AL, DZ, AD
input.shippingAddress.firstNamestringNo-
input.shippingAddress.lastNamestringNo-
input.shippingAddress.phonestringNo-
input.shippingAddress.provinceCodestringNo-
input.shippingAddress.zipstringNo-
input.tagsstring[]No-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Order

Delete an existing order in Shopify.

Route: DELETE /orders/{id}

Inputs you can set
NameTypeRequiredDescription
orderIdstringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.